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.

webhook ACCOUNT_CLOSED
Account closed
webhook ACCOUNT_CREATED
Account created
webhook ACCOUNT_FUNDS_BELOW_THRESHOLD
Liable account's funds are below configured threshold
webhook ACCOUNT_HOLDER_CREATED
Account holder created
webhook ACCOUNT_HOLDER_PAYOUT
Paid out to account holder
webhook ACCOUNT_HOLDER_STATUS_CHANGE
Account holder status changed
webhook ACCOUNT_HOLDER_STORE_STATUS_CHANGE
Store status changed
webhook ACCOUNT_HOLDER_UPCOMING_DEADLINE
Upcoming deadline
webhook ACCOUNT_HOLDER_UPDATED
Account holder updated
webhook ACCOUNT_HOLDER_VERIFICATION
Verification results received
webhook ACCOUNT_UPDATED
Account updated
webhook BENEFICIARY_SETUP
Beneficiary defined
webhook COMPENSATE_NEGATIVE_BALANCE
Negative account balances compensated
webhook DIRECT_DEBIT_INITIATED
Automated direct debit initiated
webhook PAYMENT_FAILURE
Booking for a capture or refund failed
webhook REFUND_FUNDS_TRANSFER
Funds transfer between accounts refunded
webhook REPORT_AVAILABLE
Report available
webhook SCHEDULED_REFUNDS
'Refund Transfers Not Paid Out' call processed and refunds scheduled
webhook TRANSFER_FUNDS
Funds transferred between accounts