Reference
Webhooks
Webhooks can be configured under the developers section on the admin system. This section describes what you can expect to receive from these fired webhooks.
Response Body
The response body will be in this format:
{
"id": "web_F9BfxMPCHTfez6_Nrh5kB",
"type": "mandate.updated",
"status": true,
"results": [{
"id": "man_OAwfdynl8xuM0ZI4-L01W",
...
}, ...],
"webhook_event_lookups_id": "loo_2fqDMKi80PisazctZFXTq",
"created_at": "2025-10-08T12:05:04.686Z"
}
Response Parameters
Field | Type | Description | Example |
---|---|---|---|
id | String(25) | ID of the webhook that was fired | web_F9BfxMPCHTfez6_Nrh5kB |
type | String(64) | Type of event that was fired | mandate.updated |
status | Boolean | When true, indicates that there were no server errors during the process. | true |
results | Array | The contents of this section will always match that of the relevant list API call. If your event type is 'mandate.updated' then results will be in this format, however if the event was 'bank_account.created' then the results will be in this format etc. | { "id": "man_...", ... }, ... |
webhook_event_lookups_id | String(25) | The lookups ID of the webhook event as denoted by 'type'. | loo_2fqDMKi80PisazctZFXTq |
created_at | Date(ISO) | Timestamp when the webhook was fired | 2025-10-08T12:05:04.686Z |
Events
These are all possible events:
payment.updated
payment.created
customer.created
customer.updated
bank_account.created
bank_account.updated
mandate.created
mandate.updated
transaction.created
transaction.updated
checkout.completed
checkout.expired
checkout.failed