Guides

Webhooks

Klustar POSTs JSON notifications to your notifyUrl when a payin completes. Respond with HTTP 200.

Delivery

Up to 5 attempts at 2-minute intervals. Register a URL in Dashboard → Settings → API or pass notifyUrl on each payin.

Payload

Payin webhook
{
  "reference": "REF-a1b2c3d4e5",
  "merchantId": "00000000-0000-4000-8000-000000000001",
  "currency": "NGN",
  "amount": 2000.00,
  "fee": 20.00,
  "vat": 7.50,
  "status": "successful",
  "gatewayReference": "100033240509135230000500932911",
  "completeTime": 1658574095184,
  "sign": "…"
}

Your handler

  • Respond quickly with HTTP 200
  • Treat deliveries as at-least-once — make handlers idempotent on reference
  • Verify the sign field when available before updating orders