curl "https://api.zeriqpay.com.br/v1/webhooks/cmid_webhook/deliveries?status=FAILED" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"data": {
"items": [
{
"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"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
}
}
}
Entregas e Reenvios
Entregas do endpoint
Lista as entregas de um endpoint específico
GET
/
v1
/
webhooks
/
{id}
/
deliveries
curl "https://api.zeriqpay.com.br/v1/webhooks/cmid_webhook/deliveries?status=FAILED" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"data": {
"items": [
{
"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"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
}
}
}
Use esta rota quando você quiser acompanhar somente as entregas de um endpoint. O
id é o identificador do endpoint criado no submenu Gerenciamento.
Autenticação
Todas as rotas exigemX-API-Key com uma chave que começa com zeriq_.
curl "https://api.zeriqpay.com.br/v1/webhooks/cmid_webhook/deliveries?status=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.
Referência
- Método:
GET - Rota:
/v1/webhooks/{id}/deliveries - Autenticação:
X-API-Key
Exemplo de resposta
{
"success": true,
"data": {
"items": [
{
"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"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
}
}
}
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_.
Path Parameters
ID do endpoint.
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.