These docs are for v2023-01-01. Click to read the latest docs for v2024-10-16.

Understanding deposits

❗️

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.

Deposit

A deposit is the movement of funds to or from a Merchant.

Deposit status

The deposit status is the descriptor of the current status in the life cycle of the deposit.

StatusDescription
PROCESSINGDeposit is processing and funds have been initiated.
SUCCEEDEDDeposit has completed processing and the funds have moved.
FAILEDDeposit unsuccessfully attempted to process.
IN_REVIEW`Deposit has been flagged for risk review.