Consulta de um reprocessamento em lote
stable
Este endpoint possibilita consultar os reprocessamentos em lote que foram previamente criados. A consulta retornará informações detalhadas como quantidade de eventos reprocessados, status, datas e contexto.
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 eventos.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages/batch
--request GET 'https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages/batch?StartDate=2025-01-01&endDate=2025-02-28&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:
| 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 os seguintes campos:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
startDate | query | Obrigatório. Data inicial dos eventos a serem exibidos na pesquisa. | Formato YYYY-MM-DD. |
endDate | query | Obrigatório. Data final dos eventos a serem exibidos na pesquisa. | Formato YYYY-MM-DD. |
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
Os campos
startDateeendDateconsideram somente valores de datas. Horas, minutos e segundos são ignorados.
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:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
reprocessedEvents | number | Retorna a quantidade de eventos já reprocessados. | — |
totalEvents | number | Retorna a quantidade de eventos a serem reprocessados. | — |
id | string | Identificador único do lote. | — |
startDate | string | Data inicial dos eventos, no formato YYYY-MM-DD. | — |
endDate | string | Data final dos eventos, no formato YYYY-MM-DD. | — |
context | string | Contexto do evento. | — |
eventNames | array of strings | Lista que contém o nome dos eventos. | — |
companyKey | string | Chave que identifica o parceiro dentro do Bankly. | — |
correlationId | string | Identificador que correlaciona todo o fluxo das operações. | — |
status | string | Situação do lote de eventos. | 20 |
createdAt | string | Data de criação da solicitação do reprocessamento em lote, no formato ISO 8601 - UTC. | — |
updatedAt | string | Data da última atualização do reprocessamento, no formato ISO 8601 - UTC. | — |
[
{
"reprocessedEvents": 4828,
"totalEvents": 4828,
"id": "12f89f4b-d382-43bd-b9e8-4c12e4f0b91b",
"startDate": "2025-01-01",
"endDate": "2025-02-28",
"context": "Customer",
"eventNames": [
""
],
"companyKey": "AUTOMATED_TESTS",
"correlationId": "6817a085-9bd4-413f-aa80-c8889912b8fc",
"status": "DONE",
"createdAt": "2025-03-05T21:28:13.837",
"updatedAt": "2025-03-05T21:46:19.667"
}
]
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Status dos eventos
| Status | Descrição |
|---|---|
| WAITING | Estado inicial do reprocessamento em lote. |
| PROCESSING | Indica que os lotes estão sendo reprocessados. |
| FAILURE | Indica que houve falha durante o reprocessamento. |
| DONE | Indica que o reprocessamento foi concluído com sucesso. |
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 422 | INVALID_BATCH_WEBHOOK_SEARCH | PageSize with disallowed quantity. The value must be between 1 and 100 | O valor informado no campo PageSize apresenta uma quantidade não permitida. Informe um valor entre 1 e 100. |
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 about 1 month ago