Consulta de mensagens enviadas

stable

Este endpoint permite pesquisar todas as mensagens enviadas pelos webhooks em um determinado período.

🚧

Importante

Recomendamos que o parceiro estabeleça uma rotina de consulta de mensagens enviadas para que identifique eventuais falhas no recebimento de eventos e, dessa forma, possa solicitar o reprocessamento de mensagens.

Requisição

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages?startDate={starteDate}?endDate={endDate}
--curl --request  GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages?startDate=2021-11-21&endDate=2021-11-21&state=Success&eventName=PIX_CASH_IN_WAS_RECEIVED&context=Pix&page=1&pageSize=100' \  
--header 'Content-Type: application/json' \  
--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
webhook.readConcede acesso para consultar configurações de webhooks, pesquisar mensagens enviadas e realizar o reprocessamento de mensagens.

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
startDatequeryObrigatório. Data de inicial das mensagens a serem exibidas na pesquisa, no formato YYYY-MM-DD.
endDatequeryObrigatório. Data de final das mensagens a serem exibidas, no formato YYYY-MM-DD.
statequeryNesse campo, é possível informar os valores: Success (para pesquisar mensagens recebidas com sucesso), Failed (para mensagens que foram enviadas com sucesso por parte do Bankly, mas que, por alguma falha do lado do parceiro, não foram recebidas) e Hold (para mensagens que ficaram retidas no fluxo do Circuit Breaker).
eventNamequeryNome do evento.
contextqueryContexto em que os eventos foram enviados. Exemplo: Pix.
pagequeryNúmero da página que deseja consultar.
pageSizequeryQuantidade de resultados a serem exibidos por página.

🚧

Importante

O campo startDate deve ser preenchido com uma data no máximo seis meses anterior à data atual.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescrição
dataarray of objectsObjeto que contém uma lista de mensagens enviadas pelos webhooks Bankly em um determinado período.
data.idstringIdentificador do processamento, que poderá ser utilizado para posterior reprocessamento de mensagens (valor em formato UUID).
data.idempotencyKeystringInformação utilizada para evitar a duplicidade de transações (valor em formato UUID). Esse valor poderá ser utilizado para o posterior reprocessamento de mensagens, caso seja necessário.
data.statestringInforma se a mensagem foi recebida com sucesso (Success), se houve falha no recebimento (Failed) ou se a mensagem ficou retida no fluxo do Circuit Breaker (Hold).
data.destinationstringURI para qual a mensagem foi enviada.
data.sentDatestringData de envio da mensagem.
data.eventNamestringNome do evento.
data.retryCountnumberNúmero de tentativas de reenvio.
data.elapsedEventCapturestringTempo de captura do evento, no formato ISO 8601 - UTC..
data.elapsedHttpCallstringTempo de execução da chamada Http.
data.contextstringContexto do evento.
linksarray of objectsLinks de próximos estados válidos da entidade/recurso.
links.urlstringURLs que podem ser utilizadas em um próximo estado da entidade.
links.relstringDescrição de como a URL se relaciona com o recurso atual.
links.methodstringTipo de verbo que deve ser utilizado para acessar a URL.
metadictionary<string, object>Dicionário de metadados que trará dados adicionais da requisição.
{
   "data": [
      {
         "id" : "aaff746c-bb72-4e1c-a5bb-bcda66a1fca4",
         "idempotencyKey": "498dfed0-e994-49cb-a33b-7bd8088c4d8e",
         "state": "Success",
         "destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "sentDate": "2021-11-21T16:47:27.14",
         "eventName": "PIX_CASH_IN_WAS_RECEIVED",
         "retryCount": 0,
         "elapsedEventCapture": "00:00:00.0996311",
         "elapsedHttpCall": "00:00:00.6384607",
         "context": "Pix"
      },
      {
         "id" : "bbdf746c-bb72-4e1c-a5bb-bcda66a1fca4",
         "idempotencyKey": "7697d191-429e-4400-955e-a115926bb38a",
         "state": "Success",
         "destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "sentDate": "2021-11-21T16:49:05.287",
         "eventName": "PIX_CASH_IN_WAS_RECEIVED",
         "retryCount": 0,
         "elapsedEventCapture": "00:00:00.1029727",
         "elapsedHttpCall": "00:00:00.6287861",
         "context": "Pix"
      },
      {
         "id" : "baff746c-bb72-4e1c-a5bb-bcda66a1fca4",
         "idempotencyKey": "8fa77d00-2551-4ec3-ba1c-49ec65085bd7",
         "state": "Success",
         "destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
         "sentDate": "2021-11-21T16:49:05.733",
         "eventName": "PIX_CASH_IN_WAS_RECEIVED",
         "retryCount": 0,
         "elapsedEventCapture": "00:00:00.1030878",
         "elapsedHttpCall": "00:00:00.5653400",
         "context": "Pix"
      }
   ],
   "links": [
      {
         "url": "https://api-mtls.sandbox.bankly.com.br/webhooks?page=2&pageSize=100&startDate=2021-11-21&endDate=2021-11-21&state=Success&eventName=PIX_CASH_IN_WAS_RECEIVED&context=Pix",
         "rel": "search_next_page_processed_message",
         "method": "GET"
      }às
   ],
   "meta": {
      "page": 1,
      "pageSize": 3,
      "total": 10
   }
}

👍

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.