curl "https://api.zeriqpay.com.br/v1/webhooks/deliveries/cmid_delivery" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"data": {
"delivery": {
"id": "cmid_delivery",
"endpointId": "cmid_webhook",
"userId": "cmid_user",
"transactionId": "cmid_transaction",
"event": "payment.failed",
"status": "FAILED",
"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": 3,
"lastAttemptAt": "2026-10-28T12:02:00.000Z",
"lastResponseStatus": 500,
"lastResponseBody": "upstream error",
"lastError": "HTTP 500",
"deliveredAt": null,
"replayedFromDeliveryId": null,
"replayReason": null,
"createdAt": "2026-10-28T12:00:00.000Z",
"updatedAt": "2026-10-28T12:02:00.000Z",
"endpoint": {
"id": "cmid_webhook",
"name": "Pagamentos",
"url": "https://app.exemplo.com/webhooks/zeriqpay",
"active": true
}
},
"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": [
{
"id": "cmid_attempt",
"attemptNumber": 1,
"responseStatus": 500,
"responseBody": "upstream error",
"error": "HTTP 500",
"startedAt": "2026-10-28T12:00:01.000Z",
"finishedAt": "2026-10-28T12:00:02.000Z"
}
]
}
}
Entregas e Reenvios
Consultar entrega
Consulta uma entrega e suas tentativas
GET
/
v1
/
webhooks
/
deliveries
/
{deliveryId}
curl "https://api.zeriqpay.com.br/v1/webhooks/deliveries/cmid_delivery" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"data": {
"delivery": {
"id": "cmid_delivery",
"endpointId": "cmid_webhook",
"userId": "cmid_user",
"transactionId": "cmid_transaction",
"event": "payment.failed",
"status": "FAILED",
"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": 3,
"lastAttemptAt": "2026-10-28T12:02:00.000Z",
"lastResponseStatus": 500,
"lastResponseBody": "upstream error",
"lastError": "HTTP 500",
"deliveredAt": null,
"replayedFromDeliveryId": null,
"replayReason": null,
"createdAt": "2026-10-28T12:00:00.000Z",
"updatedAt": "2026-10-28T12:02:00.000Z",
"endpoint": {
"id": "cmid_webhook",
"name": "Pagamentos",
"url": "https://app.exemplo.com/webhooks/zeriqpay",
"active": true
}
},
"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": [
{
"id": "cmid_attempt",
"attemptNumber": 1,
"responseStatus": 500,
"responseBody": "upstream error",
"error": "HTTP 500",
"startedAt": "2026-10-28T12:00:01.000Z",
"finishedAt": "2026-10-28T12:00:02.000Z"
}
]
}
}
Retorna a entrega, o payload enviado, a última resposta recebida e o histórico de tentativas. Use esta rota para diagnosticar uma falha antes de solicitar o reenvio.
Autenticação
Todas as rotas exigemX-API-Key com uma chave que começa com zeriq_.
curl "https://api.zeriqpay.com.br/v1/webhooks/deliveries/cmid_delivery" \
-H "X-API-Key: zeriq_sua_chave"
Escopos necessários
- Listagem e consulta:
webhooks.read - Reenvio individual ou em lote:
webhooks.retry
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:
GET - Rota:
/v1/webhooks/deliveries/{deliveryId} - Autenticação:
X-API-Key
Exemplo de resposta
{
"success": true,
"data": {
"delivery": {
"id": "cmid_delivery",
"endpointId": "cmid_webhook",
"userId": "cmid_user",
"transactionId": "cmid_transaction",
"event": "payment.failed",
"status": "FAILED",
"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": 3,
"lastAttemptAt": "2026-10-28T12:02:00.000Z",
"lastResponseStatus": 500,
"lastResponseBody": "upstream error",
"lastError": "HTTP 500",
"deliveredAt": null,
"replayedFromDeliveryId": null,
"replayReason": null,
"createdAt": "2026-10-28T12:00:00.000Z",
"updatedAt": "2026-10-28T12:02:00.000Z",
"endpoint": {
"id": "cmid_webhook",
"name": "Pagamentos",
"url": "https://app.exemplo.com/webhooks/zeriqpay",
"active": true
}
},
"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": [
{
"id": "cmid_attempt",
"attemptNumber": 1,
"responseStatus": 500,
"responseBody": "upstream error",
"error": "HTTP 500",
"startedAt": "2026-10-28T12:00:01.000Z",
"finishedAt": "2026-10-28T12:00:02.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.