Voltar ao site
Webhooks

Liquidação fechada

Lote do dia inteiro SETTLED, uma vez por lote; data.object = Settlement sem items (abre em GET /v1/settlements/{id}). Linha que chega depois do fechamento não gera novo evento.

Escopo de leitura exigido do cliente dono do endpoint: receivables:settlements:read.

Entrega: POST na url do endpoint com Content-Type: application/json; charset=utf-8, corpo de até 256 KB, TLS 1.2+, sem seguir redirect, IP validado contra SSRF a cada tentativa. Verificar a assinatura sobre os bytes crus (nunca sobre JSON re-serializado). Entrega duplicada é esperada e a ordem não é garantida: deduplicar por id.

Header Parameters

X-Kodano-Signature*string

t=<unix em segundos>,v1=<hex>; durante a rotação, t=<unix>,v1=<novo>,v1=<anterior>. v1 = hex minúsculo de HMAC-SHA256(chave = bytes UTF-8 do segredo inteiro, inclusive whsec_; mensagem = "{t}." + bytes crus do corpo). Rejeitar |agora − t| > 300 s, comparar em tempo constante e aceitar se qualquer v1 conferir.

X-Kodano-Event-Id*string

Igual ao id do corpo; chave de deduplicação.

Match^evt_
X-Kodano-Event-Type*string

Igual ao type do corpo.

Value in"payment.succeeded""payment.failed""payment.refunded""chargeback.received""withdrawal.completed""withdrawal.failed""fx.operation.settled""fx.operation.expired""fx.operation.failed""fx.operation.action_required""fx.operation.refunded""settlement.closed""webhook_endpoint.disabled""ping"
User-Agent*string

Kodano-Webhooks/1.0.

Request Body

application/json
  1. body

Envelope: corpo assinado do webhook, item de GET /v1/events e resposta de GET /v1/events/{id}.

id*string

Igual ao header X-Kodano-Event-Id; chave de deduplicação.

Match^evt_
type*string
Value in"payment.succeeded""payment.failed""payment.refunded""chargeback.received""withdrawal.completed""withdrawal.failed""fx.operation.settled""fx.operation.expired""fx.operation.failed""fx.operation.action_required""fx.operation.refunded""settlement.closed""webhook_endpoint.disabled""ping"
apiVersion*string

2026-10-01.

createdAt*string
Formatdate-time
environment*string
Value in"sandbox""production"
merchantId*|

mrc_…; null em evento de organização.

data*

Response Body

Recebido. Sucesso é qualquer 2xx em até 10 s (DNS, TLS e resposta inclusos); o corpo da resposta é ignorado.

Example Requests
POST/settlement.closed
Request Bodyapplication/json
{  "id": "evt_<id do evento>",  "type": "settlement.closed",  "apiVersion": "2026-10-01",  "createdAt": "2026-10-16T06:00:00Z",  "environment": "sandbox",  "merchantId": "mrc_e3cc4727054da558273162251e310d29",  "data": {    "object": {      "id": "stl_2026101501a33e1fc42bb5898fe70dbb",      "status": "SETTLED",      "settlementDate": "2026-10-15",      "currency": "BRL",      "transactionCount": 4,      "grossAmount": 99000,      "feesAmount": 2871,      "netAmount": 96129,      "settledAt": "2026-10-15T00:00:00Z"    }  }}
Header Parameters
{  "X-Kodano-Signature": "t=1792155732,v1=d3e134866c73f1ace702a6dab8e1d8225c471951a3f88f395c987bc441b22962",  "X-Kodano-Event-Id": "string",  "X-Kodano-Event-Type": "payment.succeeded",  "User-Agent": "Kodano-Webhooks/1.0"}