Histórico de entregas

curl "https://api.zeriqpay.com.br/v1/webhooks/deliveries?status=FAILED&page=1&limit=20" \
  -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",
        "endpoint": {
          "id": "cmid_webhook",
          "name": "Pagamentos",
          "url": "https://app.exemplo.com/webhooks/zeriqpay",
          "active": true
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "pages": 1
    }
  }
}

GET

webhooks

deliveries

curl "https://api.zeriqpay.com.br/v1/webhooks/deliveries?status=FAILED&page=1&limit=20" \
  -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",
        "endpoint": {
          "id": "cmid_webhook",
          "name": "Pagamentos",
          "url": "https://app.exemplo.com/webhooks/zeriqpay",
          "active": true
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "pages": 1
    }
  }
}

Use esta rota para consultar entregas de webhook da conta. O resultado é paginado e pode ser filtrado por status, evento, período, endpoint ou texto de busca.

Autenticação

Todas as rotas exigem X-API-Key com uma chave que começa com zeriq_.

curl "https://api.zeriqpay.com.br/v1/webhooks/deliveries?status=FAILED&page=1&limit=20" \
  -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/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",
        "endpoint": {
          "id": "cmid_webhook",
          "name": "Pagamentos",
          "url": "https://app.exemplo.com/webhooks/zeriqpay",
          "active": true
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "pages": 1
    }
  }
}

Respostas

A operação de listagem retorna items 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

X-API-Key

string

header

required

API Key ZeriqPay iniciada por zeriq_.

Query Parameters

page

string

Página iniciando em 1.

limit

integer

Quantidade por página, de 1 a 100.

status

string

PENDING, DELIVERED ou FAILED.

event

string

Evento do webhook.

dateFrom

string

Data inicial ISO 8601.

dateTo

string

Data final ISO 8601.

endpointId

string

Filtra por endpoint.

string

Busca textual.

Response

Histórico paginado.

success

boolean

data

object

Show child attributes

Comece pela API

PIX

Conta

Webhooks

Autenticação

Escopos necessários

Filtros

Referência

Exemplo de resposta

Respostas

Authorizations

Query Parameters

Response

​Autenticação

​Escopos necessários

​Filtros

​Referência

​Exemplo de resposta

​Respostas

Authorizations

Query Parameters

Response

Autenticação

Escopos necessários

Filtros

Referência

Exemplo de resposta

Respostas