Consultar informações de um boleto.

POST

/billets/info

Boletos

Consulta um boleto pela linha digitável ou pelo código de barras, sem pagar.

Use para mostrar valor, vencimento e beneficiário antes de confirmar o pagamento.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

billets.read-Permite consultar boletos e informações para pagamento

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Sucesso

Bodyapplication/json

🟠400

🟠401

🟠403

🟠429

🔴500

🔴503

🔴504

Request Example

Shell

JavaScript

Java

Swift

curl --location '/billets/info' \
--header 'Content-Type: application/json' \
--data '{
    "billetCode": "string"
}'

Response Example

200 - Exemplo 1

{
    "paymentId": 0,
    "payDueDate": "2019-08-24T14:15:22.123Z",
    "dueDateRegister": "2019-08-24T14:15:22.123Z",
    "digitableCode": "string",
    "maxValue": 0,
    "minValue": 0,
    "originalValue": 0,
    "discountValue": 0,
    "interestValueCalculated": 0,
    "totalUpdated": 0,
    "recipient": "string",
    "documentRecipient": "string",
    "allowChangeValue": true
}

Página anterior

Iniciar pagamento de boleto pelo código do boleto.

Próxima página

Consultar detalhes do pagamento de boleto por ID.