Consulta por authenticationCode

stable

A API 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: 1.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. Atualmente estamos na versão 1.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 da conta que está emitindo o boleto.
numberpathNúmero da conta que está emitindo o 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)

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:

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 os possíveis status do boleto na tabela abaixo.
accountobjectObjeto que contém informações sobre a conta do pagador.
account.numberstringNúmero da conta.
documentstringNúmero do documento (CPF ou CNPJ) do pagador.
amountobjectObjeto que contém informações sobre o valor pago.
amount.currencystringCódigo da moeda com base na ISO-4217.
amount.valuenumberValor pago.
minimumAmountobjectObjeto que contém informações sobre o valor mínimo pago (específico e obrigatório para boletos de cartão de crédito).
minimumAmount.currencystringCódigo da moeda com base na ISO-4217.
minimumAmount.valuenumberValor mínimo pago.
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), "Levy" (Cobrança) e "Invoice" (Fatura).
payerobjectObjeto que contém informações sobre o pagador do boleto. Este objeto só 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.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 recebedor do pagamento.
recipientFinal.documentstringNúmero do documento (CPF ou CNPJ) do recebedor.
recipientFinal.tradeNamestringNome fantasia do recebedor.
recipientFinal.namestringNome do recebedor.
recipientFinal.addressobjectObjeto que contém informações sobre o endereço do recebedor.
recipientFinal.address.addressLinestringEndereço do recebedor.
recipientFinal.address.citystringNome da cidade. Deve-se evitar acentos e outros caracteres especiais.
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.
recipientOriginobjectObjeto que contém informações sobre o cliente que solicitou a emissão do boleto
recipientOrigin.documentstringNúmero do documento (CPF ou CNPJ) do solicitante.
recipientOrigin.tradeNamestringNome fantasia do solicitante
recipientOrigin.namestringNome do solicitante.
recipientOrigin.addressobjectObjeto que contém informações sobre o endereço do solicitante.
recipientOrigin.address.addressLinestringEndereço do solicitante.
recipientOrigin.address.citystringNome da cidade. Deve-se evitar acentos e outros caracteres especiais.
recipientOrigin.address.statestringNome do estado Deve-se respeitar o formato proposto pela ISO 3166-2:BR. Exemplo: SP.
recipientOrigin.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).
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 as possíveis regras referentes a juros na tabela abaixo.
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 as possíveis regras referentes a multa na tabela abaixo.
discountsobjectObjeto que contém informações sobre os descontos aplicados no boleto de cobrança (Levy).
discounts.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).
discounts.valuenumberValor monetário ou percentual do desconto, dependendo da configuração do campo discounts.type.
discounts.typestringTipo da regra para cálculo do desconto. Confira as possíveis regras referentes a descontos na tabela abaixo.
{
    "authenticationCode": "5566165e-51fb-459b-a31c-1e996165280b",
  	"barcode": "33297940700000001000001115801398869900725986",
    "updatedAt": "2022-02-14T17:49:28.518+00:00",
    "ourNumber": "44696851879",
    "digitable": "33290001151446968518579001874704188970000002000",
    "status": "Registered",
    "account": {
       "number": "15164"
    },
    "document": "47742663023",
    "amount": {
       "currency": "BRL",
       "value": 20
    },
    "minimumAmount": {
       "currency": "BRL",
       "value": 1
    },
    "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",
    "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"
       }
    },
    "recipientOrigin": {
       "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": "Free"
    },
    "fine": {
       "startDate": "0001-01-02T23:59:59-03:06",
       "value": 0,
       "type": "Free"
    },
    "discounts": {
       "limitDate": "0001-01-02T23:59:59-03:06",
       "value": 0,
       "type": "Free"
    }
 }

Status do boleto

NomeDescrição
ProcessedA solicitação do boleto foi aceita e está sendo processada.
RegisteredO boleto foi registrado na CIP.
MarkedConciliationOcorrência de erro no processo de conciliação. Geralmente isso acontece quando há algum problema com a conta do emissor, sendo necessária uma análise manual.
ConciliationO boleto foi conciliado, mas o valor ainda não está disponível na conta do emissor.
SettledO boleto foi liquidado/baixado.
CancelledByRecipientO boleto foi cancelado pelo emissor.
CancelledByDeadLineO boleto foi cancelado por decurso do prazo.
BlockedForPaymentO boleto está bloqueado para pagamento.
UnfitBeneficiaryO beneficiário do boleto está inapto.

🚧

Importante

Caso o status Accepted seja retornado, considerar como Processed. Caso retorne o status Cancelled, considerar como CancelledByRecipient ou CancelledByDeadLine.

Regras de juros, multa e descontos

Juros (Interest)Multa (Fine)Descontos (Discounts)
AmountPerCalendaryDay: valor monetário por dia corrido (sem distinção de fins de semana e feriados). Esse campo aceita apenas números inteiros.FixedAmount: valor monetário fixo.FixedAmountUntilLimitDate: valor fixo até a data limite
PercentPerMonth: percentual ao mês.Percent: percentual sobre o valor do título.FixedPercentUntilLimitDate: percentual fixo até a data limite.
Free: indica a não incidência de juros no boleto.Free: indica a não incidência de multa.Free: indica que não há incidência de desconto no boleto.
AmountPerBusinessDay: valor monetário por dia útil.------
PercentPerMonthBusinessDay: percentual ao mês (considerando apenas os dias úteis).------

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Satus codeCódigoDescrição
400PERSIST_REQUEST_INVALIDAgência ou conta incorreta.
404BANKSLIP_NOT_FOUNDBoleto não encontrado.

Válido lembrar que a API também poderá retornar erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.