Webhooks
Listar tipos de evento
GET
https://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"const response = await fetch('https://api.kokupay.com/v1/webhooks/event-types', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.KOKU_API_KEY}`,
},
});
const data = await response.json();
console.log(response.status, data);import os
import requests
response = requests.request(
"GET",
"https://api.kokupay.com/v1/webhooks/event-types",
headers={
"Authorization": f"Bearer {os.environ['KOKU_API_KEY']}",
},
timeout=30,
)
print(response.status_code, response.json())<?php
$ch = curl_init('https://api.kokupay.com/v1/webhooks/event-types');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('KOKU_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
echo $status, PHP_EOL;
print_r($data);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
versionstringVersão do formato dos eventos.
event_typeslista de stringTipos de evento disponíveis.
signatureobjetoComo a assinatura é enviada.
signature.headerstringCabeçalho com a assinatura.
signature.schemestringFormato e cálculo da assinatura.
signature.extra_headerslista de stringOutros cabeçalhos enviados em cada entrega.
Erros
| Status | Código | Quando |
|---|---|---|
| 401 | unauthorized | Chave ausente, inválida, revogada ou expirada. |
| 429 | rate_limited | Limite de requisições excedido. Aguarde o tempo de Retry-After. |
| 500 | internal_error | Falha inesperada. Repita com a mesma Idempotency-Key; persistindo, envie o correlation_id à Koku (veja Suporte). |
Formato do corpo de erro em Erros.