curl -X POST "https://api.zeriqpay.com.br/v1/webhooks/deliveries/resend-failed?maxItems=20&event=payment.failed" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"message": "Reenvio das falhas processado.",
"data": {
"requested": 1,
"queued": 1,
"items": [
{
"originalDeliveryId": "cmid_delivery",
"status": "QUEUED",
"delivery": {
"id": "cmid_replay",
"endpointId": "cmid_webhook",
"userId": "cmid_user",
"transactionId": "cmid_transaction",
"event": "payment.failed",
"status": "PENDING",
"payload": {
"id": "evt_123",
"event": "payment.failed",
"createdAt": "2026-10-28T12:00:00.000Z",
"data": {}
},
"response": {
"status": 500,
"body": "upstream error",
"error": "HTTP 500"
},
"attempts": 0,
"lastAttemptAt": null,
"lastResponseStatus": null,
"lastResponseBody": null,
"lastError": null,
"deliveredAt": null,
"replayedFromDeliveryId": "cmid_delivery",
"replayReason": "MANUAL",
"createdAt": "2026-10-28T12:03:00.000Z",
"updatedAt": "2026-10-28T12:03:00.000Z"
}
}
]
}
}
Entregas e Reenvios
Reenviar falhas
Enfileira novamente entregas com falha
POST
/
v1
/
webhooks
/
deliveries
/
resend-failed
curl -X POST "https://api.zeriqpay.com.br/v1/webhooks/deliveries/resend-failed?maxItems=20&event=payment.failed" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"message": "Reenvio das falhas processado.",
"data": {
"requested": 1,
"queued": 1,
"items": [
{
"originalDeliveryId": "cmid_delivery",
"status": "QUEUED",
"delivery": {
"id": "cmid_replay",
"endpointId": "cmid_webhook",
"userId": "cmid_user",
"transactionId": "cmid_transaction",
"event": "payment.failed",
"status": "PENDING",
"payload": {
"id": "evt_123",
"event": "payment.failed",
"createdAt": "2026-10-28T12:00:00.000Z",
"data": {}
},
"response": {
"status": 500,
"body": "upstream error",
"error": "HTTP 500"
},
"attempts": 0,
"lastAttemptAt": null,
"lastResponseStatus": null,
"lastResponseBody": null,
"lastError": null,
"deliveredAt": null,
"replayedFromDeliveryId": "cmid_delivery",
"replayReason": "MANUAL",
"createdAt": "2026-10-28T12:03:00.000Z",
"updatedAt": "2026-10-28T12:03:00.000Z"
}
}
]
}
}
Processa as entregas com status
FAILED que correspondem aos filtros informados. Use maxItems para limitar a quantidade processada em cada solicitação.
Autenticação
Todas as rotas exigemX-API-Key com uma chave que começa com zeriq_.
curl -X POST "https://api.zeriqpay.com.br/v1/webhooks/deliveries/resend-failed?maxItems=20&event=payment.failed" \
-H "X-API-Key: zeriq_sua_chave"
Escopos necessários
- Listagem e consulta:
webhooks.read - Reenvio individual ou em lote:
webhooks.retry
Filtros
page, limit, status, event, dateFrom, dateTo, endpointId e search podem ser usados nas rotas de listagem. O reenvio em lote também aceita maxItems.
Boas práticas
- Responda rapidamente ao webhook original e processe o evento de forma idempotente.
- Consulte os detalhes da entrega antes de reenviar quando a causa da falha não estiver clara.
- Use
Idempotency-Keyem reenvios manuais e persista o resultado retornado. - Reenvie somente depois de corrigir a causa da falha no seu endpoint.
Referência
- Método:
POST - Rota:
/v1/webhooks/deliveries/resend-failed - Autenticação:
X-API-Key
Exemplo de resposta
{
"success": true,
"message": "Reenvio das falhas processado.",
"data": {
"requested": 1,
"queued": 1,
"items": [
{
"originalDeliveryId": "cmid_delivery",
"status": "QUEUED",
"delivery": {
"id": "cmid_replay",
"endpointId": "cmid_webhook",
"userId": "cmid_user",
"transactionId": "cmid_transaction",
"event": "payment.failed",
"status": "PENDING",
"payload": {
"id": "evt_123",
"event": "payment.failed",
"createdAt": "2026-10-28T12:00:00.000Z",
"data": {}
},
"response": {
"status": 500,
"body": "upstream error",
"error": "HTTP 500"
},
"attempts": 0,
"lastAttemptAt": null,
"lastResponseStatus": null,
"lastResponseBody": null,
"lastError": null,
"deliveredAt": null,
"replayedFromDeliveryId": "cmid_delivery",
"replayReason": "MANUAL",
"createdAt": "2026-10-28T12:03:00.000Z",
"updatedAt": "2026-10-28T12:03:00.000Z"
}
}
]
}
}
Respostas
A operação de listagem retornaitems e pagination. A consulta detalhada também retorna payload, response e attempts. As rotas de reenvio respondem com HTTP 202 porque a entrega é colocada em fila para processamento assíncrono.
A referência OpenAPI abaixo contém parâmetros, exemplos de request e response e códigos de erro.Authorizations
API Key ZeriqPay iniciada por zeriq_.
Query Parameters
Página iniciando em 1.
Quantidade por página, de 1 a 100.
PENDING, DELIVERED ou FAILED.
Evento do webhook.
Data inicial ISO 8601.
Data final ISO 8601.
Filtra por endpoint.
Busca textual.
Máximo de falhas processadas, de 1 a 100.