Deposit webhooks
API version 2023-01-01 deprecating
This version will be deprecated on May 1, 2025. If your platform is on this version, you should upgrade to at least 2023-12-01 to simplify authorization and access new features.
Deposits
Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a deposit.
Deposit webhook payload
The webhook payload data field represents all deposit detail fields returned by the get deposit endpoint.
Deposit events
| Event | Description |
|---|---|
deposit.processing | Triggered when a deposit is created and processing. The deposit status is PROCESSING. |
deposit.succeeded | Triggered when a deposit has completed processing and the funds have been deposited into the merchant or platform's bank account. The deposit status is SUCCEEDED. |
deposit.failed | Triggered when a deposit unsuccessfully attempts to process. The deposit status is FAILED. |
deposit.in_review | Triggered when a deposit is flagged for risk review. The deposit status is IN_REVIEW. |
Updated 6 months ago