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

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/bankslip/branch/{{branch}}/number/{{number}}/{{authenticationCode}}
--location --request GET '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:

ScopeDescrição
boleto.readConcede acesso para consultar boletos.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API, que, neste caso, é 2.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

NomeTipoDescrição
branchpathNúmero da agência ao qual a conta do beneficiário final do boleto pertence.
numberpathNúmero da conta do beneficiário final do boleto.
authenticationCodepathIdentificador ú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)

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:

NomeTipoDescrição
authenticationCodestringIdentificador único do boleto.
barcodestringNúmero do código de barras do boleto.
updatedAtstringData de atualização do status do boleto, no formato YYYY-MM-DDTHH:mm:SS.
ourNumberstringNúmero que relaciona o boleto ao seu emissor.
digitablestringLinha digitável para pagamento do boleto.
statusstringSituação do boleto no momento da consulta. Confira a tabela de possíveis status do boleto.
accountobjectObjeto que contém informações sobre a conta do beneficiário final do boleto.
account.branchstringNúmero da agência do banco ao qual a conta pertence.
account.numberstringNúmero da conta do beneficiário final.
documentstringIdentificador único que relaciona o boleto bancário com o beneficiário final.
amountobjectObjeto que contém informações sobre o valor do boleto.
amount.valuenumberValor do boleto.
amount.currencystringCódigo da moeda com base na ISO-4217.
minimumAmountnumberValor mínimo do pagamento do boleto (específico para boletos de cartão de crédito).
dueDatestringData de vencimento do boleto, no formato YYYY-MM-DDTHH:mm:SS.
closePaymentstringData limite de pagamento após a data de vencimento.
emissionDatestringData de emissão do boleto, no formato YYYY-MM-DDTHH:mm:SS.
typestringTipo do boleto, o qual pode ser "Deposit" (Depósito) e "Levy" (Cobrança).
payerobjectObjeto que contém informações sobre o pagador do boleto. Este objeto somente será retornado caso o boleto seja de cobrança (Levy).
payer.documentstringNúmero do documento (CPF ou CNPJ) do pagador.
payer.tradeNamestringNome fantasia do pagador.
payer.namestringNome do pagador.
payer.addressobjectObjeto que contém informações sobre o endereço do pagador.
payer.address.addressLinestringEndereço do pagador.
payer.adress.neighborhoodstringNome do bairro.
payer.address.citystringNome da cidade. Deve-se evitar acentos e outros caracteres especiais.
payer.address.statestringNome do estado Deve-se respeitar o formato proposto pela ISO 3166-2:BR. Exemplo: SP.
payer.address.zipCodestringCódigo postal do endereço.
recipientFinalobjectObjeto que contém informações sobre o beneficiário final do boleto.
recipientFinal.documentstringNúmero do documento (CPF ou CNPJ) do beneficiário final.
recipientFinal.tradeNamestringNome fantasia do beneficiário final.
recipientFinal.namestringNome do beneficiário final.
recipientFinal.addressobjectObjeto que contém informações sobre o endereço do beneficiário final.
recipientFinal.address.addressLinestringEndereço do beneficiário final.
recipientFinal.address.citystringNome da cidade.
recipientFinal.address.statestringNome do estado Deve-se respeitar o formato proposto pela ISO 3166-2:BR. Exemplo: SP.
recipientFinal.address.zipCodestringCódigo postal do endereço.
payments[]array of stringsLista de objetos contendo informações sobre os pagamentos realizados referentes ao boleto.
payments[].idstringIdentificador único do pagamento.
payments[].amountnumberValor pago.
payments[].paymentChannelstringNome do canal de pagamento (Agency, SelfServiceTerminal, InternetBanking, CorrespondentBanking, CallCenter, EletronicFile, DDA, PIX, DCC, DigitalCorrespondentBanking).
payments[].paidOutDatestringData de pagamento, no formato YYYY-MM-DDTHH:mm:SS.
interestobjectObjeto que contém informações sobre o juros aplicado no boleto de cobrança (Levy).
interest.startDatestringData de início para cálculo dos juros, no formato YYYY-MM-DDTHH:mm:SS.
interest.valuenumberValor monetário ou percentual dos juros, dependendo da configuração do campo interest.type.
interest.typestringRegra para cálculo dos juros. Confira a tabela com as regras referentes a juros, multas e descontos.
fineobjectObjeto que contém informações sobre a multa aplicada no boleto de cobrança (Levy).
fine.startDatestringData de início para cálculo da multa, no formato YYYY-MM-DDTHH:mm:SS.
fine.valuenumberValor monetário ou percentual da multa, dependendo da configuração do campo fine.type.
fine.typestringTipo da regra aplicada a multa. Confira a tabela com as regras referentes a juros, multas e descontos.
discountobjectObjeto que contém informações sobre os descontos aplicados no boleto de cobrança (Levy).
discount.limitDatestringData limite, no formato YYYY-MM-DDTHH:mm:SS, para incidência de desconto (considera-se desde a data de emissão até um dia antes do vencimento).
discount.valuenumberValor monetário ou percentual do desconto, dependendo da configuração do campo discount.type.
discount.typestringTipo da regra para cálculo do desconto. Confira a tabela com as regras referentes a juros, multas e descontos.

📘

Nota

Os campos barcode, digitable, ournumber e document somente 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

StatusDescrição
ProcessedA solicitação do boleto foi aceita e está sendo processada.
RegisteredO boleto foi registrado na Nuclea/CIP.
ConciliatedO boleto foi conciliado, mas o valor ainda não está disponível na conta do emissor.
SettledO boleto foi liquidado/baixado.
CancelledO 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.