Retrieve your deposits
The Deposits API API enables you to retrieve transaction details for deposits received into the Wallet via bank transfers to Global Accounts and direct debits from Linked Accounts.
If you are retrieving a bank transfer deposit, you can subscribe to Deposit webhook events to receive any deposit status transitions. See Bank transfer 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 Global 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.
Example response
Conditional details under "bank_account" object
For a bank transfer deposit, the payer's details may vary depending on factors such as the country and transfer method (Local Clearing System or SWIFT) of the deposit received. Consequently, different objects under the bank_account section will include payer bank account details parsed from the available data.
The table below summarizes each possible conditional nested object under bank_account in the Get a deposit by ID API & Get a list of deposits API responses.
Conditional nested object under bank_account * | Description |
|---|---|
Country-specific objects (i.e au_bsb, cn_cnaps_code, gb_sort_code, etc.) | Country-specific routing code and account number for a deposit received via local clearing system |
iban | IBAN information on this deposit received via local clearing system (e.g. SEPA) and SWIFT |
swift_code | SWIFT code and account number information on this deposit received via local clearing system and SWIFT |
partial | Only partial bank account information is available on this deposit |
* The nested objects are mutually exclusive