Retrieve your deposits
The Deposits API API enables you to retrieve transaction details for deposits settled into your Wallet via direct debits from Linked Accounts and bank transfers to Global Accounts.
If you are retrieving a direct debit deposit, you can subscribe to Deposit webhook events to receive any deposit status transitions. See Direct debit deposit statuses for more information.
Depending on the Global Account financial institution & payment method, the availability of deposit details (eg. payer name, payer bank account number etc.) will vary.
Retrieve all deposits
You can retrieve deposits across all your Linked Accounts using Get a list of deposits API. Specify the time period (from_created_date, to_created_date) and the pagination parameters (page_num, page_size) to refine the results. If the time period is left unspecified or only the end date is specified, then deposits 30 days in arrears of today or the end date will be returned.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
Retrieve details of a deposit
If you want to retrieve details of a specific deposit, call Get a deposit by ID API by specifying the unique identifier for the deposit in the endpoint URL. You can retrieve the transaction_id from Get a list of deposits API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.