On this page, you'll find information about:
You'll also learn about which webhook types are sent based on which event.
In general, the body of a webhook contains the following objects.
||Object||Object that contains information about the event.|
||String||The environment where the transaction was processed—test or live.|
||String||The webhook type.|
The information contained in the
data object varies and depends on the webhook type. You can find the full schema for each type in API Explorer.
Below is an example request body for a webhook of
Webhooks are typically sent when:
- A resource was created or updated.
- A request was initiated (such as a payment authorisation request, a refund request, or a funds transfer request).
- There was a fund movement (funds added to or deducted from balance accounts).
You can differentiate the events based on the
type. Some webhook types also include a
data.status field that informs you of the outcome of the event.
Configuration webhooks inform your system about events that occur with account holders, balance accounts, and payment instruments.
|balancePlatform.accountHolder.created||An account holder was successfully created.|
|balancePlatform.accountHolder.updated||An account holder was successfully updated.|
|balancePlatform.balanceAccount.created||A balance account was successfully created.|
|balancePlatform.accountHolder.updated||A balance account was successfully updated.|
|balancePlatform.paymentInstrument.created||A debit card was successfully created.|
|balancePlatform.paymentInstrument.updated||A debit card was successfully updated.|
|balancePlatform.balanceAccountSweep.created||A balance account sweep was successfully created.|
|balancePlatform.balanceAccountSweep.deleted||A balance account sweep was successfully deleted.|
|balancePlatform.balanceAccountSweep.updated||A balance account sweep was successfully updated.|
Payment method creation webhooks
Payment method creation webhooks inform your system about payment method setup requests.
|paymentMethod.created||A payment method creation request has been processed. The content informs you on the final state of the request.|
Transfer webhooks inform your system about incoming and outgoing transfers in your platform.
|balancePlatform.transfer.created||A transfer request was created to credit funds to or deduct funds from a balance account in your platform. The content informs you of the event that triggered the transfer request, such as a payment or refund.|
|balancePlatform.transfer.updated||A transfer request's status changed.|
Report webhooks inform your system when a report is generated and ready to be downloaded.
|balancePlatform.report.created||A report was generated and is ready to be downloaded.|
Payment webhooks (deprecated)
Payment webhooks are deprecated. Use the transfer webhooks instead.
|balancePlatform.incomingTransfer.created||There are funds that will be added to the balance account because of a pending refund or a fund transfer.
Possible statuses: PendingIncomingTransfer
|balancePlatform.incomingTransfer.updated||Funds were added to a balance account because of a refund or a funds transfer.
Possible values: Refunded, IncomingTransfer
|balancePlatform.outgoingTransfer.created||Funds were deducted from a balance account because of a payment capture or a funds transfer.
Possible statuses: Captured, OutgoingTransfer
|balancePlatform.outgoingTransfer.updated||There was an update after funds were deducted from a balance account. For example, the fund transfer to a transfer instrument failed.
Possible statuses: TransferConfirmed, TransferSentOut, or TransferFailed
|balancePlatform.payment.created||A payment authorisation, a refund, or a funds transfer has been initiated.
Possible statuses: Authorised, Refused, Error
|balancePlatform.payment.updated||A payment authorisation has expired or has been cancelled.
Possible statuses: Expired, Cancelled