Retrieve your deposits

Copy for LLMView as Markdown

The Deposits APIAPI enables you to retrieve transaction details for deposits received into the Wallet via Airwallex Pay, direct debits from Linked Accounts and bank transfers to Global Accounts. You can also subscribe to Deposit webhook events to receive any deposit status transitions. See Airwallex Pay deposit statuses for more information.

Retrieve all deposits

You can retrieve all Airwallex Pay deposits using Get a list of depositsAPI. 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

Shell

1curl -G https://api.sandbox.airwallex.com/api/v1/deposits \
2  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
3  --data-urlencode 'from_created_at=2017-03-19' \
4  --data-urlencode 'page_num=0' \
5  --data-urlencode 'page_size=100' \
6  --data-urlencode 'to_created_at=2017-03-22T03:52:34+0000'

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

JSON

1{
2  "has_more": false,
3  "items": [
4    {
5      "amount": 1288.32,
6      "created_at": "2017-03-20T14:00:01+1100",
7      "currency": "AUD",
8      "fee": {
9        "amount": 0.81,
10        "currency": "AUD"
11      },
12      "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
13      "payer": {
14        "digital_wallet": {
15          "provider": "AIRWALLEX",
16          "account_name": "Hello LTD",
17          "id_type": "account_number",
18          "id_value": "9123456789012345"
19        }
20      },
21      "provider_transaction_id": "5487287789",
22      "reference": "ref1",
23      "status": "SETTLED",
24      "type": "DIGITAL_WALLET_TRANSFER"
25    },
26    {
27      "amount": 12794.27,
28      "created_at": "2017-03-20T14:00:01+1100",
29      "currency": "USD",
30      "fee": {
31        "amount": 1.28,
32        "currency": "USD"
33      },
34      "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
35      "payer": {
36        "digital_wallet": {
37          "provider": "AIRWALLEX",
38          "account_name": "Bello LTD",
39          "id_type": "account_number",
40          "id_value": "1234567890123456"
41        }
42      },
43      "provider_transaction_id": "5487287788",
44      "reference": "ref1",
45      "status": "SETTLED",
46      "type": "DIGITAL_WALLET_TRANSFER"
47    }
48  ]
49}

Retrieve details of a deposit

If you want to retrieve details of a specific deposit, call Get a deposit by IDAPI by specifying the unique identifier for the deposit in the endpoint URL. You can retrieve the transaction_id from Get a list of depositsAPI.

Example request

Shell

1curl -G https://api.sandbox.airwallex.com/api/v1/deposits/{{DEPOSIT_ID}} \
2  -H 'Authorization: Bearer {{ACCESS_TOKEN}}'

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

JSON

1{
2  "id": "67f687fe-dcf4-4462-92fa-20335301d9d8",
3  "type": "DIGITAL_WALLET_TRANSFER",
4  "status": "SETTLED",
5  "created_at": "2017-03-20T14:00:01+1100",
6  "currency": "USD",
7  "amount": 12794.27,
8  "fee": {
9 "amount": 1.28,
10 "currency": "USD"
11  },
12  "payer": {
13 "digital_wallet": {
14   "provider": "AIRWALLEX",
15   "account_name": "Bello LTD",
16   "id_type": "account_number",
17   "id_value": "1234567890123456"
18 }
19  },
20  "provider_transaction_id": "5487287788",
21  "reference": "ref1"
22}

Was this page helpful?