Log inGet started
Airwallex logo
Home
Online Payments
Treasury
Transactional FX
Payouts
Issuing
Scale
Open Banking
Developer Tools
API Reference
Home
Treasury
Overview
Introduction to TreasurySupported currencies and payments
Get started
Receive funds into your WalletRetrieve your deposits
Authorize direct debit payoutsRetrieve your direct debit payouts
Getting Started

Retrieve your deposits

The Deposits API allows you to retrieve deposits made into your Airwallex Wallet, either via bank transfers into Global Accounts or direct debits from Linked Accounts.

Retrieve all deposits

You can retrieve deposits across all your Global Accounts and 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

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/deposits?from_created_at=2017-04-01&page_num=0&page_size=100&to_created_at=2017-04-01T03%3A52%3A34%2B0000' \
--header 'Authorization: Bearer <your_bearer_token>'

Example response

{
  "has_more": false,
  "items": [
    {
      "amount": 12794.27,
      "created_at": "2017-03-20T14:00:01+1100",
      "currency": "USD",
      "deposit_id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
      "payer_name": "tester",
      "source": {
        "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8",
        "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f",
        "type": "AU_BECS_DEBIT"
      },
      "statement_ref": "5487287788",
      "status": "SETTLED",
      "type": "BANK_TRANSFER"
    }
  ]
}

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

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/deposits/<deposit_id>' \
--header 'Authorization: Bearer <your_bearer_token>'

Example response

{
  "amount": 12794.27,
  "created_at": "2017-03-20T14:00:01+1100",
  "currency": "USD",
  "deposit_id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
  "payer_name": "tester",
  "source": {
    "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8",
    "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f",
    "type": "AU_BECS_DEBIT"
  },
  "statement_ref": "5487287788",
  "status": "SETTLED",
  "type": "BANK_TRANSFER"
}
On this page
  • Retrieve all deposits
  • Retrieve details of a deposit