Referência da API/Webhooks

Webhooks

Registre um endpoint e receba eventos assinados a cada mudança de estado de pagamentos, dispersões, depósitos e solicitações de pagamento. As entregas são repetidas com espera por 24 horas. Verifique Decaf-Signature como HMAC-SHA256 sobre o carimbo de tempo, um ponto e o corpo bruto; rejeite carimbos com mais de cinco minutos.

Eventos

Evento	Quando
payout.submitted	Funds committed and handed to the rail
payout.awaiting_claim	Claim link sent
payout.claimed	Recipient claimed and chose a method
payout.succeeded	Delivered
payout.failed	Final failure after retries
payout.refunded	Funds returned after a failed delivery
disbursement.awaiting_approval	Submitted for approval
disbursement.launched	Execution started
disbursement.completed	Every item final and succeeded
disbursement.completed_with_failures	Every item final, at least one failed
deposit.received	A bank or on-chain deposit credited your balance
payment_request.paid	A fixed-amount request was matched

Register a webhook endpoint

POST/webhooks

Deliveries retry with backoff for 24 hours. The secret is shown once. Verify Decaf-Signature as HMAC-SHA256 over t + . + raw_body; reject timestamps older than five minutes.

Campo	Tipo	obrigatório	Observações
url	string	obrigatório
events	array	obrigatório

Requisição

{
  "url": "https://example.com/decaf",
  "events": [
    "payout.*",
    "disbursement.*",
    "deposit.*"
  ]
}

Resposta 201

{
  "id": "wh_2c1d",
  "url": "https://example.com/decaf",
  "events": [
    "payout.*",
    "disbursement.*",
    "deposit.*"
  ],
  "secret": "whsec_9f3e..."
}

Exemplos: Register a webhook endpoint

curl -X POST https://sandbox.api.decaf.so/v1/webhooks \
  -H "Authorization: Bearer $DECAF_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/decaf","events":["payout.*","disbursement.*","deposit.*"]}'

List webhooks

GET/webhooks

Delete a webhook

DELETE/webhooks/{id}

Parâmetros

idpathstringobrigatório

Obtenha acesso

Construa contra o sandbox esta semana.

Conte-nos os corredores de que precisa e quem você paga. As chaves de sandbox são emitidas por uma pessoa.