Deposits

You can receive funds into your Airwallex Wallet via bank transfers to Global Accounts or direct debits from Linked Accounts.

The Global Accounts deposit simulation API allows you to simulate a deposit from an external bank account in the sandbox environment.

The Direct Debit deposit simulation APIs allow you to transition Direct Debit deposit statuses in the sandbox environment.

Endpoints

POST /api/v1/simulation/deposit/create
POST /api/v1/simulation/deposits/{deposit_id}/reject
POST /api/v1/simulation/deposits/{deposit_id}/reverse
POST /api/v1/simulation/deposits/{deposit_id}/settle

Create a global account deposit

POST /api/v1/simulation/deposit/create

Copy for LLMView as Markdown

You can use this endpoint to simulate deposits into your global account. This is only available in the sandbox environment.

Request body

amountrequirednumber

Amount to deposit into global account.

global_account_idrequiredstring

Global account unique identifier.

payer_banknamestring

Name of the bank that the deposit is made from.

payer_countrystring

Payer country code of the transaction (2-letter ISO 3166-2 country code).

AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, UNDEFINED, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XK, XU, YE, YT, YU, ZA, ZM, ZR, ZW

payer_namestring

Name of the payer making the deposit.

referencestring

Description of the deposit.

statement_refstring

Custom statement reference for this deposit. If a statement reference is provided, please note that it needs to be unique.

statusstring

Target next_status of this deposit. Default value is SETTLED. Can be one of: PENDING, SETTLED, REJECTED

Response body - 201 Created

amountnumber

Amount of the transaction in transaction currency

create_timestring

The time of the transaction created

currencystring

Currency of the transaction (3-letter ISO-4217 code)

deposit_typestring

Type of the transaction, can be one of: DEBIT, CREDIT

fee_amountnumber

Fee amount of the transaction in transaction currency

fee_currencyobject

Fee currency of the transaction (3-letter ISO-4217 code)

fee_currency.currency_codestring

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RUR, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UNDEFINED, USD, USN, USS, UYI, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

fee_currency.precisioninteger

fee_currency.valuestring

idstring

Unique id of the transaction

payer_countrystring

Payer country code of the transaction (2-letter ISO 3166-2 country code)

payer_namestring

Payer name of the transaction

referencestring

Description of the transaction

statement_refstring

The statement reference of this deposit.

statusstring

Status of the transaction, can be one of: PENDING, SETTLED, REJECTED

Errors

Error status	Description
400	invalid_argument
401	credentials_invalid
500	service_unavailable

POST /api/v1/simulation/deposit/create

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/api/v1/simulation/deposit/create' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json' \
>  --data '{
>  "amount": 1000,
>  "global_account_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",
>  "payer_bankname": "<string>",
>  "payer_country": "AC",
>  "payer_name": "1000",
>  "reference": "<string>",
>  "statement_ref": "5487287788",
>  "status": "SETTLED"
>}'

Response (201 Created)

1{
2  "amount": 10000,
3  "create_time": "2017-03-22T16:08:02+1100",
4  "currency": "AUD",
5  "deposit_type": "CREDIT",
6  "fee_amount": 10,
7  "fee_currency": {
8    "currency_code": "AED",
9    "precision": 0,
10    "value": "<string>"
11  },
12  "id": "90b98dc6-63a0-403f-816b-ac5305b42a11",
13  "payer_country": "US",
14  "payer_name": "AMZNnt70paD1",
15  "reference": "<string>",
16  "statement_ref": "5487287788",
17  "status": "PENDING"
18}

Was this section helpful?

Reject a direct debit deposit

POST /api/v1/simulation/deposits/{deposit_id}/reject

Copy for LLMView as Markdown

Rejects a pending deposit by transitioning the direct debit deposit status from PENDING to REJECTED.

Parameters

deposit_idrequiredstring

Unique identifier of the direct debit deposit.

Response body - 200 OK

Errors

Error status	Description
400	invalid_argument
401	credentials_invalid
404	not_found
500	service_unavailable

POST /api/v1/simulation/deposits/{deposit_id}/reject

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/api/v1/simulation/deposits/deposit_id/reject' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1false

Was this section helpful?

Reverse a direct debit deposit

POST /api/v1/simulation/deposits/{deposit_id}/reverse

Copy for LLMView as Markdown

Creates a new direct debit deposit in the SETTLED state with an amount that offsets the original amount, i.e. negative value, and also deactivates the Linked Account. The original direct debit deposit will remain in the SETTLED state.

Parameters

deposit_idrequiredstring

Unique identifier of the direct debit deposit.

Response body - 200 OK

Errors

Error status	Description
400	invalid_argument
401	credentials_invalid
404	not_found
500	service_unavailable

POST /api/v1/simulation/deposits/{deposit_id}/reverse

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/api/v1/simulation/deposits/deposit_id/reverse' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1false

Was this section helpful?

Settle a direct debit deposit

POST /api/v1/simulation/deposits/{deposit_id}/settle

Copy for LLMView as Markdown

Settles a pending deposit by transitioning the direct debit deposit status from PENDING to SETTLED.

Parameters

deposit_idrequiredstring

Unique identifier of the direct debit deposit.

Response body - 200 OK

Errors

Error status	Description
400	invalid_argument
401	credentials_invalid
404	not_found
500	service_unavailable

POST /api/v1/simulation/deposits/{deposit_id}/settle

$curl --request POST \
>  --url 'https://api-demo.airwallex.com/api/v1/simulation/deposits/deposit_id/settle' \
>  --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
>  --header 'Content-Type: application/json'

Response (200 OK)

1false

Was this section helpful?