Linked Accounts
Linked Accounts are external financial accounts associated with your Airwallex account. You can use Linked Accounts to fund your Airwallex wallet via Direct Debit.
GET /api/v1/linked_accountsGET /api/v1/linked_accounts/{id}POST /api/v1/linked_accounts/authPOST /api/v1/linked_accounts/createPOST /api/v1/linked_accounts/{id}/authPOST /api/v1/linked_accounts/{id}/complete_authPOST /api/v1/linked_accounts/{id}/verify_microdepositsGET /api/v1/linked_accounts/{id}/mandatePOST /api/v1/linked_accounts/{id}/mandateGET /api/v1/linked_accounts/{id}/balancesPOST /api/v1/linked_accounts/{id}/suspendPOST /api/v1/linked_accounts/{id}/confirm
Get a list of linked accounts
GET /api/v1/linked_accounts
Returns a list of Linked Accounts associated with a specific Airwallex account.
The country where your Linked Account is located
The start date of created_at in ISO8601 format (inclusive). If null, response will provide Linked Accounts created in the past 31 days.
Page number, starts from 0
Number of results per page. Default value is 100
The status of the Linked Account. One of REQUIRES_ACTION, PROCESSING, SUCCEEDED, FAILED, SUSPENDED
The end date of created_at in ISO8601 format (inclusive). If null, response will provide Linked Accounts created in the past 31 days.
A flag which identifies whether there are more results.
Paged results.
A unique identifier of this Linked Account.
The status of the Linked Account.
REQUIRES_ACTION, PROCESSING, SUCCEEDED, FAILED, SUSPENDED
A list of currencies supported by this Linked Account.
Type of Linked Account.
AU_BANK, NZ_BANK, US_BANK, GB_BANK, EU_BANK, HK_BANK, SG_BANK, CA_BANK, AU_PAYID
Australia bank information.
Name of the external bank account owner.
External bank account number.
BSB code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID information.
Identifier of PayID.
EMAIL_ADDRESS, PHONE_NUMBER, ABN, ACN, ARBN, ARSN, ORGANISATION_IDENTIFIER
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID.
Canada bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
Institution number
Branch transit number
Capabilities of the Linked Account.
Whether the Linked Account supports balance checking.
Whether the Linked Account supports direct debit deposit.
Europe bank information.
Name of the external bank account owner.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
International Bank Account Number.
SWIFT code.
Empty unless the Linked Account is in a failure status (REQUIRES_ACTION, FAILED).
Error code.
Error code ISO 20022 .
A set of original information received from the local clearing system.
The original error code received from the local clearing system.
The local clearing system that reported the failure.
The original error message received from the local clearing system.
Great Britain bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Sort code.
Hong Kong bank information.
Name of the external bank account owner.
External bank account number.
Bank code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Details of the next action to be taken to activate the Linked Account. For all statuses other than REQUIRES_ACTION, will return as null.
Number of microdeposits sent to the linked bank account.
Remaining attempts you have to enter the correct microdeposit amount. When this becomes 0, account status will update to FAILED.
Type of action to be taken.
verify_micro_deposits, confirm_account, auth, update_mandate, external_authorize, external_unsuspend_mandate
The verification type that should be taken to refresh the Linked Account authentication.
PLAID, TRUELAYER, EGIRO, BASIQ
The unique identifier of the candidate account.
Two-letter ISO 3166-2 country code.
UNDEFINED, 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, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW
Three-letter ISO 4217 currency code.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
The financial institution name of the candidate account.
International Bank Account Number.
The name of the candidate account.
The number of the candidate account.
Sort code.
The verification type for your external account.
PLAID, TRUELAYER, EGIRO, BASIQ
New Zealand bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Bank code.
Branch code.
Explanation for the status of the Linked Account. If there are no additional details, we will return null.
Singapore bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
SWIFT code.
United States bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
External bank account type.
CHECKING, SAVINGS
ACH routing number.
FEDWIRE routing number.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "au_bank": {6 "account_name": "Tester Smith",7 "account_number": "89098199202",8 "bsb": "063001",9 "currency": "AUD",10 "entity_type": "BUSINESS"11 },12 "au_payid": {13 "account_identifier_type": "EMAIL_ADDRESS",14 "currency": "AUD",15 "entity_type": "BUSINESS",16 "payid": "[email protected]"17 },18 "ca_bank": {19 "account_name": "Tester Smith",20 "account_number": "89098199202",21 "currency": "AUD",22 "entity_type": "BUSINESS",23 "institution_number": "010",24 "transit_number": "12345"25 },26 "capabilities": {27 "balance_check": true,28 "direct_debit_deposit": true29 },30 "eu_bank": {31 "account_name": "Tester Smith",32 "currency": "AUD",33 "entity_type": "BUSINESS",34 "iban": "DE372022080000903344401",35 "swift_code": "DBSSSGSG"36 },37 "failure_details": {38 "code": "other",39 "iso_code": "NARR",40 "provider_failure_details": {41 "code": "NARR",42 "local_clearing_system": "GB_FPS",43 "message": "Other reason"44 }45 },46 "gb_bank": {47 "account_name": "Tester Smith",48 "account_number": "89098199202",49 "currency": "AUD",50 "entity_type": "BUSINESS",51 "sort_code": "608382"52 },53 "hk_bank": {54 "account_name": "Tester Smith",55 "account_number": "89098199202",56 "bank_code": "003",57 "currency": "AUD",58 "entity_type": "BUSINESS"59 },60 "id": "114907b3-a708-483e-b97a-be3742905f6f",61 "next_action": {62 "candidate_accounts": [63 {64 "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface",65 "bank_country_code": "GB",66 "currency": "GBP",67 "entity_type": "BUSINESS",68 "financial_institution_name": "Bank of Scotland",69 "iban": "GB08CLRB04066800003435",70 "name": "Transaction account",71 "number": "82319424",72 "sort_code": "608382",73 "type": "TRUELAYER"74 }75 ],76 "micro_deposit_count": 2,77 "remaining_attempts": 3,78 "type": "verify_micro_deposits",79 "verification_type": "PLAID"80 },81 "nz_bank": {82 "account_name": "Tester Smith",83 "account_number": "89098199202",84 "bank_code": "03",85 "branch_code": "1234",86 "currency": "AUD",87 "entity_type": "BUSINESS"88 },89 "reason": "VERIFICATION_FAILED",90 "sg_bank": {91 "account_name": "Tester Smith",92 "account_number": "89098199202",93 "currency": "AUD",94 "entity_type": "BUSINESS",95 "swift_code": "DBSSSGSG"96 },97 "status": "SUCCEEDED",98 "supported_currencies": [99 "AUD"100 ],101 "type": "AU_BANK",102 "us_bank": {103 "account_name": "Tester Smith",104 "account_number": "89098199202",105 "account_type": "CHECKING",106 "ach": "084106768",107 "currency": "AUD",108 "entity_type": "BUSINESS",109 "fedwire": "084106768"110 }111 }112 ]113}
Get a linked account by ID
GET /api/v1/linked_accounts/{id}
Retrieves details of a Linked Account using the given Linked Account unique identifier.
The unique identifier of the Linked Account to retrieve
Australia bank information.
Name of the external bank account owner.
External bank account number.
BSB code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID information.
Identifier of PayID.
EMAIL_ADDRESS, PHONE_NUMBER, ABN, ACN, ARBN, ARSN, ORGANISATION_IDENTIFIER
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID.
Canada bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
Institution number
Branch transit number
Capabilities of the Linked Account.
Whether the Linked Account supports balance checking.
Whether the Linked Account supports direct debit deposit.
Europe bank information.
Name of the external bank account owner.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
International Bank Account Number.
SWIFT code.
Empty unless the Linked Account is in a failure status (REQUIRES_ACTION, FAILED).
Error code.
Error code ISO 20022 .
A set of original information received from the local clearing system.
The original error code received from the local clearing system.
The local clearing system that reported the failure.
The original error message received from the local clearing system.
Great Britain bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Sort code.
Hong Kong bank information.
Name of the external bank account owner.
External bank account number.
Bank code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
A unique identifier of this Linked Account.
Details of the next action to be taken to activate the Linked Account. For all statuses other than REQUIRES_ACTION, will return as null.
Number of microdeposits sent to the linked bank account.
Remaining attempts you have to enter the correct microdeposit amount. When this becomes 0, account status will update to FAILED.
Type of action to be taken.
verify_micro_deposits, confirm_account, auth, update_mandate, external_authorize, external_unsuspend_mandate
The verification type that should be taken to refresh the Linked Account authentication.
PLAID, TRUELAYER, EGIRO, BASIQ
The unique identifier of the candidate account.
Two-letter ISO 3166-2 country code.
UNDEFINED, 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, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW
Three-letter ISO 4217 currency code.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
The financial institution name of the candidate account.
International Bank Account Number.
The name of the candidate account.
The number of the candidate account.
Sort code.
The verification type for your external account.
PLAID, TRUELAYER, EGIRO, BASIQ
New Zealand bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Bank code.
Branch code.
Explanation for the status of the Linked Account. If there are no additional details, we will return null.
Singapore bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
SWIFT code.
The status of the Linked Account.
REQUIRES_ACTION, PROCESSING, SUCCEEDED, FAILED, SUSPENDED
A list of currencies supported by this Linked Account.
Type of Linked Account.
AU_BANK, NZ_BANK, US_BANK, GB_BANK, EU_BANK, HK_BANK, SG_BANK, CA_BANK, AU_PAYID
United States bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
External bank account type.
CHECKING, SAVINGS
ACH routing number.
FEDWIRE routing number.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "au_bank": {3 "account_name": "Tester Smith",4 "account_number": "89098199202",5 "bsb": "063001",6 "currency": "AUD",7 "entity_type": "BUSINESS"8 },9 "au_payid": {10 "account_identifier_type": "EMAIL_ADDRESS",11 "currency": "AUD",12 "entity_type": "BUSINESS",13 "payid": "[email protected]"14 },15 "ca_bank": {16 "account_name": "Tester Smith",17 "account_number": "89098199202",18 "currency": "AUD",19 "entity_type": "BUSINESS",20 "institution_number": "010",21 "transit_number": "12345"22 },23 "capabilities": {24 "balance_check": true,25 "direct_debit_deposit": true26 },27 "eu_bank": {28 "account_name": "Tester Smith",29 "currency": "AUD",30 "entity_type": "BUSINESS",31 "iban": "DE372022080000903344401",32 "swift_code": "DBSSSGSG"33 },34 "failure_details": {35 "code": "other",36 "iso_code": "NARR",37 "provider_failure_details": {38 "code": "NARR",39 "local_clearing_system": "GB_FPS",40 "message": "Other reason"41 }42 },43 "gb_bank": {44 "account_name": "Tester Smith",45 "account_number": "89098199202",46 "currency": "AUD",47 "entity_type": "BUSINESS",48 "sort_code": "608382"49 },50 "hk_bank": {51 "account_name": "Tester Smith",52 "account_number": "89098199202",53 "bank_code": "003",54 "currency": "AUD",55 "entity_type": "BUSINESS"56 },57 "id": "114907b3-a708-483e-b97a-be3742905f6f",58 "next_action": {59 "candidate_accounts": [60 {61 "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface",62 "bank_country_code": "GB",63 "currency": "GBP",64 "entity_type": "BUSINESS",65 "financial_institution_name": "Bank of Scotland",66 "iban": "GB08CLRB04066800003435",67 "name": "Transaction account",68 "number": "82319424",69 "sort_code": "608382",70 "type": "TRUELAYER"71 }72 ],73 "micro_deposit_count": 2,74 "remaining_attempts": 3,75 "type": "verify_micro_deposits",76 "verification_type": "PLAID"77 },78 "nz_bank": {79 "account_name": "Tester Smith",80 "account_number": "89098199202",81 "bank_code": "03",82 "branch_code": "1234",83 "currency": "AUD",84 "entity_type": "BUSINESS"85 },86 "reason": "VERIFICATION_FAILED",87 "sg_bank": {88 "account_name": "Tester Smith",89 "account_number": "89098199202",90 "currency": "AUD",91 "entity_type": "BUSINESS",92 "swift_code": "DBSSSGSG"93 },94 "status": "SUCCEEDED",95 "supported_currencies": [96 "AUD"97 ],98 "type": "AU_BANK",99 "us_bank": {100 "account_name": "Tester Smith",101 "account_number": "89098199202",102 "account_type": "CHECKING",103 "ach": "084106768",104 "currency": "AUD",105 "entity_type": "BUSINESS",106 "fedwire": "084106768"107 }108}
Generate a linked account authentication
POST /api/v1/linked_accounts/auth
Generates a Linked Account authentication. You will retrieve an authentication token with the specified Open Banking provider to verify the ownership of the external bank account, so that the external bank account owner may verify their access to the account.
Specify a verification type for your external bank account.
PLAID, TRUELAYER, EGIRO, BASIQ
Required information to generate a EGIRO authentication.
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
URL to receive authentication result and display the status.
Customer reference displayed in bank authorization item, with up to 25 characters.
SWIFT code.
Required information to generate a Plaid authentication.
The name of your business to be displayed in Plaid Modal. The maximum length of 30 characters. If a value longer than 30 characters is provided, Plaid Modal will display This Application instead.
Two-letter ISO 3166-2 country code.
The language that Plaid Modal should be displayed in. Two-letter ISO 639-1 language code. Default is en.
The name of the Link customization configured on the Plaid Dashboard. If not specified, the default customization will be applied.
URL to handle the Oauth verification flow.
Required information to generate a Truelayer authentication.
Two-letter ISO 3166-2 country code.
Unique identifier of the financial institution as provided by Truelayer here .
URL to handle the Oauth verification flow.
Required information to proceed with EGIRO authentication.
The EGIRO Auth Link to authorize.
Required information to proceed with Plaid authentication.
The expiration time of the Link Token in ISO8601 format.
The Plaid Link Token to open a Plaid Modal.
Required information to proceed with Truelayer authentication.
The Truelayer Auth Link to authorize.
The type of verification that has been generated.
PLAID, TRUELAYER, EGIRO, BASIQ
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/auth' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "egiro": {> "entity_type": "BUSINESS",> "redirect_url": "https://www.airwallex.com",> "reference": "https://www.airwallex.com",> "swift_code": "DBSSSGSG"> },> "plaid": {> "client_name": "Airwallex",> "country_code": "US",> "language": "en",> "link_customization_name": "customized",> "redirect_url": "https://www.airwallex.com"> },> "truelayer": {> "country_code": "GB",> "provider_id": "ob-monzo",> "redirect_url": "https://www.airwallex.com"> },> "type": "PLAID">}'
1{2 "egiro": {3 "auth_url": "https://edda.dbs.com/api/v1/edda/authorize/creation?parameterKey=valule"4 },5 "plaid": {6 "expires_at": "2022-06-29T11:25:39+0000",7 "link_token": "link-sandbox-463f3464-287c-4a75-adf2-85bc07c2dd89"8 },9 "truelayer": {10 "auth_url": "https://auth.truelayer-sandbox.com?client_id=sandbox-airwallex-5c4af6&redirect_uri=https://www.airwallex.com&provider_id=ob-monzo&state=6781472155828238&response_type=code&scope=info%20accounts%20balance%20offline_access"11 },12 "type": "PLAID"13}
Create a linked account
POST /api/v1/linked_accounts/create
Links an external bank account to your Airwallex account. If you would like to use Open Banking as your verification method, please first call on the linked_accounts/auth endpoint to generate an authentication token.
Unique request identifier.
Type of Linked Account.
AU_BANK, NZ_BANK, US_BANK, GB_BANK, EU_BANK, HK_BANK, SG_BANK, CA_BANK, AU_PAYID
Specify an owner unique identifier if verification of the external bank account had already been completed on another Airwallex product. This value should be null unless explicitly agreed upon with your Account Manager.
Australia bank information.
Name of the external bank account owner.
External bank account number.
BSB code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID information.
Identifier of PayID.
EMAIL_ADDRESS, PHONE_NUMBER, ABN, ACN, ARBN, ARSN, ORGANISATION_IDENTIFIER
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID.
Canada bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
Institution number
Branch transit number
Required information to verify a Linked Account with EGIRO authentication, which could be parsed from the EGIRO redirect url.
The value is returned in the redirect url.
The value is returned in the redirect url.
Europe bank information.
Name of the external bank account owner.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
International Bank Account Number.
Great Britain bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Sort code.
Hong Kong bank information.
Name of the external bank account owner.
External bank account number.
Bank code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Details about the mandate for authorizing direct debits. Enter null if no mandate is signed.
Type of the source of your funds.
AU_BECS_DEBIT, US_ACH_DEBIT, US_FEDWIRE_DEBIT, GB_BACS_DEBIT, EU_SEPA_DEBIT, CA_EFT_DEBIT, HK_FPS_DEBIT, SG_EGIRO_DEBIT, AU_PAYTO_DEBIT, NZ_BECS_DEBIT
Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT.
FIXED
- Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required.
VARIABLE
- Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.
End date to expect to be paid from the Linked Account.
The fixed amount that may be paid from the Linked Account, per transaction.
Maximum amount that may be paid from the Linked Account, per transaction.
The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited.
The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH.
Specifies transaction frequency. One of DAY, WEEK, MONTH or YEAR.
Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate.
Identification document. Required if mandate type is HK_FPS_DEBIT
Id Type
HK_ID, PASSPORT, BUSINESS_REGISTRATION_NUMBER, CERTIFICATE_OF_INCORPORATION_NUMBER, OTHERS, NRIC, FIN, UEN
Id Value
Preferred reference for mandate. We use this value to generate a unique reference (that may be different from the initial value), then register in payment system.
Reference to the existing mandate in reuse mandate scenario. This value should be null unless explicitly agreed upon with your Account Manager.
Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate.
Version of the mandate signed. Required if you are not reusing mandate.
New Zealand bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Required information to verify a Linked Account with Plaid authentication, which could be parsed from the Plaid Modal onSuccess callback.
The bank account that was selected in the Plaid Modal.
Plaid’s unique identifier for the account.
The last 2-4 alphanumeric characters of an account's official account number.
The name of the account, either assigned by the user or by the financial institution itself.
The financial institution that was selected in the Plaid Modal.
The institution identifier assigned by Plaid.
The full financial institution name.
The Plaid Public Token.
Type of verification used to link your external account.
MICRO_DEPOSIT, PLATFORM_ENDORSEMENT, PLAID, TRUELAYER, EGIRO, MANDATE, BASIQ
Singapore bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
SWIFT code.
Required information to verify a Linked Account with Truelayer authentication, which could be parsed from the Truelayer onSuccess callback url.
The path parameter code retrieved from TrueLayer's callback url (redirect_url_host?code=code_value&state=state_value).
The path parameter state retrieved from TrueLayer's callback url (redirect_url_host?code=code_value&state=state_value).
United States bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
External bank account type.
CHECKING, SAVINGS
ACH routing number.
FEDWIRE routing number.
Australia bank information.
Name of the external bank account owner.
External bank account number.
BSB code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID information.
Identifier of PayID.
EMAIL_ADDRESS, PHONE_NUMBER, ABN, ACN, ARBN, ARSN, ORGANISATION_IDENTIFIER
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID.
Canada bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
Institution number
Branch transit number
Capabilities of the Linked Account.
Whether the Linked Account supports balance checking.
Whether the Linked Account supports direct debit deposit.
Europe bank information.
Name of the external bank account owner.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
International Bank Account Number.
SWIFT code.
Empty unless the Linked Account is in a failure status (REQUIRES_ACTION, FAILED).
Error code.
Error code ISO 20022 .
A set of original information received from the local clearing system.
The original error code received from the local clearing system.
The local clearing system that reported the failure.
The original error message received from the local clearing system.
Great Britain bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Sort code.
Hong Kong bank information.
Name of the external bank account owner.
External bank account number.
Bank code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
A unique identifier of this Linked Account.
Details of the next action to be taken to activate the Linked Account. For all statuses other than REQUIRES_ACTION, will return as null.
Number of microdeposits sent to the linked bank account.
Remaining attempts you have to enter the correct microdeposit amount. When this becomes 0, account status will update to FAILED.
Type of action to be taken.
verify_micro_deposits, confirm_account, auth, update_mandate, external_authorize, external_unsuspend_mandate
The verification type that should be taken to refresh the Linked Account authentication.
PLAID, TRUELAYER, EGIRO, BASIQ
The unique identifier of the candidate account.
Two-letter ISO 3166-2 country code.
UNDEFINED, 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, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW
Three-letter ISO 4217 currency code.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
The financial institution name of the candidate account.
International Bank Account Number.
The name of the candidate account.
The number of the candidate account.
Sort code.
The verification type for your external account.
PLAID, TRUELAYER, EGIRO, BASIQ
New Zealand bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Bank code.
Branch code.
Explanation for the status of the Linked Account. If there are no additional details, we will return null.
Singapore bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
SWIFT code.
The status of the Linked Account.
REQUIRES_ACTION, PROCESSING, SUCCEEDED, FAILED, SUSPENDED
A list of currencies supported by this Linked Account.
Type of Linked Account.
AU_BANK, NZ_BANK, US_BANK, GB_BANK, EU_BANK, HK_BANK, SG_BANK, CA_BANK, AU_PAYID
United States bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
External bank account type.
CHECKING, SAVINGS
ACH routing number.
FEDWIRE routing number.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "account_owner_identifier": "test_account_owner_id_1",> "au_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "bsb": "063001",> "currency": "AUD",> "entity_type": "BUSINESS"> },> "au_payid": {> "account_identifier_type": "EMAIL_ADDRESS",> "currency": "AUD",> "entity_type": "BUSINESS",> "payid": "[email protected]"> },> "ca_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "currency": "AUD",> "entity_type": "BUSINESS",> "institution_number": "010",> "transit_number": "12345"> },> "egiro": {> "auth_id": 7829116420292722,> "auth_reference": "BOAIR6561Z01AIR20240603071713069163"> },> "eu_bank": {> "account_name": "Tester Smith",> "currency": "AUD",> "entity_type": "BUSINESS",> "iban": "DE372022080000903344401"> },> "gb_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "currency": "AUD",> "entity_type": "BUSINESS",> "sort_code": "608382"> },> "hk_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "bank_code": "003",> "currency": "AUD",> "entity_type": "BUSINESS"> },> "mandate": {> "controls": {> "amount_type": "VARIABLE",> "end_date": "2025-12-31",> "fixed_amount_per_transaction": 1000,> "max_amount_per_transaction": 1000,> "schedule": {> "period": 3,> "period_unit": "MONTH"> }> },> "email": "[email protected]",> "identification_document": {> "type": "HK_ID",> "value": "A123456"> },> "preferred_reference": "AWX",> "reuse_mandate_reference": "AWX013",> "signatory": "Tester Smith",> "type": "AU_BECS_DEBIT",> "version": "1.1"> },> "nz_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "currency": "AUD",> "entity_type": "BUSINESS"> },> "plaid": {> "account": {> "id": "p4aN1gq5MwuAeVv47pkjh63l5K8gV6fJqKepE",> "mask": "0000",> "name": "Business Savings"> },> "institution": {> "id": "ins_3",> "name": "Chase"> },> "public_token": "public-sandbox-2a6878ca-0e6b-42cf-ba9b-490401bb5a93"> },> "preferred_verification_type": "MICRO_DEPOSIT",> "request_id": "test_unique_id",> "sg_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "currency": "AUD",> "entity_type": "BUSINESS",> "swift_code": "DBSSSGSG"> },> "truelayer": {> "code": "B2D8A5F9896AAA08E34DF3099649A1C249D562996D1416BCE76F66C372E56797",> "state": 6781472155828238> },> "type": "AU_BANK",> "us_bank": {> "account_name": "Tester Smith",> "account_number": "89098199202",> "account_type": "CHECKING",> "ach": "084106768",> "currency": "AUD",> "entity_type": "BUSINESS",> "fedwire": "084106768"> }>}'
1{2 "au_bank": {3 "account_name": "Tester Smith",4 "account_number": "89098199202",5 "bsb": "063001",6 "currency": "AUD",7 "entity_type": "BUSINESS"8 },9 "au_payid": {10 "account_identifier_type": "EMAIL_ADDRESS",11 "currency": "AUD",12 "entity_type": "BUSINESS",13 "payid": "[email protected]"14 },15 "ca_bank": {16 "account_name": "Tester Smith",17 "account_number": "89098199202",18 "currency": "AUD",19 "entity_type": "BUSINESS",20 "institution_number": "010",21 "transit_number": "12345"22 },23 "capabilities": {24 "balance_check": true,25 "direct_debit_deposit": true26 },27 "eu_bank": {28 "account_name": "Tester Smith",29 "currency": "AUD",30 "entity_type": "BUSINESS",31 "iban": "DE372022080000903344401",32 "swift_code": "DBSSSGSG"33 },34 "failure_details": {35 "code": "other",36 "iso_code": "NARR",37 "provider_failure_details": {38 "code": "NARR",39 "local_clearing_system": "GB_FPS",40 "message": "Other reason"41 }42 },43 "gb_bank": {44 "account_name": "Tester Smith",45 "account_number": "89098199202",46 "currency": "AUD",47 "entity_type": "BUSINESS",48 "sort_code": "608382"49 },50 "hk_bank": {51 "account_name": "Tester Smith",52 "account_number": "89098199202",53 "bank_code": "003",54 "currency": "AUD",55 "entity_type": "BUSINESS"56 },57 "id": "114907b3-a708-483e-b97a-be3742905f6f",58 "next_action": {59 "candidate_accounts": [60 {61 "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface",62 "bank_country_code": "GB",63 "currency": "GBP",64 "entity_type": "BUSINESS",65 "financial_institution_name": "Bank of Scotland",66 "iban": "GB08CLRB04066800003435",67 "name": "Transaction account",68 "number": "82319424",69 "sort_code": "608382",70 "type": "TRUELAYER"71 }72 ],73 "micro_deposit_count": 2,74 "remaining_attempts": 3,75 "type": "verify_micro_deposits",76 "verification_type": "PLAID"77 },78 "nz_bank": {79 "account_name": "Tester Smith",80 "account_number": "89098199202",81 "bank_code": "03",82 "branch_code": "1234",83 "currency": "AUD",84 "entity_type": "BUSINESS"85 },86 "reason": "VERIFICATION_FAILED",87 "sg_bank": {88 "account_name": "Tester Smith",89 "account_number": "89098199202",90 "currency": "AUD",91 "entity_type": "BUSINESS",92 "swift_code": "DBSSSGSG"93 },94 "status": "SUCCEEDED",95 "supported_currencies": [96 "AUD"97 ],98 "type": "AU_BANK",99 "us_bank": {100 "account_name": "Tester Smith",101 "account_number": "89098199202",102 "account_type": "CHECKING",103 "ach": "084106768",104 "currency": "AUD",105 "entity_type": "BUSINESS",106 "fedwire": "084106768"107 }108}
Refresh a linked account authentication
POST /api/v1/linked_accounts/{id}/auth
Refreshes a Linked Account authentication after it has expired. You can call /complete_auth in onSuccess callback from the Open Banking provider to inform Airwallex it has been completed. Otherwise, the Linked Account status will remain as REQUIRES_ACTION.
The unique identifier of the Linked Account to refresh authentication
Specify a verification type for your external bank account.
PLAID, TRUELAYER, EGIRO, BASIQ
Required information to generate a EGIRO authentication.
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
URL to receive authentication result and display the status.
Customer reference displayed in bank authorization item, with up to 25 characters.
SWIFT code.
Required information to generate a Plaid authentication.
The name of your business to be displayed in Plaid Modal. The maximum length of 30 characters. If a value longer than 30 characters is provided, Plaid Modal will display This Application instead.
Two-letter ISO 3166-2 country code.
The language that Plaid Modal should be displayed in. Two-letter ISO 639-1 language code. Default is en.
The name of the Link customization configured on the Plaid Dashboard. If not specified, the default customization will be applied.
URL to handle the Oauth verification flow.
Required information to generate a Truelayer authentication.
Two-letter ISO 3166-2 country code.
Unique identifier of the financial institution as provided by Truelayer here .
URL to handle the Oauth verification flow.
Required information to proceed with EGIRO authentication.
The EGIRO Auth Link to authorize.
Required information to proceed with Plaid authentication.
The expiration time of the Link Token in ISO8601 format.
The Plaid Link Token to open a Plaid Modal.
Required information to proceed with Truelayer authentication.
The Truelayer Auth Link to authorize.
The type of verification that has been generated.
PLAID, TRUELAYER, EGIRO, BASIQ
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/auth' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "egiro": {> "entity_type": "BUSINESS",> "redirect_url": "https://www.airwallex.com",> "reference": "https://www.airwallex.com",> "swift_code": "DBSSSGSG"> },> "plaid": {> "client_name": "Airwallex",> "country_code": "US",> "language": "en",> "link_customization_name": "customized",> "redirect_url": "https://www.airwallex.com"> },> "truelayer": {> "country_code": "GB",> "provider_id": "ob-monzo",> "redirect_url": "https://www.airwallex.com"> },> "type": "PLAID">}'
1{2 "egiro": {3 "auth_url": "https://edda.dbs.com/api/v1/edda/authorize/creation?parameterKey=valule"4 },5 "plaid": {6 "expires_at": "2022-06-29T11:25:39+0000",7 "link_token": "link-sandbox-463f3464-287c-4a75-adf2-85bc07c2dd89"8 },9 "truelayer": {10 "auth_url": "https://auth.truelayer-sandbox.com?client_id=sandbox-airwallex-5c4af6&redirect_uri=https://www.airwallex.com&provider_id=ob-monzo&state=6781472155828238&response_type=code&scope=info%20accounts%20balance%20offline_access"11 },12 "type": "PLAID"13}
Complete the authentication refresh
POST /api/v1/linked_accounts/{id}/complete_auth
Completes the authentication refresh. After the refresh authentication process is confirmed, the corresponding Linked Account status will become SUCCEEDED.
The unique identifier of the Linked Account to complete the auth refresh
The verification type that was used for your Linked Account.
PLAID, TRUELAYER, EGIRO, BASIQ
The path parameter auth_id retrieved from EGIRO's callback url (redirect_url_host?auth_id=value1&auth_reference=value2).
The path parameter auth_reference retrieved from EGIRO's callback url (redirect_url_host?auth_id=value1&auth_reference=value2).
The path parameter code retrieved from TrueLayer's callback url (redirect_url_host?code=code_value&state=state_value).
The path parameter state retrieved from TrueLayer's callback url (redirect_url_host?code=code_value&state=state_value).
OK
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/complete_auth' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "auth_id": "7829116420292722",> "auth_reference": "BOAIR6561Z01AIR20240603071713069163",> "code": "B2D8A5F9896AAA08E34DF3099649A1C249D562996D1416BCE76F66C372E56797",> "state": 6781472155828238,> "type": "PLAID">}'
Verify linked account with micro-deposits
POST /api/v1/linked_accounts/{id}/verify_microdeposits
Verifies your Linked Account using the micro-deposit amounts received in the Linked Account.
The unique identifier of the Linked Account to examine microdeposit
Amounts of the two microdeposits received in the Linked Account (order agnostic).
Australia bank information.
Name of the external bank account owner.
External bank account number.
BSB code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID information.
Identifier of PayID.
EMAIL_ADDRESS, PHONE_NUMBER, ABN, ACN, ARBN, ARSN, ORGANISATION_IDENTIFIER
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Australia NPP PayID.
Canada bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
Institution number
Branch transit number
Capabilities of the Linked Account.
Whether the Linked Account supports balance checking.
Whether the Linked Account supports direct debit deposit.
Europe bank information.
Name of the external bank account owner.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
International Bank Account Number.
SWIFT code.
Empty unless the Linked Account is in a failure status (REQUIRES_ACTION, FAILED).
Error code.
Error code ISO 20022 .
A set of original information received from the local clearing system.
The original error code received from the local clearing system.
The local clearing system that reported the failure.
The original error message received from the local clearing system.
Great Britain bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Sort code.
Hong Kong bank information.
Name of the external bank account owner.
External bank account number.
Bank code.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
A unique identifier of this Linked Account.
Details of the next action to be taken to activate the Linked Account. For all statuses other than REQUIRES_ACTION, will return as null.
Number of microdeposits sent to the linked bank account.
Remaining attempts you have to enter the correct microdeposit amount. When this becomes 0, account status will update to FAILED.
Type of action to be taken.
verify_micro_deposits, confirm_account, auth, update_mandate, external_authorize, external_unsuspend_mandate
The verification type that should be taken to refresh the Linked Account authentication.
PLAID, TRUELAYER, EGIRO, BASIQ
The unique identifier of the candidate account.
Two-letter ISO 3166-2 country code.
UNDEFINED, 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, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW
Three-letter ISO 4217 currency code.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
The financial institution name of the candidate account.
International Bank Account Number.
The name of the candidate account.
The number of the candidate account.
Sort code.
The verification type for your external account.
PLAID, TRUELAYER, EGIRO, BASIQ
New Zealand bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Bank code.
Branch code.
Explanation for the status of the Linked Account. If there are no additional details, we will return null.
Singapore bank information.
Name of the external bank account owner.
External bank account number.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
SWIFT code.
The status of the Linked Account.
REQUIRES_ACTION, PROCESSING, SUCCEEDED, FAILED, SUSPENDED
A list of currencies supported by this Linked Account.
Type of Linked Account.
AU_BANK, NZ_BANK, US_BANK, GB_BANK, EU_BANK, HK_BANK, SG_BANK, CA_BANK, AU_PAYID
United States bank information.
Currency of your bank account.
UNDEFINED, 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, 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
Type of entity which owns this external bank account.
BUSINESS, INDIVIDUAL
Name of the external bank account owner.
External bank account number.
External bank account type.
CHECKING, SAVINGS
ACH routing number.
FEDWIRE routing number.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/verify_microdeposits' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "amounts": [> 0.08,> 0.09> ]>}'
1{2 "au_bank": {3 "account_name": "Tester Smith",4 "account_number": "89098199202",5 "bsb": "063001",6 "currency": "AUD",7 "entity_type": "BUSINESS"8 },9 "au_payid": {10 "account_identifier_type": "EMAIL_ADDRESS",11 "currency": "AUD",12 "entity_type": "BUSINESS",13 "payid": "[email protected]"14 },15 "ca_bank": {16 "account_name": "Tester Smith",17 "account_number": "89098199202",18 "currency": "AUD",19 "entity_type": "BUSINESS",20 "institution_number": "010",21 "transit_number": "12345"22 },23 "capabilities": {24 "balance_check": true,25 "direct_debit_deposit": true26 },27 "eu_bank": {28 "account_name": "Tester Smith",29 "currency": "AUD",30 "entity_type": "BUSINESS",31 "iban": "DE372022080000903344401",32 "swift_code": "DBSSSGSG"33 },34 "failure_details": {35 "code": "other",36 "iso_code": "NARR",37 "provider_failure_details": {38 "code": "NARR",39 "local_clearing_system": "GB_FPS",40 "message": "Other reason"41 }42 },43 "gb_bank": {44 "account_name": "Tester Smith",45 "account_number": "89098199202",46 "currency": "AUD",47 "entity_type": "BUSINESS",48 "sort_code": "608382"49 },50 "hk_bank": {51 "account_name": "Tester Smith",52 "account_number": "89098199202",53 "bank_code": "003",54 "currency": "AUD",55 "entity_type": "BUSINESS"56 },57 "id": "114907b3-a708-483e-b97a-be3742905f6f",58 "next_action": {59 "candidate_accounts": [60 {61 "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface",62 "bank_country_code": "GB",63 "currency": "GBP",64 "entity_type": "BUSINESS",65 "financial_institution_name": "Bank of Scotland",66 "iban": "GB08CLRB04066800003435",67 "name": "Transaction account",68 "number": "82319424",69 "sort_code": "608382",70 "type": "TRUELAYER"71 }72 ],73 "micro_deposit_count": 2,74 "remaining_attempts": 3,75 "type": "verify_micro_deposits",76 "verification_type": "PLAID"77 },78 "nz_bank": {79 "account_name": "Tester Smith",80 "account_number": "89098199202",81 "bank_code": "03",82 "branch_code": "1234",83 "currency": "AUD",84 "entity_type": "BUSINESS"85 },86 "reason": "VERIFICATION_FAILED",87 "sg_bank": {88 "account_name": "Tester Smith",89 "account_number": "89098199202",90 "currency": "AUD",91 "entity_type": "BUSINESS",92 "swift_code": "DBSSSGSG"93 },94 "status": "SUCCEEDED",95 "supported_currencies": [96 "AUD"97 ],98 "type": "AU_BANK",99 "us_bank": {100 "account_name": "Tester Smith",101 "account_number": "89098199202",102 "account_type": "CHECKING",103 "ach": "084106768",104 "currency": "AUD",105 "entity_type": "BUSINESS",106 "fedwire": "084106768"107 }108}
Get a direct debit deposit mandate
GET /api/v1/linked_accounts/{id}/mandate
Retrieves the mandate of a Linked Account using the given Linked Account unique identifier.
The unique identifier of the Linked Account to get mandate
Timestamp of the mandate signing
Address of the signatory
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT.
FIXED
- Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required.
VARIABLE
- Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.
End date to expect to be paid from the Linked Account.
The fixed amount that may be paid from the Linked Account, per transaction.
Maximum amount that may be paid from the Linked Account, per transaction.
The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited.
The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH.
Specifies transaction frequency. One of DAY, WEEK, MONTH or YEAR.
Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate.
It is useful for GB linked accounts only. The reference that was used during creation.
Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate.
Status of the mandate. Possible values should be: ACTIVE, INACTIVE, PROCESSING
Type of the source of your funds.
AU_BECS_DEBIT, US_ACH_DEBIT, US_FEDWIRE_DEBIT, GB_BACS_DEBIT, EU_SEPA_DEBIT, CA_EFT_DEBIT, HK_FPS_DEBIT, SG_EGIRO_DEBIT, AU_PAYTO_DEBIT, NZ_BECS_DEBIT
Version of the mandate signed. Required if you are not reusing mandate.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/mandate' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "accepted_at": "1648387704",3 "address": {4 "address_line1": "200 Collins Street",5 "address_line2": "200 Collins Street",6 "country_code": "AU",7 "postcode": "3000",8 "state": "VIC",9 "suburb": "Melbourne"10 },11 "controls": {12 "amount_type": "VARIABLE",13 "end_date": "2025-12-31",14 "fixed_amount_per_transaction": 1000,15 "max_amount_per_transaction": 1000,16 "schedule": {17 "period": 3,18 "period_unit": "MONTH"19 }20 },21 "email": "[email protected]",22 "reference": "AWX-001",23 "signatory": "Tester Smith",24 "status": "ACTIVE",25 "type": "AU_BECS_DEBIT",26 "version": "1.1"27}
Update a direct debit deposit mandate
POST /api/v1/linked_accounts/{id}/mandate
Adds a mandate to the Linked Account, if it was not provided at the time of creation, or renews an existing mandate. The external bank account owner must sign and agree to the mandate to enable Direct Debits.
The unique identifier of the Linked Account to sign the mandate
Type of the source of your funds.
AU_BECS_DEBIT, US_ACH_DEBIT, US_FEDWIRE_DEBIT, GB_BACS_DEBIT, EU_SEPA_DEBIT, CA_EFT_DEBIT, HK_FPS_DEBIT, SG_EGIRO_DEBIT, AU_PAYTO_DEBIT, NZ_BECS_DEBIT
Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT.
FIXED
- Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required.
VARIABLE
- Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.
End date to expect to be paid from the Linked Account.
The fixed amount that may be paid from the Linked Account, per transaction.
Maximum amount that may be paid from the Linked Account, per transaction.
The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited.
The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH.
Specifies transaction frequency. One of DAY, WEEK, MONTH or YEAR.
Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate.
Identification document. Required if mandate type is HK_FPS_DEBIT
Id Type
HK_ID, PASSPORT, BUSINESS_REGISTRATION_NUMBER, CERTIFICATE_OF_INCORPORATION_NUMBER, OTHERS, NRIC, FIN, UEN
Id Value
Preferred reference for mandate. We use this value to generate a unique reference (that may be different from the initial value), then register in payment system.
Reference to the existing mandate in reuse mandate scenario. This value should be null unless explicitly agreed upon with your Account Manager.
Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate.
Version of the mandate signed. Required if you are not reusing mandate.
Timestamp of the mandate signing
Address of the signatory
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT.
FIXED
- Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required.
VARIABLE
- Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.
End date to expect to be paid from the Linked Account.
The fixed amount that may be paid from the Linked Account, per transaction.
Maximum amount that may be paid from the Linked Account, per transaction.
The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited.
The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH.
Specifies transaction frequency. One of DAY, WEEK, MONTH or YEAR.
Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate.
It is useful for GB linked accounts only. The reference that was used during creation.
Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate.
Status of the mandate. Possible values should be: ACTIVE, INACTIVE, PROCESSING
Type of the source of your funds.
AU_BECS_DEBIT, US_ACH_DEBIT, US_FEDWIRE_DEBIT, GB_BACS_DEBIT, EU_SEPA_DEBIT, CA_EFT_DEBIT, HK_FPS_DEBIT, SG_EGIRO_DEBIT, AU_PAYTO_DEBIT, NZ_BECS_DEBIT
Version of the mandate signed. Required if you are not reusing mandate.
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/mandate' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "controls": {> "amount_type": "VARIABLE",> "end_date": "2025-12-31",> "fixed_amount_per_transaction": 1000,> "max_amount_per_transaction": 1000,> "schedule": {> "period": 3,> "period_unit": "MONTH"> }> },> "email": "[email protected]",> "identification_document": {> "type": "HK_ID",> "value": "A123456"> },> "preferred_reference": "AWX",> "reuse_mandate_reference": "AWX013",> "signatory": "Tester Smith",> "type": "AU_BECS_DEBIT",> "version": "1.1">}'
1{2 "accepted_at": "1648387704",3 "address": {4 "address_line1": "200 Collins Street",5 "address_line2": "200 Collins Street",6 "country_code": "AU",7 "postcode": "3000",8 "state": "VIC",9 "suburb": "Melbourne"10 },11 "controls": {12 "amount_type": "VARIABLE",13 "end_date": "2025-12-31",14 "fixed_amount_per_transaction": 1000,15 "max_amount_per_transaction": 1000,16 "schedule": {17 "period": 3,18 "period_unit": "MONTH"19 }20 },21 "email": "[email protected]",22 "reference": "AWX-001",23 "signatory": "Tester Smith",24 "status": "ACTIVE",25 "type": "AU_BECS_DEBIT",26 "version": "1.1"27}
Check available balances
GET /api/v1/linked_accounts/{id}/balances
Retrieves the balance of a Linked Account using the given Linked Account unique identifier. This API is only available to Linked Accounts where capabilities.balance_check is true. The request will be routed to the respective financial institutions, so you may experience a slight delay in the response.
The unique identifier of the Linked Account to retrieve available balances
A flag which identifies whether there are more results.
Paged results.
Amount of your available balance.
Currency of your available balance (3-letter ISO-4217 code).
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/balances' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "available_amount": 100.1,6 "currency": "USD"7 }8 ]9}
Suspend a linked account
POST /api/v1/linked_accounts/{id}/suspend
Suspend the link between your external bank account and your Airwallex account. This will also revoke any mandate objects attached to your Linked Account. To reverse this action, you will have to create a new Linked Account and go through verification.
The unique identifier of the Linked Account to suspend
OK
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/suspend' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
Confirm a linked account among candidate accounts
POST /api/v1/linked_accounts/{id}/confirm
Confirm your Linked Account among a list of candidate accounts that have already been verified.
The unique identifier of the Linked Account to confirm the account
Account identity come from candidate_accounts
Success
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/linked_accounts/linked_account_id/confirm' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface">}'