Skip to content
HitchPay API Docs

Webhooks

Global Payment Status Update

HitchPay sends this payload when a global collection succeeds or fails.

Headers

Header Description
x-hitchpay-signature HMAC SHA256 signature — verify before processing

Payload — Collection Succeeded

{
  "event": "crossborder.collection.success",
  "data": {
    "reference": "HTCCBEF4EC275285",
    "external_reference": "REF7292901912",
    "status": "successful",
    "amount": 5000,
    "currency": "KES",
    "account_type": "bank",
    "customer_uuid": "dda04ec3-3774-4750-ae7b-0c070e8d084b",
    "failure_reason": null
  },
  "sent_at": "2026-03-16T12:30:00.000Z"
}

Payload — Collection Failed

{
  "event": "crossborder.collection.failed",
  "data": {
    "reference": "HTCCBEF4EC275285",
    "external_reference": "REF7292901912",
    "status": "failed",
    "amount": 5000,
    "currency": "KES",
    "account_type": "bank",
    "customer_uuid": "dda04ec3-3774-4750-ae7b-0c070e8d084b",
    "failure_reason": "Payment prompt expired"
  },
  "sent_at": "2026-03-16T12:35:00.000Z"
}

Expected Response

{ "status": "ok" }

See Webhook Overview for signature verification and deduplication guidance.

Questions? Email [email protected]. Also on GitBook.