⌘K

Consultar Boleto

Consulte os dados de um boleto pela linha digitável ou código de barras antes de realizar o pagamento.

Consulte o boleto antes de pagar para obter o valor atualizado (campo totalUpdated), que já inclui juros, multas e descontos. Em seguida, realize o pagamento via POST /billets/pay.

POST/api/v2/billets/info

Consulta os dados de um boleto a partir da linha digitável ou do código de barras. Requer o escopo billets.read.

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

Headers

Header	Valor	Descricao
`Content-Type`	application/json	Tipo do conteúdo da requisição
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (escopo billets.read)

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`billetCode`	string	Obrigatorio	Linha digitável ou código de barras do boleto, apenas números, com até 50 caracteres.

Exemplo de Request

{
  "billetCode": "00190000090267490000732810452179696530000015075"
}

Exemplo de Response

{
  "paymentId": 0,
  "payDueDate": "2026-06-19T12: 00:00Z",
  "dueDateRegister": "2026-06-19T12: 00:00Z",
  "digitableCode": "00190000090267490000732810452179696530000015075",
  "maxValue": 0,
  "minValue": 0,
  "originalValue": 150.75,
  "discountValue": 0,
  "interestValueCalculated": 0,
  "totalUpdated": 150.75,
  "recipient": "Empresa Fornecedora LTDA",
  "documentRecipient": "12345678000190",
  "allowChangeValue": false
}

Exemplos de Codigo

curl -X POST https://pagamentos.basspago.com.br/api/v2/billets/info \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "billetCode": "00190000090267490000732810452179696530000015075"
  }'

Campos do Response

Campo	Tipo	Descrição
`paymentId`	integer	Identificador do pagamento associado ao boleto, quando já existir um pagamento iniciado. Retorna 0 quando não há pagamento.
`payDueDate`	string (date-time)	Data limite para pagamento do boleto.
`dueDateRegister`	string (date-time)	Data de vencimento registrada do boleto.
`digitableCode`	string	Linha digitável do boleto.
`maxValue`	number	Valor máximo aceito para pagamento, quando o boleto permite alteração de valor.
`minValue`	number	Valor mínimo aceito para pagamento, quando o boleto permite alteração de valor.
`originalValue`	number	Valor original do boleto, sem juros, multas ou descontos.
`discountValue`	number	Valor de desconto aplicado ao boleto.
`interestValueCalculated`	number	Valor de juros e multa calculados até a data da consulta.
`totalUpdated`	number	Valor total atualizado do boleto (original + juros/multa − descontos). É este o valor considerado na liquidação.
`recipient`	string	Nome do beneficiário do boleto.
`documentRecipient`	string	CPF ou CNPJ do beneficiário do boleto.
`allowChangeValue`	boolean	Indica se o valor do boleto pode ser alterado livremente pelo pagador. Boletos com valor livre devem ser pagos por canal administrativo autorizado.