Consulta de mensagens enviadas
stable
Este endpoint possibilita pesquisar todos os eventos enviados pelos webhooks em um determinado período.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages
--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
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
webhook.read | Concede acesso para consultar configurações de webhooks, pesquisar mensagens enviadas e realizar o reprocessamento de mensagens. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
startDate | query | Obrigatório. Data de inicial das mensagens a serem exibidas na pesquisa (YYYY-DD-MM). | Formato YYYY-MM-DD. |
endDate | query | Obrigatório. Data de final das mensagens a serem exibidas na pesquisa (YYYY-DD-MM). | Formato YYYY-MM-DD. |
state | query | Situação do envio das mensagens. Informe Success ou Failed. Ao informar Failed, o endpoint retornará todas as mensagens enviadas com sucesso pelo Bankly, mas que, por alguma falha do lado do parceiro, não foram recebidas por ele. | — |
eventName | query | Nome do evento. | — |
context | query | Contexto em que as mensagens foram enviadas. Exemplo: Pix | — |
page | query | Número da página que deseja consultar. | Valor padrão: 1 |
pageSize | query | Quantidade de resultados a serem exibidos por página. | Valor padrão: 10. Máximo permitido: 100 |
Importante
O campo
startDatedeve ser preenchido com uma data no máximo seis meses anterior à data atual.
Resposta (Response)
O status code
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
id | string | Identificador do processamento. Se necessário, pode ser utilizado para o posterior reprocessamento de mensagens |
idempotencyKey | string | Informação utilizada para evitar a duplicidade de transações (valor em formato UUID). |
state | string | Informa se a mensagem foi recebida com sucesso (Success), falha (Failed) ou se ela se encontra retida (Hold) no fluxo do Circuit Breaker. |
destination | string | URI para qual a mensagem foi enviada. |
sentDate | string | Data de envio. |
eventName | string | Nome do evento. |
retryCount | string | Número de tentativas de reenvio. |
elapsedEventCapture | string | tempo de captura do evento. |
elapsedHttpCall | string | tempo de execução da chamada Http. |
context | string | Contexto do evento, |
{
"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"
},
{
"idempotencyKey": "8fa77d00-2551-4ec3-ba1c-49ec65085bd7",
"state": "Success",
"destination": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d6",
"sentDate": "2021-11-21T16:49:05.733"
}
]
}
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 3 days ago