Classic Platforms - Notifications

This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead.

The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.

For more information, refer to our documentation.

webhookACCOUNT_CLOSED
Account closed
webhookACCOUNT_CREATED
Account created
webhookACCOUNT_FUNDS_BELOW_THRESHOLD
Liable account's funds are below configured threshold
webhookACCOUNT_HOLDER_CREATED
Account holder created
webhookACCOUNT_HOLDER_PAYOUT
Paid out to account holder
webhookACCOUNT_HOLDER_STATUS_CHANGE
Account holder status changed
webhookACCOUNT_HOLDER_STORE_STATUS_CHANGE
Store status changed
webhookACCOUNT_HOLDER_UPCOMING_DEADLINE
Upcoming deadline
webhookACCOUNT_HOLDER_UPDATED
Account holder updated
webhookACCOUNT_HOLDER_VERIFICATION
Verification results received
webhookACCOUNT_UPDATED
Account updated
webhookBENEFICIARY_SETUP
Beneficiary defined
webhookCOMPENSATE_NEGATIVE_BALANCE
Negative account balances compensated
webhookDIRECT_DEBIT_INITIATED
Automated direct debit initiated
webhookPAYMENT_FAILURE
Booking for a capture or refund failed
webhookREFUND_FUNDS_TRANSFER
Funds transfer between accounts refunded
webhookREPORT_AVAILABLE
Report available
webhookSCHEDULED_REFUNDS
'Refund Transfers Not Paid Out' call processed and refunds scheduled
webhookTRANSFER_FUNDS
Funds transferred between accounts