⌘K

Detalhes do Pagamento

Consulte o status e os detalhes completos de um pagamento de boleto pelo identificador do pagamento.

Os dois endpoints abaixo retornam a mesma estrutura de resposta. Se o pagamento não for encontrado, a API retorna 404.

Consultar Pagamento

GET/api/v2/billets/{id}

Consulta um pagamento de boleto pelo identificador. Requer o escopo billets.read.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (escopo billets.read)

Parametros de Rota

Nome	Tipo	Descricao
`id`	integer	Identificador do pagamento, retornado na criação do pagamento.

Exemplo de Response

{
  "data": {
    "id": 776543210,
    "idempotencyKey": "billet-req-id-001",
    "createdAt": "2026-06-12T16: 45:00Z",
    "status": "LIQUIDATED",
    "transactionType": "BILLET",
    "creditDebitType": "DEBIT",
    "payment": {
      "currency": "BRL",
      "amount": 150.75
    },
    "billetInfo": {
      "digitableCode": "00190000090267490000732810452179696530000015075",
      "barCode": "00190.00009 02674.900007 32810.452179 6 96530000015075",
      "settleDate": "2026-06-12T16: 45:22Z",
      "dueDate": "2026-06-15T00: 00:00Z"
    },
    "creditorAccount": {
      "ispb": "00416968",
      "issuer": "0001",
      "number": "12345678-9",
      "accountType": "CACC",
      "document": "12345678000190",
      "name": "Empresa Fornecedora LTDA"
    },
    "debtorAccount": {
      "ispb": "00000000",
      "issuer": "0001",
      "number": "98765432-1",
      "accountType": "CACC",
      "document": "98765432100",
      "name": "Cliente Exemplo"
    }
  }
}

Exemplos de Codigo

curl -X GET https://pagamentos.basspago.com.br/api/v2/billets/776543210 \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Consultar Detalhes do Pagamento

GET/api/v2/billets/{id}/details

Consulta os detalhes de um pagamento de boleto pelo identificador. Retorna a mesma estrutura do endpoint anterior. Requer o escopo billets.read.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (escopo billets.read)

Parametros de Rota

Nome	Tipo	Descricao
`id`	integer	Identificador do pagamento, retornado na criação do pagamento.

Exemplo de Response

{
  "data": {
    "id": 776543210,
    "idempotencyKey": "billet-req-id-001",
    "createdAt": "2026-06-12T16: 45:00Z",
    "status": "LIQUIDATED",
    "transactionType": "BILLET",
    "creditDebitType": "DEBIT",
    "payment": {
      "currency": "BRL",
      "amount": 150.75
    },
    "billetInfo": {
      "digitableCode": "00190000090267490000732810452179696530000015075",
      "barCode": "00190.00009 02674.900007 32810.452179 6 96530000015075",
      "settleDate": "2026-06-12T16: 45:22Z",
      "dueDate": "2026-06-15T00: 00:00Z"
    },
    "creditorAccount": {
      "ispb": "00416968",
      "issuer": "0001",
      "number": "12345678-9",
      "accountType": "CACC",
      "document": "12345678000190",
      "name": "Empresa Fornecedora LTDA"
    },
    "debtorAccount": {
      "ispb": "00000000",
      "issuer": "0001",
      "number": "98765432-1",
      "accountType": "CACC",
      "document": "98765432100",
      "name": "Cliente Exemplo"
    }
  }
}

Exemplos de Codigo

curl -X GET https://pagamentos.basspago.com.br/api/v2/billets/776543210/details \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Tipos de Conta (accountType)

O campo accountType, presente em creditorAccount e debtorAccount, aceita os seguintes valores:

Valor	Descrição
`CACC`	Conta Corrente
`SVGS`	Conta Poupança
`SLRY`	Conta Salário
`TRAN`	Conta Pré-Paga (Pagamento)