Docs
Acessar painel

Webhooks

Listar tipos de evento

GEThttps://api.kokupay.com/v1/webhooks/event-types

Devolve a versão do formato dos eventos, os tipos disponíveis e como a assinatura é calculada.

GET/v1/webhooks/event-types
curl -X GET 'https://api.kokupay.com/v1/webhooks/event-types' \
  -H "Authorization: Bearer $KOKU_API_KEY"
200Resposta
{
  "version": "v1",
  "event_types": [
    "charge.pending",
    "charge.paid",
    "charge.expired",
    "charge.failed",
    "charge.refunded",
    "charge.duplicate_payment",
    "payout.created",
    "payout.approved",
    "payout.rejected",
    "payout.paid",
    "payout.failed",
    "payout.channel_changed",
    "case.opened",
    "case.resolved",
    "reserve.released",
    "balance.available",
    "pricing.policy_published",
    "reserve.policy_published"
  ],
  "signature": {
    "header": "x-koku-signature",
    "scheme": "t=<unix>,v1=HMAC-SHA256(segredo, \"<t>.<corpo>\")",
    "extra_headers": [
      "x-koku-event-id",
      "x-koku-event-type",
      "x-koku-event-version"
    ]
  }
}

Autenticação

Authorization: Bearer <sua chave de API>

Qualquer chave válida (nenhum escopo específico). Veja Chaves de API.

Resposta 200

versionstring

Versão do formato dos eventos.

event_typeslista de string

Tipos de evento disponíveis.

signatureobjeto

Como a assinatura é enviada.

signature.headerstring

Cabeçalho com a assinatura.

signature.schemestring

Formato e cálculo da assinatura.

signature.extra_headerslista de string

Outros cabeçalhos enviados em cada entrega.

Erros

StatusCódigoQuando
401unauthorizedChave ausente, inválida, revogada ou expirada.
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.