🚧
Upgrade to the latest version
These docs are for version 2023-12-01. We encourage you to upgrade to version 2024-10-16 to access new features. Please see the changelog for more information.

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	Deposit Status	Description
`deposit.processing`	`PROCESSING`	Triggered when a deposit is created and processing.
`deposit.succeeded`	`SUCCEEDED`	Triggered when a deposit has completed processing and the funds have been deposited into the merchant or platform's bank account.
`deposit.failed`	`FAILED`	Triggered when a deposit unsuccessfully attempts to process.
`deposit.in_review`	`IN_REVIEW`	Triggered when a deposit is flagged for risk review.