Consulta por authenticationCode
stable
O endpoint de consulta de dados por authenticationCode retorna o status do boleto e outras informações para que o boleto possa ser gerado pelo parceiro, de forma personalizada.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O boleto tenha sido emitido com sucesso.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/bankslip/branch/{{branch}}/number/{{number}}/{{authenticationCode}}
--request GET
--url 'https://api-mtls.sandbox.bankly.com.br/bankslip/branch/{{branch}}/number/{{number}}/{{authenticationCode}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-version: 2.0' \
--header 'Authorization: Bearer {{accessToken}}
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
boleto.read | Concede acesso para consultar boletos. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API, que, neste caso, é 2.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
branch | path | Número da agência ao qual a conta do beneficiário final do boleto pertence. |
number | path | Número da conta do beneficiário final do boleto. |
authenticationCode | path | Identificador único do boleto, retornado na API de emissão de boletos. |
Corpo da requisição (Body)
Não é necessário enviar parâmetros no body desta requisição.
Resposta (Response)
O status code 200 indicará que a solicitação foi aceita com sucesso e trará um objeto contendo as informações do boleto.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
authenticationCode | string | Identificador único do boleto. |
barcode | string | Número do código de barras do boleto. |
updatedAt | string | Data de atualização do status do boleto, no formato ISO 8601 - UTC. |
ourNumber | string | Número que relaciona o boleto ao seu emissor. |
digitable | string | Linha digitável para pagamento do boleto. |
status | string | Situação do boleto no momento da consulta. |
account | object | Objeto que contém informações sobre a conta do beneficiário final do boleto. |
account.branch | string | Número da agência do banco ao qual a conta pertence. |
account.number | string | Número da conta do beneficiário final. |
document | string | Identificador único que relaciona o boleto bancário com o beneficiário final. |
amount | object | Objeto que contém informações sobre o valor do boleto. |
amount.value | number | Valor do boleto. |
amount.currency | string | Código da moeda com base na ISO-4217. |
minimumAmount | number | Valor mínimo do pagamento do boleto (específico para boletos de cartão de crédito). |
dueDate | string | Data de vencimento do boleto, no formato ISO 8601 - UTC. |
closePayment | string | Data limite de pagamento após a data de vencimento. |
emissionDate | string | Data de emissão do boleto, no formato ISO 8601 - UTC. |
type | string | Tipo do boleto, o qual pode ser "Deposit" (Depósito) e "Levy" (Cobrança). |
payer | object | Objeto que contém informações sobre o pagador do boleto. Este objeto somente será retornado caso o boleto seja de cobrança (Levy). |
payer.document | string | Número do documento (CPF ou CNPJ) do pagador. |
payer.tradeName | string | Nome fantasia do pagador. |
payer.name | string | Nome do pagador. |
payer.address | object | Objeto que contém informações sobre o endereço do pagador. |
payer.address.addressLine | string | Endereço do pagador. |
payer.adress.neighborhood | string | Nome do bairro. |
payer.address.city | string | Nome da cidade. |
payer.address.state | string | Nome do estado. |
payer.address.zipCode | string | Código postal do endereço. |
recipientFinal | object | Objeto que contém informações sobre o beneficiário final do boleto. |
recipientFinal.document | string | Número do documento (CPF ou CNPJ) do beneficiário final. |
recipientFinal.tradeName | string | Nome fantasia do beneficiário final. |
recipientFinal.name | string | Nome do beneficiário final. |
recipientFinal.address | object | Objeto que contém informações sobre o endereço do beneficiário final. |
recipientFinal.address.addressLine | string | Endereço do beneficiário final. |
recipientFinal.address.city | string | Nome da cidade. |
recipientFinal.address.state | string | Nome do estado. |
recipientFinal.address.zipCode | string | Código postal do endereço. |
payments[] | array of strings | Lista de objetos contendo informações sobre os pagamentos realizados referentes ao boleto. |
payments[].id | string | Identificador único do pagamento. |
payments[].amount | number | Valor pago. |
payments[].paymentChannel | string | Nome do canal de pagamento (Agency, SelfServiceTerminal, InternetBanking, CorrespondentBanking, CallCenter, EletronicFile, DDA, PIX, DCC, DigitalCorrespondentBanking). |
payments[].paidOutDate | string | Data de pagamento, no formato ISO 8601 - UTC. |
interest | object | Objeto que contém informações sobre o juros aplicado no boleto de cobrança (Levy). |
interest.startDate | string | Data de início para cálculo dos juros, no formato ISO 8601 - UTC. |
interest.value | number | Valor monetário ou percentual dos juros, dependendo da configuração do campo interest.type. |
interest.type | string | Regra para cálculo dos juros. Confira a tabela com as regras referentes a juros, multas e descontos. |
fine | object | Objeto que contém informações sobre a multa aplicada no boleto de cobrança (Levy). |
fine.startDate | string | Data de início para cálculo da multa, no formato ISO 8601 - UTC. |
fine.value | number | Valor monetário ou percentual da multa, dependendo da configuração do campo fine.type. |
fine.type | string | Tipo da regra aplicada a multa. |
discount | object | Objeto que contém informações sobre os descontos aplicados no boleto de cobrança (Levy). |
discount.limitDate | string | Data limite, no formato ISO 8601 - UTC, para incidência de desconto (considera-se desde a data de emissão até um dia antes do vencimento). |
discount.value | number | Valor monetário ou percentual do desconto, dependendo da configuração do campo discount.type. |
discount.type | string | Tipo da regra para cálculo do desconto. |
Nota
Os campos
barcode,digitable,ournumberedocumentsomente retornam quando o boleto apresentar o status "Registered".
{
"authenticationCode": "6556165e-51fb-459b-a31c-1e996165280b",
"barcode": "65597940700000001000001115801398869900725986",
"updatedAt": "2022-02-14T17:49:28.518+00:00",
"ourNumber": "44696851879",
"digitable": "65590001151446968518579001874704188970000002000",
"status": "Registered",
"account": {
"branch": "0001",
"number": "15164"
},
"document": "000007559913591",
"amount": {
"value": 100.00,
"currency": "BRL"
},
"minimumAmount": 0,
"dueDate": "2022-02-15T03:00:00+00:00",
"closePayment": "2023-07-10T03:00:00+00:00",
"emissionDate": "2022-02-14T17:49:28.802+00:00",
"type": "Levy",
"payer": {
"document": "47742663023",
"name": "Nísia Floresta",
"tradeName": "",
"address": {
"addressLine": "Rua 6 de Março",
"city": "Santarém",
"state": "PA",
"zipCode": "68060100"
}
},
"recipientFinal": {
"document": "09992220074",
"name": "Maria Quitéria de Jesus",
"tradeName": "",
"address": {
"addressLine": "Rua 6 de Março",
"city": "Santarém",
"state": "PA",
"zipCode": "68060100"
}
},
"payments": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": 0,
"paymentChannel": "Agency",
"paidOutDate": "2023-05-17T19:45:59.465Z"
}
],
"interest": {
"startDate": "0001-01-02T23:59:59-03:06",
"value": 0,
"type": "Percent"
},
"fine": {
"startDate": "0001-01-02T23:59:59-03:06",
"value": 0,
"type": "Percent"
},
"discount": {
"limitDate": "0001-01-02T23:59:59-03:06",
"value": 0,
"type": "Percent"
}
}
{
"authenticationCode": "6556165e-51fb-459b-a31c-1e996165280b",
"barcode": "65597940700000001000001115801398869900725986",
"updatedAt": "2022-02-14T17:49:28.518+00:00",
"ourNumber": "44696851879",
"digitable": "65590001151446968518579001874704188970000002000",
"status": "Registered",
"branch": "0001",
"number": "15164",
"documentNumber": "47742663023",
"amount": 100,
"minimumAmount": 0,
"dueDate": "2022-02-15T03:00:00+00:00",
"closePayment": "2023-07-10T03:00:00+00:00",
"emissionDate": "2022-02-14T17:49:28.802+00:00",
"type": "Deposit",
"recipientFinal": {
"document": "09992220074",
"name": "Maria Quitéria de Jesus",
"tradeName": "",
"address": {
"addressLine": "Rua 6 de Março",
"city": "Santarém",
"state": "PA",
"zipCode": "68060100"
}
},
"payments": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": 0,
"paymentChannel": "Agency",
"paidOutDate": "2023-05-17T19:45:59.465Z",
"createAt": "2024-02-08T21:25:25.374Z",
"updatedAt": "2024-02-08T21:25:25.374Z"
}
]
}
Status do boleto
| Status | Descrição |
|---|---|
| Processed | A solicitação do boleto foi aceita e está sendo processada. |
| Registered | O boleto foi registrado na Nuclea/CIP. |
| Conciliated | O boleto foi conciliado, mas o valor ainda não está disponível na conta do emissor. |
| Settled | O boleto foi liquidado/baixado. |
| Cancelled | O boleto foi cancelado pelo beneficiário final ou por decurso do prazo. |
Regras de juros, multas e descontos novo
| Juros (Interest) | Multa (Fine) | Desconto (Discount) |
|---|---|---|
| FixedAmount: valor monetário por dia corrido (sem distinção de fins de semana e feriados). Esse campo aceita valores com até duas casas decimais. | FixedAmount: valor monetário fixo. | FixedAmountUntilLimitDate: valor fixo até a data limite |
| Percent: valor percentual por dia corrido (sem distinção de fins de semana e feriados). | Percent: percentual sobre o valor do título. | FixedPercentUntilLimitDate: percentual fixo até a data limite. |
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago