InstitucionalBlogService DeskStatus Page

Consulta por data

stable

Suggest Edits

Este endpoint permite que o parceiro verifique todos os boletos emitidos por ele que sofreram alteração de status em uma data específica.

🚧

Importante

Não se trata de uma consulta de logs, com histórico dos status passados, pois o boleto será exibido apenas na data de sua última atualização.

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/searchstatus/{{date}}

--location --request GET 'https://api-mtls.sandbox.bankly.com.br/bankslip/searchstatus/{{date}}' \  
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'api-version: 1.0' \  
--header 'Authorization: Bearer {{Token}}'

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
datepathData a ser consultada, no formato yyyy-MM-dd.

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á uma lista de boletos e suas informações.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescrição
nextPageTokenstringToken referente a próxima página a ser consultada.
dataarray of objectsLista de objetos contendo informações sobre os boletos emitidos que sofreram alteração de status em uma data específica.
data[].authenticationCodestringIdentificador único do boleto.
data[].barcodestringNúmero do código de barras do boleto.
data[].statusstringSituação do boleto no momento da consulta. Confira os possíveis status do boleto na tabela abaixo.
data[].updatedAtstringData de atualização do status do boleto, no formato YYYY-MM-DDTHH:mm:SS.
data[].payments[]array of stringsLista de objetos contendo informações sobre os pagamentos realizados referentes ao boleto.
data[].payments[].idstringIdentificador único do pagamento.
data[].payments[].amountnumberValor pago.
data[].payments[].paymentChannelstringCanal de pagamento.
data[].payments[].paidOutDatestringData de pagamento do boleto, no formato YYYY-MM-DDTHH:mm:SS.

A lista a seguir traz o retorno da consulta de boletos que sofreram alteração no dia 16/02/2022 (updatedAt). 

{
  "nextPageToken": "cf8e2c9e-fed3-4438-91c9-b51e5b8kfaef",
   "data": [
      {
         "authenticationCode": "5566165e-51fb-459b-a31c-1e996165280b",
         "barcode": "33297940700000001000001115801398869900725986",
         "status": "Settled",
         "updatedAt": "2022-02-16T11:43:00.739+00:00",
         "payments": [
            {
               "id": "a17a0d4d-9b22-4929-af83-93449307c92a",
               "amount": 20,
               "paymentChannel": "InternetBanking",
               "paidOutDate": "2022-02-15T00:00:00+00:00"
            }
         ]
      },
      {
         "authenticationCode": "bf6e2c9e-fed3-4338-91c9-b51e5b8ffaef",
         "status": " Settled",
         "updatedAt": "2022-02-16T11:42:08.276+00:00",
         "payments": [
            {
               "id": "302535d4-44de-42b6-b259-9f0e58bb1ce4",
               "amount": 10,
               "paymentChannel": "InternetBanking",
               "paidOutDate": "2022-02-15T00:00:00+00:00"
            }
         ]
      },
      {
         "authenticationCode": "32e0d547-a35d-4acf-bf31-cfe59e8719bc",
         "status": "Registered",
         "updatedAt": "2022-02-16T18:53:37.148+00:00",
         "payments": []
      }
   ]
}

Possíveis status

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.

👍

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:

Status codeCódigoDescrição
404BANKSLIP_NOT_FOUND_UPDATEATNão foi localizado boleto para a data informada.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated 2 months ago