Reprocessamento de eventos em lote
stable
Este endpoint possibilita registrar reprocessamentos de eventos em lote. A partir dele, você pode reprocessar eventos ocorridos em um intervalo de tempo, com base em diferentes contextos e nomes de eventos.
Requisição (Request)
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages/batch
---request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/webhooks/processed-messages/batch' \
--header 'x-correlation-id: 6d6a440a-8618-4f5b-a7c1-3fed00db7c7d' \
--header 'api-version: 1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Token}}' \
--header 'Content-Length: 157' \
--data '{
"startDate": "2025-01-01",
"endDate": "2025-02-28",
"context": "Customer",
"eventState": "Success",
"eventNames": [
"CUSTOMER_WAS_RECEIVED"
]
}'
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. |
x-correlation-id | Obrigatório. Identificador único da requisição para rastreabilidade. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
startDate | string | Obrigatório. Data inicial dos eventos a serem reprocessados. | Formato da data: YYYY-MM-DD |
endDate | string | Obrigatório. Data final dos eventos a serem reprocessados. | Formato da data: YYYY-MM-DD |
context | string | Nome do contexto do evento. Este campo é obrigatório em caso de intervalo maior que 30 dias. | Tamanho máximo: 13 caracteres. |
eventNames | array of strings | Lista que deve conter os nomes dos eventos. Este campo é obrigatório em caso de intervalo maior que 30 dias. | — |
eventState | string | Situação dos eventos, a qual pode ser “Success” ou “Failed”. | — |
Importante
O intervalo de tempo informado nos campos
startDateeendDatenão pode ser superior a três meses. Além disso, a data inicial de requisição de reprocessamento não pode ser superior a um ano da data corrente.
{
"startDate": "2025-01-01",
"endDate": "2025-02-28",
"context": "Customer",
"eventState": "Success",
"eventNames": [
"CUSTOMER_WAS_RECEIVED"
]
}
Resposta (Response)
O status code 201 indicará que o reprocessamento em lote foi criado com sucesso. O pedido é criado incialmente com status WAITING e entrará para a fila de reprocessamento.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
id | string | Identificador único do lote. | — |
startDate | string | Data inicial dos eventos a serem reprocessados. | — |
endDate | string | Data final dos eventos a serem reprocessados. | — |
context | string | Nome do contexto do evento. | 13 |
eventNames | array of strigs | Lista com os nomes dos eventos. | — |
eventState | string | Situação do evento, a qual pode ser “Success” ou “Failed”. | — |
companyKey | string | Chave que identifica o parceiro dentro do Bankly. | — |
correlationId | string | Identificador que correlaciona todo o fluxo das operações. | — |
createdAt | string | Data de criação da solicitação do reprocessamento em lote. | — |
status | string | Situação do lote de eventos. | 20 |
{
"id": "b6036845-d4cd-4b1c-a35e-f603fa0de9dc",
"startDate": "2025-01-01",
"endDate": "2025-02-28",
"context": "Customer",
"eventNames": [
"CUSTOMER_WAS_RECEIVED"
],
"eventState": "Success",
"companyKey": "AUTOMATED_TESTS",
"correlationId": "6d6a440a-8618-4f5b-a7c1-3fed00db7c7d",
"createdAt": "2025-03-20T15:03:15.789Z",
"status": "WAITING"
}
Status dos lotes de 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. |
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 Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 422 | INVALID_BATCH_WEBHOOK_RESEND | Start date cannot be a future date. | A data de início não pode ser uma data futura. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | Start date cannot be greater than end date. | A data de início não pode ser posterior à data fim. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | The entered value is an invalid context. | Valor inválido para o campo context. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | The entered event state is invalid. Enter 'Success' or 'Failed' | Valor inválido para o campo eventState. Informe 'Success' or 'Failed'. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | A context or event name is required if the period is longer than one month. | Se o período em questão for maior do que 30 dias, deve-se informar os valores dos campos context e eventNames. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | Context or event name is required if the period is greater than one month. | Se o período em questão for maior do que 30 dias, deve-se informar os valores dos campos context e eventNames. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | The period exceeds the allowed limit of three months. | O período informado excede o limite de três meses. |
| 422 | INVALID_BATCH_WEBHOOK_RESEND | The start date cannot be older than one year. | A data inicial de requisição de reprocessamento não pode ser superior a um ano da data corrente. |
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 29 days ago