Docs
Acessar painel

Webhooks

Listar eventos

GEThttps://api.kokupay.com/v1/webhooks/events

Lista os eventos emitidos para a sua conta, com o mesmo conteúdo enviado por webhook. A consulta não depende da entrega: use-a para conferir o que pode ter se perdido.

GET/v1/webhooks/events
curl -X GET 'https://api.kokupay.com/v1/webhooks/events?type=charge.paid&limit=20' \
  -H "Authorization: Bearer $KOKU_API_KEY"
200Resposta
{
  "items": [
    {
      "id": "evt_2f6b1c9e8a4d4e7f9b3c5a1d0e6f8b27",
      "type": "charge.paid",
      "version": "v1",
      "environment": "production",
      "object_type": "charge",
      "object_id": "8d3f6a12-4b9e-4c71-a2d5-6e0f1b3c9a47",
      "created_at": "2026-10-07T15:32:11.000Z",
      "data": {
        "charge_id": "8d3f6a12-4b9e-4c71-a2d5-6e0f1b3c9a47",
        "order_reference": "PEDIDO-1001",
        "amount_cents": "15990",
        "fee_cents": "320",
        "net_cents": "15670",
        "reserve_cents": "0",
        "paid_at": "2026-10-07T15:32:10.000Z",
        "end_to_end_id": "E12345678202610071532a1B2c3D4e5F",
        "late_payment": false,
        "case_id": null
      }
    }
  ],
  "next_cursor": null
}

Autenticação

Authorization: Bearer <sua chave de API>

Escopo exigido: webhooks:read. Veja Chaves de API.

Parâmetros de consulta

typestring

Filtra pelo tipo de evento (ex.: charge.paid).

até 60 caracteres

cursorstring

Cursor devolvido em next_cursor da página anterior.

até 2000 caracteres

limitinteiro

Itens por página.

de 1 a 200

Resposta 200

itemslista de objetos

Itens da página.

items[].idstring

Identificador do evento (evt_...). É o mesmo em todas as tentativas de entrega: use-o para não processar duas vezes.

items[].typestring

Tipo do evento (ex.: charge.paid).

items[].versionstring

Versão do formato do evento (v1).

items[].environmentstring

Ambiente: production (sandbox está reservado para o ambiente de testes, em preparação).

Valores: sandbox, production

items[].object_typestring ou null

Tipo do objeto do evento (ex.: charge).

items[].object_idstring ou null

Identificador do objeto.

items[].created_atstring (data e hora)

Momento do fato.

items[].dataobjeto

Dados do evento. O formato de cada tipo está em Eventos e payloads.

next_cursorstring ou null

Cursor da próxima página; null quando não há mais itens.

Erros

StatusCódigoQuando
401unauthorizedChave ausente, inválida, revogada ou expirada.
403forbiddenA chave não tem o escopo exigido (details.reason = "missing_scope").
422validation_errorParâmetro inválido (details.fields indica qual).
429rate_limitedLimite de requisições excedido. Aguarde o tempo de Retry-After.
500internal_errorFalha inesperada. Repita com a mesma Idempotency-Key; persistindo, envie o correlation_id à Koku (veja Suporte).

Formato do corpo de erro em Erros.