Register Webhook
Register a URL that we will call when money arrives in any of your collection accounts.
Requirements for your webhook endpoint:
- Must be HTTPS (not HTTP)
- Must return
200 OKwithin 30 seconds of receiving the notification - We test-ping your URL during registration, if it does not respond, registration fails
- Must verify the
X-Signatureheader on incoming webhooks (for security)
Retry behaviour: If your endpoint returns anything other than 200, we retry
with exponential backoff: 5s, 30s, 5min, 30min, 2h, 6h, 24h.
Authorizations
Your API key, formatted as: ApiKey ubn_sb_your_key_here
- Sandbox keys start with
ubn_sb_ - Production keys start with
ubn_pk_ - Never use production keys during testing, they will charge real money
Headers
A UUID v4 you generate to trace this request through our systems. If you don't provide one, we generate it for you. Always include it in support requests, it helps us find your request in logs.
"7f3a9c21-4e8b-4a12-b6d1-3c8a7f2e1b09"
Body
Your HTTPS endpoint. We will POST collection notifications here.
Must respond with 200 OK within 30 seconds.
"https://yourapp.com/webhooks/ubn"
Which events to receive:
collection.credit: Money arrived in a collection accountcollection.reversal: A credit was reversedcollection.dispute: A dispute was opened on a transaction
collection.credit, collection.reversal, collection.dispute Response
Webhook registered. Test ping succeeded.
Standard response wrapper for all successful API calls

