Referencia de la API/Webhooks

Webhooks

Registra un endpoint y recibe eventos firmados por cada cambio de estado de pagos, dispersiones, depósitos y solicitudes de pago. Las entregas se reintentan con espera durante 24 horas. Verifica Decaf-Signature como HMAC-SHA256 sobre la marca de tiempo, un punto y el cuerpo sin procesar; rechaza marcas de más de cinco minutos.

Eventos

Evento	Cuándo
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	obligatorio	Notas
url	string	obligatorio
events	array	obligatorio

Solicitud

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

Respuesta 201

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

Ejemplos: 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

idpathstringobligatorio

Obtén acceso

Construye contra el sandbox esta semana.

Cuéntanos los corredores que necesitas y a quién pagas. Las claves de sandbox las emite una persona.