Beneficiaries
A beneficiary resource needs to be created before a payment can be made, the beneficiary notes the individual or organisation being paid along with the bank details and payment method. A beneficiary unique identifier is generated upon the creation can be used for creating payment using a payment resource.
GET /api/v1/beneficiariesGET /api/v1/beneficiaries/{id}POST /api/v1/beneficiaries/{id}/deletePOST /api/v1/beneficiaries/{id}/updatePOST /api/v1/beneficiaries/createPOST /api/v1/beneficiaries/validatePOST /api/v1/beneficiaries/verify_accountPOST /api/v1/beneficiary_api_schemas/generatePOST /api/v1/beneficiary_form_schemas/generateGET /api/v1/beneficiary_form_schemas/supported_financial_institutions
Get list of beneficiaries
GET /api/v1/beneficiaries
Get list of beneficiaries with optional filters on from date/time, to date/time, names and entity type. Results are paginated, with default list limit of 50 results.
Filter on bank account number of beneficiary
Filter on company name of beneficiary
Filter on entity type of COMPANY or PERSONAL
The start date of created_at in ISO8601 format (inclusive)
Filter on name of beneficiary
Filter on nickname of beneficiary
Page number, starts from 0
Number of results per page. Default value is 100.
Filter on SCA exemptible beneficiaries
The end date of created_at in ISO8601 format (inclusive)
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., BANK_ACCOUNT, DIGITAL_WALLET, CARD
A flag which identifies whether there are more results.
Paged results.
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
id used to uniquely identify this beneficiary contact on the Airwallex platform
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
| 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/beneficiaries' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "beneficiary": {6 "additional_info": {7 "business_area": "Travel",8 "business_phone_number": "689342234",9 "business_registration_number": "IT593003",10 "legal_rep_bank_account_number": "44250100003700000000",11 "legal_rep_first_name_in_chinese": "小芳",12 "legal_rep_id_number": "110108199304203520",13 "legal_rep_last_name_in_chinese": "刘",14 "legal_rep_mobile_number": "13651362890",15 "personal_email": "[email protected]",16 "personal_first_name_in_chinese": "大明",17 "personal_id_number": "1234567890",18 "personal_id_type": "NATIONAL_ID",19 "personal_last_name_in_chinese": "李",20 "personal_mobile_number": "13651362890",21 "security_question": "What is the name of my second puppy?",22 "security_question_answer": "Scooby Doo"23 },24 "address": {25 "city": "Melbourne",26 "country_code": "AU",27 "postcode": "3000",28 "state": "VIC",29 "street_address": "15 William Street"30 },31 "bank_details": {32 "account_currency": "AUD",33 "account_name": "Lee Da Ming",34 "account_name_alias": "Lee D M",35 "account_number": "12750852",36 "account_routing_type1": "bsb",37 "account_routing_type2": "sort_code",38 "account_routing_value1": "083064",39 "account_routing_value2": "123456",40 "bank_account_category": "Checking,Savings,Vista,Maestra",41 "bank_branch": "Melbourne",42 "bank_country_code": "AU",43 "bank_name": "National Australia Bank",44 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",45 "binding_mobile_number": "654897612345",46 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",47 "iban": "ES8023100001180000012345",48 "intermediary_bank_name": "National Australia Bank",49 "intermediary_bank_swift_code": "CTBAAU2S",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S"52 },53 "card": {54 "brand": "VISA",55 "cardholder_name": "John Walker",56 "currency": "USD",57 "expiry_month": "10",58 "expiry_year": "2033",59 "number": "************1111",60 "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="61 },62 "company_name": "Complete Concrete Pty Ltd",63 "date_of_birth": "1976-08-26",64 "digital_wallet": {65 "account_name": "John Walker Corporation",66 "country_code": "US",67 "id_type": "account_number",68 "id_value": "1033106816639334",69 "provider": "AIRWALLEX"70 },71 "entity_type": "COMPANY",72 "first_name": "John",73 "last_name": "Walker"74 },75 "id": "8365ea88-2946-4877-abe1-e02a1015288d",76 "nickname": "Complete Concrete Pty Ltd",77 "payer_entity_type": "COMPANY",78 "sca_exemptible": false,79 "transfer_methods": [80 "SWIFT"81 ]82 }83 ]84}
Get a beneficiary by ID
GET /api/v1/beneficiaries/{id}
Get a specific beneficiary by specifying the Airwallex id.
id of the beneficiary contact to retrieve
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
id used to uniquely identify this beneficiary contact on the Airwallex platform
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
| 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/beneficiaries/beneficiarie_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "beneficiary": {3 "additional_info": {4 "business_area": "Travel",5 "business_phone_number": "689342234",6 "business_registration_number": "IT593003",7 "external_identifier": "<string>",8 "legal_rep_bank_account_number": "44250100003700000000",9 "legal_rep_first_name_in_chinese": "小芳",10 "legal_rep_id_number": "110108199304203520",11 "legal_rep_last_name_in_chinese": "刘",12 "legal_rep_mobile_number": "13651362890",13 "personal_email": "[email protected]",14 "personal_first_name_in_chinese": "大明",15 "personal_id_number": "1234567890",16 "personal_id_type": "NATIONAL_ID",17 "personal_last_name_in_chinese": "李",18 "personal_mobile_number": "13651362890",19 "recipient_account_id": "<string>",20 "security_question": "What is the name of my second puppy?",21 "security_question_answer": "Scooby Doo"22 },23 "address": {24 "city": "Melbourne",25 "country_code": "AU",26 "postcode": "3000",27 "state": "VIC",28 "street_address": "15 William Street"29 },30 "bank_details": {31 "account_currency": "AUD",32 "account_name": "Lee Da Ming",33 "account_name_alias": "Lee D M",34 "account_number": "12750852",35 "account_routing_type1": "bsb",36 "account_routing_type2": "sort_code",37 "account_routing_value1": "083064",38 "account_routing_value2": "123456",39 "bank_account_category": "Checking,Savings,Vista,Maestra",40 "bank_branch": "Melbourne",41 "bank_country_code": "AU",42 "bank_name": "National Australia Bank",43 "bank_state": "<string>",44 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",45 "binding_mobile_number": "654897612345",46 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",47 "iban": "ES8023100001180000012345",48 "intermediary_bank_name": "National Australia Bank",49 "intermediary_bank_swift_code": "CTBAAU2S",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S"52 },53 "card": {54 "brand": "VISA",55 "cardholder_name": "John Walker",56 "currency": "USD",57 "expiry_month": "10",58 "expiry_year": "2033",59 "number": "************1111",60 "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="61 },62 "company_name": "Complete Concrete Pty Ltd",63 "date_of_birth": "1976-08-26",64 "digital_wallet": {65 "account_name": "John Walker Corporation",66 "country_code": "US",67 "id_type": "account_number",68 "id_value": "1033106816639334",69 "provider": "AIRWALLEX"70 },71 "entity_type": "COMPANY",72 "first_name": "John",73 "last_name": "Walker",74 "type": "<string>"75 },76 "id": "8365ea88-2946-4877-abe1-e02a1015288d",77 "nickname": "Complete Concrete Pty Ltd",78 "payer_entity_type": "COMPANY",79 "sca_exemptible": false,80 "transfer_methods": [81 "SWIFT"82 ]83}
Delete existing beneficiary
POST /api/v1/beneficiaries/{id}/delete
Delete an existing beneficiary stored on the Airwallex platform.
id of the beneficiary contact to delete
Returns true if the beneficiary was successfully deleted, or false if the deletion did not take place.
| 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/beneficiaries/beneficiarie_id/delete' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
Update existing beneficiary
POST /api/v1/beneficiaries/{id}/update
Edit an existing beneficiary stored on the Airwallex platform.
id of the beneficiary contact to update
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
Reason for the transfer instruction being made to this beneficiary
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
id used to uniquely identify this beneficiary contact on the Airwallex platform
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
| 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/beneficiaries/beneficiarie_id/update' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "beneficiary": {> "additional_info": {> "business_area": "Travel",> "business_phone_number": "689342234",> "business_registration_number": "IT593003",> "external_identifier": "<string>",> "legal_rep_bank_account_number": "44250100003700000000",> "legal_rep_first_name_in_chinese": "小芳",> "legal_rep_id_number": "110108199304203520",> "legal_rep_last_name_in_chinese": "刘",> "legal_rep_mobile_number": "13651362890",> "personal_email": "[email protected]",> "personal_first_name_in_chinese": "大明",> "personal_id_number": "1234567890",> "personal_id_type": "NATIONAL_ID",> "personal_last_name_in_chinese": "李",> "personal_mobile_number": "13651362890",> "recipient_account_id": "<string>",> "security_question": "What is the name of my second puppy?",> "security_question_answer": "Scooby Doo"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "bank_details": {> "account_currency": "AUD",> "account_name": "Lee Da Ming",> "account_name_alias": "Lee D M",> "account_number": "12750852",> "account_routing_type1": "bsb",> "account_routing_type2": "sort_code",> "account_routing_value1": "083064",> "account_routing_value2": "123456",> "bank_account_category": "Checking,Savings,Vista,Maestra",> "bank_branch": "Melbourne",> "bank_country_code": "AU",> "bank_name": "National Australia Bank",> "bank_state": "<string>",> "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",> "binding_mobile_number": "654897612345",> "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",> "iban": "ES8023100001180000012345",> "intermediary_bank_name": "National Australia Bank",> "intermediary_bank_swift_code": "CTBAAU2S",> "local_clearing_system": "ACH",> "swift_code": "CTBAAU2S"> },> "card": {> "brand": "VISA",> "cardholder_name": "John Walker",> "currency": "USD",> "expiry_month": "10",> "expiry_year": "2033",> "number": "************1111",> "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "digital_wallet": {> "account_name": "John Walker Corporation",> "country_code": "US",> "id_type": "account_number",> "id_value": "1033106816639334",> "provider": "AIRWALLEX"> },> "entity_type": "COMPANY",> "first_name": "John",> "last_name": "Walker",> "type": "<string>"> },> "nickname": "Complete Concrete Pty Ltd",> "payer_entity_type": "COMPANY",> "sca_exemptible": false,> "transfer_methods": [> "SWIFT"> ],> "transfer_reason": "travel">}'
1{2 "beneficiary": {3 "additional_info": {4 "business_area": "Travel",5 "business_phone_number": "689342234",6 "business_registration_number": "IT593003",7 "external_identifier": "<string>",8 "legal_rep_bank_account_number": "44250100003700000000",9 "legal_rep_first_name_in_chinese": "小芳",10 "legal_rep_id_number": "110108199304203520",11 "legal_rep_last_name_in_chinese": "刘",12 "legal_rep_mobile_number": "13651362890",13 "personal_email": "[email protected]",14 "personal_first_name_in_chinese": "大明",15 "personal_id_number": "1234567890",16 "personal_id_type": "NATIONAL_ID",17 "personal_last_name_in_chinese": "李",18 "personal_mobile_number": "13651362890",19 "recipient_account_id": "<string>",20 "security_question": "What is the name of my second puppy?",21 "security_question_answer": "Scooby Doo"22 },23 "address": {24 "city": "Melbourne",25 "country_code": "AU",26 "postcode": "3000",27 "state": "VIC",28 "street_address": "15 William Street"29 },30 "bank_details": {31 "account_currency": "AUD",32 "account_name": "Lee Da Ming",33 "account_name_alias": "Lee D M",34 "account_number": "12750852",35 "account_routing_type1": "bsb",36 "account_routing_type2": "sort_code",37 "account_routing_value1": "083064",38 "account_routing_value2": "123456",39 "bank_account_category": "Checking,Savings,Vista,Maestra",40 "bank_branch": "Melbourne",41 "bank_country_code": "AU",42 "bank_name": "National Australia Bank",43 "bank_state": "<string>",44 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",45 "binding_mobile_number": "654897612345",46 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",47 "iban": "ES8023100001180000012345",48 "intermediary_bank_name": "National Australia Bank",49 "intermediary_bank_swift_code": "CTBAAU2S",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S"52 },53 "card": {54 "brand": "VISA",55 "cardholder_name": "John Walker",56 "currency": "USD",57 "expiry_month": "10",58 "expiry_year": "2033",59 "number": "************1111",60 "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="61 },62 "company_name": "Complete Concrete Pty Ltd",63 "date_of_birth": "1976-08-26",64 "digital_wallet": {65 "account_name": "John Walker Corporation",66 "country_code": "US",67 "id_type": "account_number",68 "id_value": "1033106816639334",69 "provider": "AIRWALLEX"70 },71 "entity_type": "COMPANY",72 "first_name": "John",73 "last_name": "Walker",74 "type": "<string>"75 },76 "id": "8365ea88-2946-4877-abe1-e02a1015288d",77 "nickname": "Complete Concrete Pty Ltd",78 "payer_entity_type": "COMPANY",79 "sca_exemptible": false,80 "transfer_methods": [81 "SWIFT"82 ]83}
Create a new beneficiary
POST /api/v1/beneficiaries/create
Create a new beneficiary to be stored on the Airwallex platform.
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
Reason for the transfer instruction being made to this beneficiary
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
id used to uniquely identify this beneficiary contact on the Airwallex platform
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
| 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/beneficiaries/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "beneficiary": {> "additional_info": {> "business_area": "Travel",> "business_phone_number": "689342234",> "business_registration_number": "IT593003",> "external_identifier": "<string>",> "legal_rep_bank_account_number": "44250100003700000000",> "legal_rep_first_name_in_chinese": "小芳",> "legal_rep_id_number": "110108199304203520",> "legal_rep_last_name_in_chinese": "刘",> "legal_rep_mobile_number": "13651362890",> "personal_email": "[email protected]",> "personal_first_name_in_chinese": "大明",> "personal_id_number": "1234567890",> "personal_id_type": "NATIONAL_ID",> "personal_last_name_in_chinese": "李",> "personal_mobile_number": "13651362890",> "recipient_account_id": "<string>",> "security_question": "What is the name of my second puppy?",> "security_question_answer": "Scooby Doo"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "bank_details": {> "account_currency": "AUD",> "account_name": "Lee Da Ming",> "account_name_alias": "Lee D M",> "account_number": "12750852",> "account_routing_type1": "bsb",> "account_routing_type2": "sort_code",> "account_routing_value1": "083064",> "account_routing_value2": "123456",> "bank_account_category": "Checking,Savings,Vista,Maestra",> "bank_branch": "Melbourne",> "bank_country_code": "AU",> "bank_name": "National Australia Bank",> "bank_state": "<string>",> "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",> "binding_mobile_number": "654897612345",> "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",> "iban": "ES8023100001180000012345",> "intermediary_bank_name": "National Australia Bank",> "intermediary_bank_swift_code": "CTBAAU2S",> "local_clearing_system": "ACH",> "swift_code": "CTBAAU2S"> },> "card": {> "brand": "VISA",> "cardholder_name": "John Walker",> "currency": "USD",> "expiry_month": "10",> "expiry_year": "2033",> "number": "************1111",> "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "digital_wallet": {> "account_name": "John Walker Corporation",> "country_code": "US",> "id_type": "account_number",> "id_value": "1033106816639334",> "provider": "AIRWALLEX"> },> "entity_type": "COMPANY",> "first_name": "John",> "last_name": "Walker",> "type": "<string>"> },> "nickname": "Complete Concrete Pty Ltd",> "payer_entity_type": "COMPANY",> "sca_exemptible": false,> "transfer_methods": [> "SWIFT"> ],> "transfer_reason": "travel">}'
1{2 "beneficiary": {3 "additional_info": {4 "business_area": "Travel",5 "business_phone_number": "689342234",6 "business_registration_number": "IT593003",7 "external_identifier": "<string>",8 "legal_rep_bank_account_number": "44250100003700000000",9 "legal_rep_first_name_in_chinese": "小芳",10 "legal_rep_id_number": "110108199304203520",11 "legal_rep_last_name_in_chinese": "刘",12 "legal_rep_mobile_number": "13651362890",13 "personal_email": "[email protected]",14 "personal_first_name_in_chinese": "大明",15 "personal_id_number": "1234567890",16 "personal_id_type": "NATIONAL_ID",17 "personal_last_name_in_chinese": "李",18 "personal_mobile_number": "13651362890",19 "recipient_account_id": "<string>",20 "security_question": "What is the name of my second puppy?",21 "security_question_answer": "Scooby Doo"22 },23 "address": {24 "city": "Melbourne",25 "country_code": "AU",26 "postcode": "3000",27 "state": "VIC",28 "street_address": "15 William Street"29 },30 "bank_details": {31 "account_currency": "AUD",32 "account_name": "Lee Da Ming",33 "account_name_alias": "Lee D M",34 "account_number": "12750852",35 "account_routing_type1": "bsb",36 "account_routing_type2": "sort_code",37 "account_routing_value1": "083064",38 "account_routing_value2": "123456",39 "bank_account_category": "Checking,Savings,Vista,Maestra",40 "bank_branch": "Melbourne",41 "bank_country_code": "AU",42 "bank_name": "National Australia Bank",43 "bank_state": "<string>",44 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",45 "binding_mobile_number": "654897612345",46 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",47 "iban": "ES8023100001180000012345",48 "intermediary_bank_name": "National Australia Bank",49 "intermediary_bank_swift_code": "CTBAAU2S",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S"52 },53 "card": {54 "brand": "VISA",55 "cardholder_name": "John Walker",56 "currency": "USD",57 "expiry_month": "10",58 "expiry_year": "2033",59 "number": "************1111",60 "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="61 },62 "company_name": "Complete Concrete Pty Ltd",63 "date_of_birth": "1976-08-26",64 "digital_wallet": {65 "account_name": "John Walker Corporation",66 "country_code": "US",67 "id_type": "account_number",68 "id_value": "1033106816639334",69 "provider": "AIRWALLEX"70 },71 "entity_type": "COMPANY",72 "first_name": "John",73 "last_name": "Walker",74 "type": "<string>"75 },76 "id": "8365ea88-2946-4877-abe1-e02a1015288d",77 "nickname": "Complete Concrete Pty Ltd",78 "payer_entity_type": "COMPANY",79 "sca_exemptible": false,80 "transfer_methods": [81 "SWIFT"82 ]83}
Validate beneficiary
POST /api/v1/beneficiaries/validate
Given a beneficiary request, validate it and return all failed fields as a 400 response. No errors will be "OK" as a 200 response.
Details of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
Fingerprint of current beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
Beneficiary's card details where the payment will be credited
Cardholder name
Tokenised card number, which can be retrieved from Airwallex beneficiary component
Card brand
Card currency
Expiry month
Expiry year
Card number
Company name of the beneficiary
beneficiary date of birth
Beneficiary's digital wallet details where the payment will be credited
Account holder name of the beneficiary’s digital wallet
Account identifier type of the beneficiary’s digital wallet
Account identifier value of the beneficiary’s digital wallet
Service provider of the beneficiary's digital wallet
Digital wallet country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary
First name of the beneficiary
Last name of the beneficiary
Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds
Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: SWIFT, LOCAL
Nickname of the beneficiary
The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY
Whether the beneficiary can be exempted from SCA when applicable
Reason for the transfer instruction being made to this beneficiary
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/beneficiaries/validate' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "beneficiary": {> "additional_info": {> "business_area": "Travel",> "business_phone_number": "689342234",> "business_registration_number": "IT593003",> "external_identifier": "<string>",> "legal_rep_bank_account_number": "44250100003700000000",> "legal_rep_first_name_in_chinese": "小芳",> "legal_rep_id_number": "110108199304203520",> "legal_rep_last_name_in_chinese": "刘",> "legal_rep_mobile_number": "13651362890",> "personal_email": "[email protected]",> "personal_first_name_in_chinese": "大明",> "personal_id_number": "1234567890",> "personal_id_type": "NATIONAL_ID",> "personal_last_name_in_chinese": "李",> "personal_mobile_number": "13651362890",> "recipient_account_id": "<string>",> "security_question": "What is the name of my second puppy?",> "security_question_answer": "Scooby Doo"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "bank_details": {> "account_currency": "AUD",> "account_name": "Lee Da Ming",> "account_name_alias": "Lee D M",> "account_number": "12750852",> "account_routing_type1": "bsb",> "account_routing_type2": "sort_code",> "account_routing_value1": "083064",> "account_routing_value2": "123456",> "bank_account_category": "Checking,Savings,Vista,Maestra",> "bank_branch": "Melbourne",> "bank_country_code": "AU",> "bank_name": "National Australia Bank",> "bank_state": "<string>",> "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",> "binding_mobile_number": "654897612345",> "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",> "iban": "ES8023100001180000012345",> "intermediary_bank_name": "National Australia Bank",> "intermediary_bank_swift_code": "CTBAAU2S",> "local_clearing_system": "ACH",> "swift_code": "CTBAAU2S"> },> "card": {> "brand": "VISA",> "cardholder_name": "John Walker",> "currency": "USD",> "expiry_month": "10",> "expiry_year": "2033",> "number": "************1111",> "token": "AKvN4TqxI04SNFZ+oYRXaECtDA=="> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "digital_wallet": {> "account_name": "John Walker Corporation",> "country_code": "US",> "id_type": "account_number",> "id_value": "1033106816639334",> "provider": "AIRWALLEX"> },> "entity_type": "COMPANY",> "first_name": "John",> "last_name": "Walker",> "type": "<string>"> },> "nickname": "Complete Concrete Pty Ltd",> "payer_entity_type": "COMPANY",> "sca_exemptible": false,> "transfer_methods": [> "SWIFT"> ],> "transfer_reason": "travel">}'
Verify a beneficiary account
POST /api/v1/beneficiaries/verify_account
Submit beneficiary account details to verify its existance and retreive name-matching result (where supported) across supported regions and transfer methods (see Product Docs ). The results can be used to mitigate fraud and prevent failures before creating a transfer.
Entity type of the beneficiary, i.e., COMPANY, PERSONAL
Transfer method, i.e., SWIFT, LOCAL
Beneficiary's bank account details where the payment will be credited
Account holder name of the beneficiary’s bank account
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code value
Bank country code (2-letter ISO 3166-2 country code)
International bank account number, mostly for european countries
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The high-level outcome of account verification. Could be one of the following:
VERIFIED: This is a valid account (name match is not guaranteed).INVALID: This account does not exist.CANNOT_VERIFY: We cannot verify this account due to external restrictions.EXTERNAL_SERVICE_UNAVAILABLE: The request failed due to unavailability of external services. Trying again later.
Detailed verification results including name match results if available
The result of account name check based on the account_name provided. See details in Product Docs
The account holder's name of the account specified if available
Name of the account-holding bank if available
A descriptional message of the verification result
| 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/beneficiaries/verify_account' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "bank_details": {> "account_name": "Betty Morris",> "account_number": "10006132",> "account_routing_type1": "sort_code",> "account_routing_value1": "040568",> "bank_country_code": "GB",> "iban": "<string>",> "local_clearing_system": "<string>",> "swift_code": "<string>"> },> "entity_type": "PERSONAL",> "transfer_method": "LOCAL">}'
1{2 "code": "VERIFIED",3 "details": {4 "account_name_match_result": "FULL_MATCH",5 "resolved_account_name": "Betty Morris",6 "resolved_bank_name": "ClearBank Limited"7 },8 "message": "This is a valid account. Refer to the details object for verification details."9}
Get the API schema
POST /api/v1/beneficiary_api_schemas/generate
API schema specifies the required fields and the corresponding field validation rules for each transfer scenario. A payment scenario is defined as a combination of the following parameters: beneficiary entity_type, bank_country_code. account_currency, and your preferred transfer_method, local_clearing_system (if applicable).
Condition map specified in the request defines the schema. The set of parameters depends on the beneficiary type.
OK
| Error status | Description |
|---|---|
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/beneficiary_api_schemas/generate' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "bank_country_code": "US",> "account_currency": "USD",> "transfer_method": "LOCAL",> "local_clearing_system": "ACH",> "entity_type": "PERSONAL",> "type": "BANK_ACCOUNT">}'
1{2 "condition": {3 "bank_country_code": "US",4 "account_currency": "USD",5 "transfer_method": "LOCAL",6 "local_clearing_system": "ACH",7 "entity_type": "PERSONAL",8 "type": "BANK_ACCOUNT"9 },10 "fields": [11 {12 "key": "entity_type",13 "path": "beneficiary.entity_type",14 "required": true,15 "rule": {16 "type": "string",17 "pattern": "COMPANY|PERSONAL"18 }19 },20 {21 "key": "bank_country_code",22 "path": "beneficiary.bank_details.bank_country_code",23 "required": true,24 "rule": {25 "type": "string",26 "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AR|AT|AU|AW|AZ|BA|BD|BE|BG|BH|BO|BR|BZ|CA|CH|CL|CN|CO|CR|CW|CY|CZ|DE|DK|DM|DO|DZ|EC|EE|EG|ES|FI|FJ|FR|GB|GD|GE|GG|GI|GQ|GR|GT|GY|HK|HN|HR|HU|ID|IE|IL|IM|IN|IS|IT|JE|JM|JO|JP|KE|KG|KH|KR|KW|KZ|LI|LK|LT|LU|LV|MA|MC|MD|ME|MK|MO|MQ|MT|MU|MV|MX|MY|NA|NG|NL|NO|NP|NZ|OM|PA|PE|PF|PH|PK|PL|PM|PR|PT|PY|QA|RO|RS|RU|SA|SC|SE|SG|SI|SK|SM|SV|TH|TJ|TN|TR|TW|TZ|UA|UG|US|UY|UZ|VN|VU|YT|ZA|ZM"27 }28 },29 {30 "key": "account_currency",31 "path": "beneficiary.bank_details.account_currency",32 "required": true,33 "rule": {34 "type": "string",35 "pattern": "AUD|BDT|CAD|CHF|CNY|EUR|GBP|HKD|IDR|INR|JPY|KRW|LKR|MYR|NPR|NZD|PHP|PKR|SGD|THB|TRY|USD|VND"36 }37 },38 {39 "key": "transfer_method",40 "path": "transfer_method",41 "required": true,42 "rule": {43 "type": "string",44 "pattern": "LOCAL|SWIFT"45 }46 },47 {48 "key": "local_clearing_system",49 "path": "beneficiary.bank_details.local_clearing_system",50 "required": false,51 "rule": {52 "type": "string",53 "pattern": "ACH|FEDWIRE"54 }55 },56 {57 "key": "first_name",58 "path": "beneficiary.first_name",59 "required": true,60 "rule": {61 "type": "string",62 "pattern": "^.{1,50}$"63 }64 },65 {66 "key": "last_name",67 "path": "beneficiary.last_name",68 "required": true,69 "rule": {70 "type": "string",71 "pattern": "^.{1,50}$"72 }73 },74 {75 "key": "date_of_birth",76 "path": "beneficiary.date_of_birth",77 "required": false,78 "rule": {79 "type": "string",80 "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"81 }82 },83 {84 "key": "account_routing_type1",85 "path": "beneficiary.bank_details.account_routing_type1",86 "required": true,87 "rule": {88 "pattern": "^aba$",89 "type": "string"90 }91 },92 {93 "key": "account_routing_value1",94 "path": "beneficiary.bank_details.account_routing_value1",95 "required": true,96 "rule": {97 "pattern": "^[0-9]{9}$",98 "type": "string"99 }100 },101 {102 "key": "bank_name",103 "path": "beneficiary.bank_details.bank_name",104 "required": true,105 "rule": {106 "type": "string",107 "pattern": "^.{1,200}$"108 }109 },110 {111 "key": "account_number",112 "path": "beneficiary.bank_details.account_number",113 "required": true,114 "rule": {115 "pattern": "^[0-9]{1,17}$",116 "type": "string"117 }118 },119 {120 "key": "account_name",121 "path": "beneficiary.bank_details.account_name",122 "required": true,123 "rule": {124 "type": "string",125 "pattern": "^.{2,100}$"126 }127 },128 {129 "key": "country_code",130 "path": "beneficiary.address.country_code",131 "required": true,132 "rule": {133 "type": "string",134 "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|SA|SB|SC|SE|SG|SH|SI|SJ|SK|SM|SN|SR|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|YT|ZA|ZM"135 }136 },137 {138 "key": "postcode",139 "path": "beneficiary.address.postcode",140 "required": true,141 "rule": {142 "type": "string",143 "pattern": "^.{1,50}$"144 }145 },146 {147 "key": "street_address",148 "path": "beneficiary.address.street_address",149 "required": true,150 "rule": {151 "type": "string",152 "pattern": "^.{1,200}$"153 }154 },155 {156 "key": "city",157 "path": "beneficiary.address.city",158 "required": true,159 "rule": {160 "type": "string",161 "pattern": "^.{1,50}$"162 }163 },164 {165 "key": "state",166 "path": "beneficiary.address.state",167 "required": true,168 "rule": {169 "type": "string",170 "pattern": "^.{1,50}$"171 }172 },173 {174 "key": "nickname",175 "path": "nickname",176 "required": false177 },178 {179 "key": "personal_email",180 "path": "beneficiary.additional_info.personal_email",181 "required": false,182 "rule": {183 "type": "string",184 "pattern": "^(\\S+@\\S+)$"185 }186 }187 ],188 "key": "newRecipient"189}
Get the form schema
POST /api/v1/beneficiary_form_schemas/generate
Form Schema can be used to build your own user interface to collect beneficiaries’ bank account and contact information. It specifies what UI component should be used to render a field along with the corresponding field validation rules. As all schema and field validation rules are maintained by Airwallex, no code changes will be needed on your end when there are updates.
Condition map specified in the request defines the schema. The set of parameters depends on the beneficiary type.
OK
| Error status | Description |
|---|---|
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/beneficiary_form_schemas/generate' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "bank_country_code": "US",> "account_currency": "USD",> "transfer_method": "LOCAL",> "local_clearing_system": "ACH",> "entity_type": "PERSONAL",> "type": "BANK_ACCOUNT">}'
1{2 "condition": {3 "bank_country_code": "US",4 "account_currency": "USD",5 "transfer_method": "LOCAL",6 "local_clearing_system": "ACH",7 "entity_type": "PERSONAL",8 "type": "BANK_ACCOUNT"9 },10 "fields": [11 {12 "enabled": true,13 "field": {14 "key": "entity_type",15 "options": [16 {17 "label": "Business",18 "value": "COMPANY"19 },20 {21 "label": "Personal",22 "value": "PERSONAL"23 }24 ],25 "default": "PERSONAL",26 "description": "",27 "example": "PERSONAL",28 "label": "Recipient account type",29 "placeholder": "",30 "refresh": true,31 "tip": "",32 "type": "RADIO"33 },34 "path": "beneficiary.entity_type",35 "required": true,36 "rule": {37 "type": "string",38 "pattern": "COMPANY|PERSONAL"39 }40 },41 {42 "enabled": true,43 "field": {44 "key": "bank_country_code",45 "options": [46 {47 "label": "Albania",48 "value": "AL"49 },50 {51 "label": "Algeria",52 "value": "DZ"53 },54 {55 "label": "Andorra",56 "value": "AD"57 },58 {59 "label": "Angola",60 "value": "AO"61 },62 {63 "label": "Anguilla",64 "value": "AI"65 },66 {67 "label": "Antigua and Barbuda",68 "value": "AG"69 },70 {71 "label": "Argentina",72 "value": "AR"73 },74 {75 "label": "Armenia",76 "value": "AM"77 },78 {79 "label": "Aruba",80 "value": "AW"81 },82 {83 "label": "Australia",84 "value": "AU"85 },86 {87 "label": "Austria",88 "value": "AT"89 },90 {91 "label": "Azerbaijan",92 "value": "AZ"93 },94 {95 "label": "Bahrain",96 "value": "BH"97 },98 {99 "label": "Bangladesh",100 "value": "BD"101 },102 {103 "label": "Belgium",104 "value": "BE"105 },106 {107 "label": "Belize",108 "value": "BZ"109 },110 {111 "label": "Benin",112 "value": "BJ"113 },114 {115 "label": "Bolivia (Plurinational State of)",116 "value": "BO"117 },118 {119 "label": "Bosnia and Herzegovina",120 "value": "BA"121 },122 {123 "label": "Botswana",124 "value": "BW"125 },126 {127 "label": "Brazil",128 "value": "BR"129 },130 {131 "label": "Bulgaria",132 "value": "BG"133 },134 {135 "label": "Burkina Faso",136 "value": "BF"137 },138 {139 "label": "Cambodia",140 "value": "KH"141 },142 {143 "label": "Cameroon",144 "value": "CM"145 },146 {147 "label": "Canada",148 "value": "CA"149 },150 {151 "label": "Canary Islands",152 "value": "IC"153 },154 {155 "label": "Central African Republic",156 "value": "CF"157 },158 {159 "label": "Chad",160 "value": "TD"161 },162 {163 "label": "Chile",164 "value": "CL"165 },166 {167 "label": "China",168 "value": "CN"169 },170 {171 "label": "Colombia",172 "value": "CO"173 },174 {175 "label": "Congo",176 "value": "CG"177 },178 {179 "label": "Costa Rica",180 "value": "CR"181 },182 {183 "label": "Croatia",184 "value": "HR"185 },186 {187 "label": "Curaçao",188 "value": "CW"189 },190 {191 "label": "Cyprus",192 "value": "CY"193 },194 {195 "label": "Czech Republic",196 "value": "CZ"197 },198 {199 "label": "Côte d'Ivoire",200 "value": "CI"201 },202 {203 "label": "Denmark",204 "value": "DK"205 },206 {207 "label": "Dominica",208 "value": "DM"209 },210 {211 "label": "Dominican Republic",212 "value": "DO"213 },214 {215 "label": "Ecuador",216 "value": "EC"217 },218 {219 "label": "Egypt",220 "value": "EG"221 },222 {223 "label": "El Salvador",224 "value": "SV"225 },226 {227 "label": "Equatorial Guinea",228 "value": "GQ"229 },230 {231 "label": "Estonia",232 "value": "EE"233 },234 {235 "label": "Faroe Islands",236 "value": "FO"237 },238 {239 "label": "Fiji",240 "value": "FJ"241 },242 {243 "label": "Finland",244 "value": "FI"245 },246 {247 "label": "France",248 "value": "FR"249 },250 {251 "label": "French Guiana",252 "value": "GF"253 },254 {255 "label": "French Polynesia",256 "value": "PF"257 },258 {259 "label": "French Southern Territories",260 "value": "TF"261 },262 {263 "label": "Gabon",264 "value": "GA"265 },266 {267 "label": "Gambia",268 "value": "GM"269 },270 {271 "label": "Georgia",272 "value": "GE"273 },274 {275 "label": "Germany",276 "value": "DE"277 },278 {279 "label": "Gibraltar",280 "value": "GI"281 },282 {283 "label": "Greece",284 "value": "GR"285 },286 {287 "label": "Greenland",288 "value": "GL"289 },290 {291 "label": "Grenada",292 "value": "GD"293 },294 {295 "label": "Guatemala",296 "value": "GT"297 },298 {299 "label": "Guernsey",300 "value": "GG"301 },302 {303 "label": "Guinea Bissau",304 "value": "GW"305 },306 {307 "label": "Guyana",308 "value": "GY"309 },310 {311 "label": "Honduras",312 "value": "HN"313 },314 {315 "label": "Hong Kong (China)",316 "value": "HK"317 },318 {319 "label": "Hungary",320 "value": "HU"321 },322 {323 "label": "Iceland",324 "value": "IS"325 },326 {327 "label": "India",328 "value": "IN"329 },330 {331 "label": "Indonesia",332 "value": "ID"333 },334 {335 "label": "Ireland",336 "value": "IE"337 },338 {339 "label": "Isle of Man",340 "value": "IM"341 },342 {343 "label": "Israel",344 "value": "IL"345 },346 {347 "label": "Italy",348 "value": "IT"349 },350 {351 "label": "Jamaica",352 "value": "JM"353 },354 {355 "label": "Japan",356 "value": "JP"357 },358 {359 "label": "Jersey",360 "value": "JE"361 },362 {363 "label": "Jordan",364 "value": "JO"365 },366 {367 "label": "Kazakhstan",368 "value": "KZ"369 },370 {371 "label": "Kenya",372 "value": "KE"373 },374 {375 "label": "Korea, Republic of",376 "value": "KR"377 },378 {379 "label": "Kosovo",380 "value": "XK"381 },382 {383 "label": "Kuwait",384 "value": "KW"385 },386 {387 "label": "Kyrgyzstan",388 "value": "KG"389 },390 {391 "label": "Latvia",392 "value": "LV"393 },394 {395 "label": "Lesotho",396 "value": "LS"397 },398 {399 "label": "Liechtenstein",400 "value": "LI"401 },402 {403 "label": "Lithuania",404 "value": "LT"405 },406 {407 "label": "Luxembourg",408 "value": "LU"409 },410 {411 "label": "Macao (China)",412 "value": "MO"413 },414 {415 "label": "Macedonia, the former Yugoslav Republic of",416 "value": "MK"417 },418 {419 "label": "Madagascar",420 "value": "MG"421 },422 {423 "label": "Malawi",424 "value": "MW"425 },426 {427 "label": "Malaysia",428 "value": "MY"429 },430 {431 "label": "Maldives",432 "value": "MV"433 },434 {435 "label": "Malta",436 "value": "MT"437 },438 {439 "label": "Martinique",440 "value": "MQ"441 },442 {443 "label": "Mauritania",444 "value": "MR"445 },446 {447 "label": "Mauritius",448 "value": "MU"449 },450 {451 "label": "Mayotte",452 "value": "YT"453 },454 {455 "label": "Mexico",456 "value": "MX"457 },458 {459 "label": "Moldova",460 "value": "MD"461 },462 {463 "label": "Monaco",464 "value": "MC"465 },466 {467 "label": "Montenegro",468 "value": "ME"469 },470 {471 "label": "Morocco",472 "value": "MA"473 },474 {475 "label": "Namibia",476 "value": "NA"477 },478 {479 "label": "Nepal",480 "value": "NP"481 },482 {483 "label": "Netherlands",484 "value": "NL"485 },486 {487 "label": "Netherlands Antilles",488 "value": "AN"489 },490 {491 "label": "New Caledonia",492 "value": "NC"493 },494 {495 "label": "New Zealand",496 "value": "NZ"497 },498 {499 "label": "Niger",500 "value": "NE"501 },502 {503 "label": "Nigeria",504 "value": "NG"505 },506 {507 "label": "Norway",508 "value": "NO"509 },510 {511 "label": "Oman",512 "value": "OM"513 },514 {515 "label": "Pakistan",516 "value": "PK"517 },518 {519 "label": "Palestine, State of",520 "value": "PS"521 },522 {523 "label": "Panama",524 "value": "PA"525 },526 {527 "label": "Paraguay",528 "value": "PY"529 },530 {531 "label": "Peru",532 "value": "PE"533 },534 {535 "label": "Philippines",536 "value": "PH"537 },538 {539 "label": "Poland",540 "value": "PL"541 },542 {543 "label": "Portugal",544 "value": "PT"545 },546 {547 "label": "Puerto Rico",548 "value": "PR"549 },550 {551 "label": "Qatar",552 "value": "QA"553 },554 {555 "label": "Romania",556 "value": "RO"557 },558 {559 "label": "Rwanda",560 "value": "RW"561 },562 {563 "label": "Réunion",564 "value": "RE"565 },566 {567 "label": "Saint Barthélemy",568 "value": "BL"569 },570 {571 "label": "Saint Lucia",572 "value": "LC"573 },574 {575 "label": "Saint Martin (French part)",576 "value": "MF"577 },578 {579 "label": "Saint Pierre and Miquelon",580 "value": "PM"581 },582 {583 "label": "San Marino",584 "value": "SM"585 },586 {587 "label": "Saudi Arabia",588 "value": "SA"589 },590 {591 "label": "Senegal",592 "value": "SN"593 },594 {595 "label": "Serbia",596 "value": "RS"597 },598 {599 "label": "Seychelles",600 "value": "SC"601 },602 {603 "label": "Singapore",604 "value": "SG"605 },606 {607 "label": "Slovakia",608 "value": "SK"609 },610 {611 "label": "Slovenia",612 "value": "SI"613 },614 {615 "label": "South Africa",616 "value": "ZA"617 },618 {619 "label": "Spain",620 "value": "ES"621 },622 {623 "label": "Sri Lanka",624 "value": "LK"625 },626 {627 "label": "Sweden",628 "value": "SE"629 },630 {631 "label": "Switzerland",632 "value": "CH"633 },634 {635 "label": "Taiwan (China)",636 "value": "TW"637 },638 {639 "label": "Tajikistan",640 "value": "TJ"641 },642 {643 "label": "Tanzania, United Republic of",644 "value": "TZ"645 },646 {647 "label": "Thailand",648 "value": "TH"649 },650 {651 "label": "Timor-Leste",652 "value": "TL"653 },654 {655 "label": "Togo",656 "value": "TG"657 },658 {659 "label": "Tunisia",660 "value": "TN"661 },662 {663 "label": "Turkey",664 "value": "TR"665 },666 {667 "label": "Uganda",668 "value": "UG"669 },670 {671 "label": "Ukraine",672 "value": "UA"673 },674 {675 "label": "United Arab Emirates",676 "value": "AE"677 },678 {679 "label": "United Kingdom",680 "value": "GB"681 },682 {683 "label": "United States of America",684 "value": "US"685 },686 {687 "label": "Uruguay",688 "value": "UY"689 },690 {691 "label": "Uzbekistan",692 "value": "UZ"693 },694 {695 "label": "Vanuatu",696 "value": "VU"697 },698 {699 "label": "Viet Nam",700 "value": "VN"701 },702 {703 "label": "Virgin Islands (British)",704 "value": "VG"705 },706 {707 "label": "Wallis and Futuna",708 "value": "WF"709 },710 {711 "label": "Zambia",712 "value": "ZM"713 }714 ],715 "default": "US",716 "description": "The recipient's bank country / region",717 "example": "US",718 "label": "Bank country / region",719 "placeholder": "",720 "refresh": true,721 "tip": "",722 "type": "SELECT"723 },724 "path": "beneficiary.bank_details.bank_country_code",725 "required": true,726 "rule": {727 "type": "string",728 "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AR|AT|AU|AW|AZ|BA|BD|BE|BF|BG|BH|BJ|BL|BO|BR|BW|BZ|CA|CF|CG|CH|CI|CL|CM|CN|CO|CR|CW|CY|CZ|DE|DK|DM|DO|DZ|EC|EE|EG|ES|FI|FJ|FO|FR|GA|GB|GD|GE|GF|GG|GI|GL|GM|GQ|GR|GT|GW|GY|HK|HN|HR|HU|IC|ID|IE|IL|IM|IN|IS|IT|JE|JM|JO|JP|KE|KG|KH|KR|KW|KZ|LC|LI|LK|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MK|MO|MQ|MR|MT|MU|MV|MW|MX|MY|NA|NC|NE|NG|NL|NO|NP|NZ|OM|PA|PE|PF|PH|PK|PL|PM|PR|PS|PT|PY|QA|RE|RO|RS|RW|SA|SC|SE|SG|SI|SK|SM|SN|SV|TD|TF|TG|TH|TJ|TL|TN|TR|TW|TZ|UA|UG|US|UY|UZ|VG|VN|VU|WF|XK|YT|ZA|ZM"729 }730 },731 {732 "enabled": true,733 "field": {734 "key": "account_currency",735 "options": [736 {737 "label": "AED - UAE Dirham",738 "value": "AED"739 },740 {741 "label": "AOA - Angolan Kwanza",742 "value": "AOA"743 },744 {745 "label": "ARS - Argentine Peso",746 "value": "ARS"747 },748 {749 "label": "AUD - Australian Dollar",750 "value": "AUD"751 },752 {753 "label": "BDT - Bangladeshi Taka",754 "value": "BDT"755 },756 {757 "label": "BGN - Bulgarian Lev",758 "value": "BGN"759 },760 {761 "label": "BOB - Bolivian Boliviano",762 "value": "BOB"763 },764 {765 "label": "BRL - Brazilian Real",766 "value": "BRL"767 },768 {769 "label": "BWP - Botswanan Pula",770 "value": "BWP"771 },772 {773 "label": "CAD - Canadian Dollar",774 "value": "CAD"775 },776 {777 "label": "CHF - Swiss Franc",778 "value": "CHF"779 },780 {781 "label": "CLP - Chilean Peso",782 "value": "CLP"783 },784 {785 "label": "CNY - Chinese Yuan",786 "value": "CNY"787 },788 {789 "label": "COP - Colombian Peso",790 "value": "COP"791 },792 {793 "label": "CZK - Czech Koruna",794 "value": "CZK"795 },796 {797 "label": "DKK - Danish Krone",798 "value": "DKK"799 },800 {801 "label": "EGP - Egyptian Pound",802 "value": "EGP"803 },804 {805 "label": "EUR - Euro",806 "value": "EUR"807 },808 {809 "label": "GBP - Great Britain Pound",810 "value": "GBP"811 },812 {813 "label": "GMD - Gambian Dalasi",814 "value": "GMD"815 },816 {817 "label": "HKD - Hong Kong Dollar",818 "value": "HKD"819 },820 {821 "label": "HUF - Hungarian Forint",822 "value": "HUF"823 },824 {825 "label": "IDR - Indonesian Rupiah",826 "value": "IDR"827 },828 {829 "label": "ILS - Israeli New Shekel",830 "value": "ILS"831 },832 {833 "label": "INR - Indian Rupee",834 "value": "INR"835 },836 {837 "label": "JPY - Japanese Yen",838 "value": "JPY"839 },840 {841 "label": "KES - Kenyan Shilling",842 "value": "KES"843 },844 {845 "label": "KRW - Korean Won",846 "value": "KRW"847 },848 {849 "label": "LKR - Sri Lankan Rupee",850 "value": "LKR"851 },852 {853 "label": "LSL - Lesotho Loti",854 "value": "LSL"855 },856 {857 "label": "MAD - Moroccan Dirham",858 "value": "MAD"859 },860 {861 "label": "MGA - Malagasy Ariary",862 "value": "MGA"863 },864 {865 "label": "MWK - Malawian Kwacha",866 "value": "MWK"867 },868 {869 "label": "MXN - Mexican Peso",870 "value": "MXN"871 },872 {873 "label": "MYR - Malaysian Ringgit",874 "value": "MYR"875 },876 {877 "label": "NAD - Namibian Dollar",878 "value": "NAD"879 },880 {881 "label": "NGN - Nigerian Naira",882 "value": "NGN"883 },884 {885 "label": "NOK - Norwegian Krone",886 "value": "NOK"887 },888 {889 "label": "NPR - Nepalese Rupee",890 "value": "NPR"891 },892 {893 "label": "NZD - New Zealand Dollar",894 "value": "NZD"895 },896 {897 "label": "PEN - Peruvian Sol",898 "value": "PEN"899 },900 {901 "label": "PHP - Philippine Peso",902 "value": "PHP"903 },904 {905 "label": "PKR - Pakistani Rupee",906 "value": "PKR"907 },908 {909 "label": "PLN - Polish Zloty",910 "value": "PLN"911 },912 {913 "label": "PYG - Paraguayan Guarani",914 "value": "PYG"915 },916 {917 "label": "RON - Romanian Leu",918 "value": "RON"919 },920 {921 "label": "RWF - Rwandan Franc",922 "value": "RWF"923 },924 {925 "label": "SAR - Saudi Riyal",926 "value": "SAR"927 },928 {929 "label": "SEK - Swedish Krona",930 "value": "SEK"931 },932 {933 "label": "SGD - Singapore Dollar",934 "value": "SGD"935 },936 {937 "label": "THB - Thai Baht",938 "value": "THB"939 },940 {941 "label": "TRY - Turkish Lira",942 "value": "TRY"943 },944 {945 "label": "USD - United States Dollar",946 "value": "USD"947 },948 {949 "label": "UYU - Uruguayan Peso",950 "value": "UYU"951 },952 {953 "label": "VND - Vietnamese Dong",954 "value": "VND"955 },956 {957 "label": "XAF - Central African CFA Franc",958 "value": "XAF"959 },960 {961 "label": "XOF - West African CFA Franc",962 "value": "XOF"963 },964 {965 "label": "ZAR - South African Rand",966 "value": "ZAR"967 },968 {969 "label": "ZMW - Zambian Kwacha",970 "value": "ZMW"971 }972 ],973 "default": "USD",974 "description": "The recipient’s bank account currency",975 "example": "USD",976 "label": "Account currency",977 "placeholder": "",978 "refresh": true,979 "tip": "",980 "type": "SELECT"981 },982 "path": "beneficiary.bank_details.account_currency",983 "required": true,984 "rule": {985 "type": "string",986 "pattern": "AED|AOA|ARS|AUD|BDT|BGN|BOB|BRL|BWP|CAD|CHF|CLP|CNY|COP|CZK|DKK|EGP|EUR|GBP|GMD|HKD|HUF|IDR|ILS|INR|JPY|KES|KRW|LKR|LSL|MAD|MGA|MWK|MXN|MYR|NAD|NGN|NOK|NPR|NZD|PEN|PHP|PKR|PLN|PYG|RON|RWF|SAR|SEK|SGD|THB|TRY|USD|UYU|VND|XAF|XOF|ZAR|ZMW"987 }988 },989 {990 "enabled": true,991 "field": {992 "key": "transfer_method",993 "options": [994 {995 "description": "Domestic bank transfer in the destination country, which needs:\n• Account routing number (or SWIFT code)\n• Account number",996 "label": "LOCAL",997 "value": "LOCAL"998 },999 {1000 "description": "International bank transfer, which needs:\n• SWIFT code\n• Account number",1001 "flight_time": {1002 "max": "P1D",1003 "min": "P0D"1004 },1005 "label": "SWIFT",1006 "transfer_limit": {1007 "min": {1008 "amount": 0,1009 "currency": "USD"1010 }1011 },1012 "value": "SWIFT"1013 }1014 ],1015 "default": "LOCAL",1016 "description": "",1017 "example": "LOCAL",1018 "label": "Transfer methods",1019 "placeholder": "",1020 "refresh": true,1021 "tip": "",1022 "type": "TRANSFER_METHOD"1023 },1024 "path": "transfer_method",1025 "required": true,1026 "rule": {1027 "type": "string",1028 "pattern": "LOCAL|SWIFT"1029 }1030 },1031 {1032 "enabled": true,1033 "field": {1034 "key": "local_clearing_system",1035 "options": [1036 {1037 "description": "Local bank transfer with maximum transfer limit, which needs:\n• ACH routing number\n• Account number",1038 "flight_time": {1039 "max": "P2D",1040 "min": "P0D"1041 },1042 "label": "ACH",1043 "transfer_limit": {1044 "max": {1045 "amount": 15000000,1046 "currency": "USD"1047 },1048 "min": {1049 "amount": 0,1050 "currency": "USD"1051 }1052 },1053 "value": "ACH"1054 },1055 {1056 "description": "Real-time bank transfer, which needs:\n• Fedwire ABA routing number\n• Account number",1057 "flight_time": {1058 "max": "P1D",1059 "min": "P0D"1060 },1061 "label": "Fedwire",1062 "transfer_limit": {1063 "min": {1064 "amount": 0,1065 "currency": "USD"1066 }1067 },1068 "value": "FEDWIRE"1069 },1070 {1071 "description": "Transfer by issuing a paper check, which needs:\n• Recipient’s address\n• Recipient’s name",1072 "flight_time": {1073 "max": "P6D",1074 "min": "P2D"1075 },1076 "label": "Paper Check",1077 "transfer_limit": {1078 "max": {1079 "amount": 99999999.99,1080 "currency": "USD"1081 },1082 "min": {1083 "amount": 0,1084 "currency": "USD"1085 }1086 },1087 "value": "PAPER_CHECK"1088 }1089 ],1090 "default": "ACH",1091 "description": "",1092 "example": "ACH",1093 "label": "Transfer methods",1094 "placeholder": "",1095 "refresh": true,1096 "tip": "",1097 "type": "TRANSFER_METHOD"1098 },1099 "path": "beneficiary.bank_details.local_clearing_system",1100 "required": false,1101 "rule": {1102 "type": "string",1103 "pattern": "ACH|FEDWIRE|PAPER_CHECK"1104 }1105 },1106 {1107 "enabled": true,1108 "field": {1109 "key": "date_of_birth",1110 "default": "",1111 "description": "",1112 "example": "2000-01-01",1113 "label": "Date of birth",1114 "placeholder": "",1115 "refresh": false,1116 "tip": "",1117 "type": "INPUT"1118 },1119 "path": "beneficiary.date_of_birth",1120 "required": false,1121 "rule": {1122 "type": "string",1123 "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"1124 }1125 },1126 {1127 "enabled": false,1128 "field": {1129 "key": "account_routing_type1",1130 "default": "aba",1131 "description": "",1132 "example": "aba",1133 "label": "Routing code type",1134 "placeholder": "",1135 "refresh": false,1136 "tip": "",1137 "type": "INPUT"1138 },1139 "path": "beneficiary.bank_details.account_routing_type1",1140 "required": true,1141 "rule": {1142 "pattern": "^aba$",1143 "type": "string"1144 }1145 },1146 {1147 "enabled": true,1148 "field": {1149 "key": "account_routing_value1",1150 "default": "",1151 "description": "9-digit number to identify a bank in the US",1152 "example": "021000021",1153 "label": "ACH routing number",1154 "placeholder": "",1155 "refresh": false,1156 "tip": "",1157 "type": "INPUT"1158 },1159 "path": "beneficiary.bank_details.account_routing_value1",1160 "required": true,1161 "rule": {1162 "pattern": "^[0-9]{9}$",1163 "type": "string"1164 }1165 },1166 {1167 "enabled": true,1168 "field": {1169 "key": "account_number",1170 "default": "",1171 "description": "",1172 "example": "50001121",1173 "label": "Account number",1174 "placeholder": "",1175 "refresh": false,1176 "tip": "",1177 "type": "INPUT"1178 },1179 "path": "beneficiary.bank_details.account_number",1180 "required": true,1181 "rule": {1182 "pattern": "^[0-9]{1,17}$",1183 "type": "string"1184 }1185 },1186 {1187 "enabled": true,1188 "field": {1189 "key": "account_name",1190 "default": "",1191 "description": "Enter the account holder's full name as registered with the bank",1192 "example": "John Walker",1193 "label": "Account name",1194 "placeholder": "",1195 "refresh": false,1196 "tip": "",1197 "type": "INPUT"1198 },1199 "path": "beneficiary.bank_details.account_name",1200 "required": true,1201 "rule": {1202 "type": "string",1203 "pattern": "^[\\s\\S]{2,200}$"1204 }1205 },1206 {1207 "enabled": true,1208 "field": {1209 "key": "country_code",1210 "options": [1211 {1212 "label": "Albania",1213 "value": "AL"1214 },1215 {1216 "label": "Algeria",1217 "value": "DZ"1218 },1219 {1220 "label": "American Samoa",1221 "value": "AS"1222 },1223 {1224 "label": "Andorra",1225 "value": "AD"1226 },1227 {1228 "label": "Angola",1229 "value": "AO"1230 },1231 {1232 "label": "Anguilla",1233 "value": "AI"1234 },1235 {1236 "label": "Antarctica",1237 "value": "AQ"1238 },1239 {1240 "label": "Antigua and Barbuda",1241 "value": "AG"1242 },1243 {1244 "label": "Argentina",1245 "value": "AR"1246 },1247 {1248 "label": "Armenia",1249 "value": "AM"1250 },1251 {1252 "label": "Aruba",1253 "value": "AW"1254 },1255 {1256 "label": "Australia",1257 "value": "AU"1258 },1259 {1260 "label": "Austria",1261 "value": "AT"1262 },1263 {1264 "label": "Azerbaijan",1265 "value": "AZ"1266 },1267 {1268 "label": "Bahamas",1269 "value": "BS"1270 },1271 {1272 "label": "Bahrain",1273 "value": "BH"1274 },1275 {1276 "label": "Bangladesh",1277 "value": "BD"1278 },1279 {1280 "label": "Barbados",1281 "value": "BB"1282 },1283 {1284 "label": "Belgium",1285 "value": "BE"1286 },1287 {1288 "label": "Belize",1289 "value": "BZ"1290 },1291 {1292 "label": "Benin",1293 "value": "BJ"1294 },1295 {1296 "label": "Bermuda",1297 "value": "BM"1298 },1299 {1300 "label": "Bhutan",1301 "value": "BT"1302 },1303 {1304 "label": "Bolivia (Plurinational State of)",1305 "value": "BO"1306 },1307 {1308 "label": "Bonaire, Sint Eustatius and Saba",1309 "value": "BQ"1310 },1311 {1312 "label": "Bosnia and Herzegovina",1313 "value": "BA"1314 },1315 {1316 "label": "Botswana",1317 "value": "BW"1318 },1319 {1320 "label": "Bouvet Island",1321 "value": "BV"1322 },1323 {1324 "label": "Brazil",1325 "value": "BR"1326 },1327 {1328 "label": "British Indian Ocean Territory",1329 "value": "IO"1330 },1331 {1332 "label": "Brunei Darussalam",1333 "value": "BN"1334 },1335 {1336 "label": "Bulgaria",1337 "value": "BG"1338 },1339 {1340 "label": "Burkina Faso",1341 "value": "BF"1342 },1343 {1344 "label": "Burundi",1345 "value": "BI"1346 },1347 {1348 "label": "Cabo Verde",1349 "value": "CV"1350 },1351 {1352 "label": "Cambodia",1353 "value": "KH"1354 },1355 {1356 "label": "Cameroon",1357 "value": "CM"1358 },1359 {1360 "label": "Canada",1361 "value": "CA"1362 },1363 {1364 "label": "Canary Islands",1365 "value": "IC"1366 },1367 {1368 "label": "Cayman Islands",1369 "value": "KY"1370 },1371 {1372 "label": "Central African Republic",1373 "value": "CF"1374 },1375 {1376 "label": "Chad",1377 "value": "TD"1378 },1379 {1380 "label": "Chile",1381 "value": "CL"1382 },1383 {1384 "label": "China",1385 "value": "CN"1386 },1387 {1388 "label": "Christmas Island",1389 "value": "CX"1390 },1391 {1392 "label": "Cocos (Keeling) Islands",1393 "value": "CC"1394 },1395 {1396 "label": "Colombia",1397 "value": "CO"1398 },1399 {1400 "label": "Comoros",1401 "value": "KM"1402 },1403 {1404 "label": "Congo",1405 "value": "CG"1406 },1407 {1408 "label": "Cook Islands",1409 "value": "CK"1410 },1411 {1412 "label": "Costa Rica",1413 "value": "CR"1414 },1415 {1416 "label": "Croatia",1417 "value": "HR"1418 },1419 {1420 "label": "Curaçao",1421 "value": "CW"1422 },1423 {1424 "label": "Cyprus",1425 "value": "CY"1426 },1427 {1428 "label": "Czech Republic",1429 "value": "CZ"1430 },1431 {1432 "label": "Côte d'Ivoire",1433 "value": "CI"1434 },1435 {1436 "label": "Denmark",1437 "value": "DK"1438 },1439 {1440 "label": "Djibouti",1441 "value": "DJ"1442 },1443 {1444 "label": "Dominica",1445 "value": "DM"1446 },1447 {1448 "label": "Dominican Republic",1449 "value": "DO"1450 },1451 {1452 "label": "Ecuador",1453 "value": "EC"1454 },1455 {1456 "label": "Egypt",1457 "value": "EG"1458 },1459 {1460 "label": "El Salvador",1461 "value": "SV"1462 },1463 {1464 "label": "Equatorial Guinea",1465 "value": "GQ"1466 },1467 {1468 "label": "Eritrea",1469 "value": "ER"1470 },1471 {1472 "label": "Estonia",1473 "value": "EE"1474 },1475 {1476 "label": "Ethiopia",1477 "value": "ET"1478 },1479 {1480 "label": "Falkland Islands (Malvinas)",1481 "value": "FK"1482 },1483 {1484 "label": "Faroe Islands",1485 "value": "FO"1486 },1487 {1488 "label": "Fiji",1489 "value": "FJ"1490 },1491 {1492 "label": "Finland",1493 "value": "FI"1494 },1495 {1496 "label": "France",1497 "value": "FR"1498 },1499 {1500 "label": "French Guiana",1501 "value": "GF"1502 },1503 {1504 "label": "French Polynesia",1505 "value": "PF"1506 },1507 {1508 "label": "French Southern Territories",1509 "value": "TF"1510 },1511 {1512 "label": "Gabon",1513 "value": "GA"1514 },1515 {1516 "label": "Gambia",1517 "value": "GM"1518 },1519 {1520 "label": "Georgia",1521 "value": "GE"1522 },1523 {1524 "label": "Germany",1525 "value": "DE"1526 },1527 {1528 "label": "Ghana",1529 "value": "GH"1530 },1531 {1532 "label": "Gibraltar",1533 "value": "GI"1534 },1535 {1536 "label": "Greece",1537 "value": "GR"1538 },1539 {1540 "label": "Greenland",1541 "value": "GL"1542 },1543 {1544 "label": "Grenada",1545 "value": "GD"1546 },1547 {1548 "label": "Guadeloupe",1549 "value": "GP"1550 },1551 {1552 "label": "Guam",1553 "value": "GU"1554 },1555 {1556 "label": "Guatemala",1557 "value": "GT"1558 },1559 {1560 "label": "Guernsey",1561 "value": "GG"1562 },1563 {1564 "label": "Guinea",1565 "value": "GN"1566 },1567 {1568 "label": "Guinea Bissau",1569 "value": "GW"1570 },1571 {1572 "label": "Guyana",1573 "value": "GY"1574 },1575 {1576 "label": "Heard Island and McDonald Islands",1577 "value": "HM"1578 },1579 {1580 "label": "Holy See",1581 "value": "VA"1582 },1583 {1584 "label": "Honduras",1585 "value": "HN"1586 },1587 {1588 "label": "Hong Kong (China)",1589 "value": "HK"1590 },1591 {1592 "label": "Hungary",1593 "value": "HU"1594 },1595 {1596 "label": "Iceland",1597 "value": "IS"1598 },1599 {1600 "label": "India",1601 "value": "IN"1602 },1603 {1604 "label": "Indonesia",1605 "value": "ID"1606 },1607 {1608 "label": "Ireland",1609 "value": "IE"1610 },1611 {1612 "label": "Isle of Man",1613 "value": "IM"1614 },1615 {1616 "label": "Israel",1617 "value": "IL"1618 },1619 {1620 "label": "Italy",1621 "value": "IT"1622 },1623 {1624 "label": "Jamaica",1625 "value": "JM"1626 },1627 {1628 "label": "Japan",1629 "value": "JP"1630 },1631 {1632 "label": "Jersey",1633 "value": "JE"1634 },1635 {1636 "label": "Jordan",1637 "value": "JO"1638 },1639 {1640 "label": "Kazakhstan",1641 "value": "KZ"1642 },1643 {1644 "label": "Kenya",1645 "value": "KE"1646 },1647 {1648 "label": "Kiribati",1649 "value": "KI"1650 },1651 {1652 "label": "Korea, Republic of",1653 "value": "KR"1654 },1655 {1656 "label": "Kosovo",1657 "value": "XK"1658 },1659 {1660 "label": "Kuwait",1661 "value": "KW"1662 },1663 {1664 "label": "Kyrgyzstan",1665 "value": "KG"1666 },1667 {1668 "label": "Lao People's Democratic Republic",1669 "value": "LA"1670 },1671 {1672 "label": "Latvia",1673 "value": "LV"1674 },1675 {1676 "label": "Lebanon",1677 "value": "LB"1678 },1679 {1680 "label": "Lesotho",1681 "value": "LS"1682 },1683 {1684 "label": "Liberia",1685 "value": "LR"1686 },1687 {1688 "label": "Libya",1689 "value": "LY"1690 },1691 {1692 "label": "Liechtenstein",1693 "value": "LI"1694 },1695 {1696 "label": "Lithuania",1697 "value": "LT"1698 },1699 {1700 "label": "Luxembourg",1701 "value": "LU"1702 },1703 {1704 "label": "Macao (China)",1705 "value": "MO"1706 },1707 {1708 "label": "Macedonia, the former Yugoslav Republic of",1709 "value": "MK"1710 },1711 {1712 "label": "Madagascar",1713 "value": "MG"1714 },1715 {1716 "label": "Malawi",1717 "value": "MW"1718 },1719 {1720 "label": "Malaysia",1721 "value": "MY"1722 },1723 {1724 "label": "Maldives",1725 "value": "MV"1726 },1727 {1728 "label": "Malta",1729 "value": "MT"1730 },1731 {1732 "label": "Marshall Islands",1733 "value": "MH"1734 },1735 {1736 "label": "Martinique",1737 "value": "MQ"1738 },1739 {1740 "label": "Mauritania",1741 "value": "MR"1742 },1743 {1744 "label": "Mauritius",1745 "value": "MU"1746 },1747 {1748 "label": "Mayotte",1749 "value": "YT"1750 },1751 {1752 "label": "Mexico",1753 "value": "MX"1754 },1755 {1756 "label": "Micronesia",1757 "value": "FM"1758 },1759 {1760 "label": "Moldova",1761 "value": "MD"1762 },1763 {1764 "label": "Monaco",1765 "value": "MC"1766 },1767 {1768 "label": "Mongolia",1769 "value": "MN"1770 },1771 {1772 "label": "Montenegro",1773 "value": "ME"1774 },1775 {1776 "label": "Montserrat",1777 "value": "MS"1778 },1779 {1780 "label": "Morocco",1781 "value": "MA"1782 },1783 {1784 "label": "Namibia",1785 "value": "NA"1786 },1787 {1788 "label": "Nauru",1789 "value": "NR"1790 },1791 {1792 "label": "Nepal",1793 "value": "NP"1794 },1795 {1796 "label": "Netherlands",1797 "value": "NL"1798 },1799 {1800 "label": "Netherlands Antilles",1801 "value": "AN"1802 },1803 {1804 "label": "New Caledonia",1805 "value": "NC"1806 },1807 {1808 "label": "New Zealand",1809 "value": "NZ"1810 },1811 {1812 "label": "Nicaragua",1813 "value": "NI"1814 },1815 {1816 "label": "Niger",1817 "value": "NE"1818 },1819 {1820 "label": "Nigeria",1821 "value": "NG"1822 },1823 {1824 "label": "Niue",1825 "value": "NU"1826 },1827 {1828 "label": "Norfolk Island",1829 "value": "NF"1830 },1831 {1832 "label": "Northern Mariana Islands",1833 "value": "MP"1834 },1835 {1836 "label": "Norway",1837 "value": "NO"1838 },1839 {1840 "label": "Oman",1841 "value": "OM"1842 },1843 {1844 "label": "Pakistan",1845 "value": "PK"1846 },1847 {1848 "label": "Palau",1849 "value": "PW"1850 },1851 {1852 "label": "Palestine, State of",1853 "value": "PS"1854 },1855 {1856 "label": "Panama",1857 "value": "PA"1858 },1859 {1860 "label": "Papua New Guinea",1861 "value": "PG"1862 },1863 {1864 "label": "Paraguay",1865 "value": "PY"1866 },1867 {1868 "label": "Peru",1869 "value": "PE"1870 },1871 {1872 "label": "Philippines",1873 "value": "PH"1874 },1875 {1876 "label": "Pitcairn",1877 "value": "PN"1878 },1879 {1880 "label": "Poland",1881 "value": "PL"1882 },1883 {1884 "label": "Portugal",1885 "value": "PT"1886 },1887 {1888 "label": "Puerto Rico",1889 "value": "PR"1890 },1891 {1892 "label": "Qatar",1893 "value": "QA"1894 },1895 {1896 "label": "Romania",1897 "value": "RO"1898 },1899 {1900 "label": "Rwanda",1901 "value": "RW"1902 },1903 {1904 "label": "Réunion",1905 "value": "RE"1906 },1907 {1908 "label": "Saint Barthélemy",1909 "value": "BL"1910 },1911 {1912 "label": "Saint Helena, Ascension and Tristan da Cunha",1913 "value": "SH"1914 },1915 {1916 "label": "Saint Kitts and Nevis",1917 "value": "KN"1918 },1919 {1920 "label": "Saint Lucia",1921 "value": "LC"1922 },1923 {1924 "label": "Saint Martin (French part)",1925 "value": "MF"1926 },1927 {1928 "label": "Saint Pierre and Miquelon",1929 "value": "PM"1930 },1931 {1932 "label": "Saint Vincent and the Grenadines",1933 "value": "VC"1934 },1935 {1936 "label": "Samoa",1937 "value": "WS"1938 },1939 {1940 "label": "San Marino",1941 "value": "SM"1942 },1943 {1944 "label": "Sao Tome and Principe",1945 "value": "ST"1946 },1947 {1948 "label": "Saudi Arabia",1949 "value": "SA"1950 },1951 {1952 "label": "Senegal",1953 "value": "SN"1954 },1955 {1956 "label": "Serbia",1957 "value": "RS"1958 },1959 {1960 "label": "Seychelles",1961 "value": "SC"1962 },1963 {1964 "label": "Sierra Leone",1965 "value": "SL"1966 },1967 {1968 "label": "Singapore",1969 "value": "SG"1970 },1971 {1972 "label": "Sint Maarten (Dutch part)",1973 "value": "SX"1974 },1975 {1976 "label": "Slovakia",1977 "value": "SK"1978 },1979 {1980 "label": "Slovenia",1981 "value": "SI"1982 },1983 {1984 "label": "Solomon Islands",1985 "value": "SB"1986 },1987 {1988 "label": "South Africa",1989 "value": "ZA"1990 },1991 {1992 "label": "South Georgia and the South Sandwich Islands",1993 "value": "GS"1994 },1995 {1996 "label": "Spain",1997 "value": "ES"1998 },1999 {2000 "label": "Sri Lanka",2001 "value": "LK"2002 },2003 {2004 "label": "Suriname",2005 "value": "SR"2006 },2007 {2008 "label": "Svalbard and Jan Mayen",2009 "value": "SJ"2010 },2011 {2012 "label": "Swaziland",2013 "value": "SZ"2014 },2015 {2016 "label": "Sweden",2017 "value": "SE"2018 },2019 {2020 "label": "Switzerland",2021 "value": "CH"2022 },2023 {2024 "label": "Taiwan (China)",2025 "value": "TW"2026 },2027 {2028 "label": "Tajikistan",2029 "value": "TJ"2030 },2031 {2032 "label": "Tanzania, United Republic of",2033 "value": "TZ"2034 },2035 {2036 "label": "Thailand",2037 "value": "TH"2038 },2039 {2040 "label": "Timor-Leste",2041 "value": "TL"2042 },2043 {2044 "label": "Togo",2045 "value": "TG"2046 },2047 {2048 "label": "Tokelau",2049 "value": "TK"2050 },2051 {2052 "label": "Tonga",2053 "value": "TO"2054 },2055 {2056 "label": "Trinidad and Tobago",2057 "value": "TT"2058 },2059 {2060 "label": "Tunisia",2061 "value": "TN"2062 },2063 {2064 "label": "Turkey",2065 "value": "TR"2066 },2067 {2068 "label": "Turkmenistan",2069 "value": "TM"2070 },2071 {2072 "label": "Turks and Caicos Islands",2073 "value": "TC"2074 },2075 {2076 "label": "Tuvalu",2077 "value": "TV"2078 },2079 {2080 "label": "Uganda",2081 "value": "UG"2082 },2083 {2084 "label": "Ukraine",2085 "value": "UA"2086 },2087 {2088 "label": "United Arab Emirates",2089 "value": "AE"2090 },2091 {2092 "label": "United Kingdom",2093 "value": "GB"2094 },2095 {2096 "label": "United States Minor Outlying Islands",2097 "value": "UM"2098 },2099 {2100 "label": "United States of America",2101 "value": "US"2102 },2103 {2104 "label": "Uruguay",2105 "value": "UY"2106 },2107 {2108 "label": "Uzbekistan",2109 "value": "UZ"2110 },2111 {2112 "label": "Vanuatu",2113 "value": "VU"2114 },2115 {2116 "label": "Viet Nam",2117 "value": "VN"2118 },2119 {2120 "label": "Virgin Islands (British)",2121 "value": "VG"2122 },2123 {2124 "label": "Virgin Islands (U.S.)",2125 "value": "VI"2126 },2127 {2128 "label": "Wallis and Futuna",2129 "value": "WF"2130 },2131 {2132 "label": "Western Sahara",2133 "value": "EH"2134 },2135 {2136 "label": "Zambia",2137 "value": "ZM"2138 },2139 {2140 "label": "Zimbabwe",2141 "value": "ZW"2142 },2143 {2144 "label": "Åland Islands",2145 "value": "AX"2146 }2147 ],2148 "default": "US",2149 "description": "",2150 "example": "US",2151 "label": "Country or region",2152 "placeholder": "",2153 "refresh": true,2154 "tip": "",2155 "type": "SELECT"2156 },2157 "path": "beneficiary.address.country_code",2158 "required": true,2159 "rule": {2160 "type": "string",2161 "pattern": "AD|AE|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|BV|BW|BZ|CA|CC|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HU|IC|ID|IE|IL|IM|IN|IO|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MF|MG|MH|MK|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SR|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YT|ZA|ZM|ZW"2162 }2163 },2164 {2165 "enabled": true,2166 "field": {2167 "key": "postcode",2168 "default": "",2169 "description": "",2170 "example": "98104",2171 "label": "ZIP code",2172 "placeholder": "",2173 "refresh": true,2174 "tip": "",2175 "type": "INPUT"2176 },2177 "path": "beneficiary.address.postcode",2178 "required": true,2179 "rule": {2180 "pattern": "^[0-9]{5}(?:-[0-9]{4})?$",2181 "type": "string"2182 }2183 },2184 {2185 "enabled": true,2186 "field": {2187 "key": "street_address",2188 "default": "",2189 "description": "Recipient's address (Should not be a PO or GPO box address)",2190 "example": "412 5th Avenue",2191 "label": "Address",2192 "placeholder": "",2193 "refresh": false,2194 "tip": "",2195 "type": "INPUT"2196 },2197 "path": "beneficiary.address.street_address",2198 "required": true,2199 "rule": {2200 "type": "string",2201 "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$"2202 }2203 },2204 {2205 "enabled": true,2206 "field": {2207 "key": "city",2208 "default": "",2209 "description": "",2210 "example": "Seattle",2211 "label": "City",2212 "placeholder": "",2213 "refresh": false,2214 "tip": "",2215 "type": "INPUT"2216 },2217 "path": "beneficiary.address.city",2218 "required": true,2219 "rule": {2220 "type": "string",2221 "pattern": "^[\\s\\S]{1,50}$"2222 }2223 },2224 {2225 "enabled": true,2226 "field": {2227 "key": "state",2228 "options": [2229 {2230 "label": "Alabama",2231 "value": "US-AL"2232 },2233 {2234 "label": "Alaska",2235 "value": "US-AK"2236 },2237 {2238 "label": "American Samoa",2239 "value": "US-AS"2240 },2241 {2242 "label": "Arizona",2243 "value": "US-AZ"2244 },2245 {2246 "label": "Arkansas",2247 "value": "US-AR"2248 },2249 {2250 "label": "California",2251 "value": "US-CA"2252 },2253 {2254 "label": "Colorado",2255 "value": "US-CO"2256 },2257 {2258 "label": "Connecticut",2259 "value": "US-CT"2260 },2261 {2262 "label": "Delaware",2263 "value": "US-DE"2264 },2265 {2266 "label": "District of Columbia",2267 "value": "US-DC"2268 },2269 {2270 "label": "Florida",2271 "value": "US-FL"2272 },2273 {2274 "label": "Georgia",2275 "value": "US-GA"2276 },2277 {2278 "label": "Guam",2279 "value": "US-GU"2280 },2281 {2282 "label": "Hawaii",2283 "value": "US-HI"2284 },2285 {2286 "label": "Idaho",2287 "value": "US-ID"2288 },2289 {2290 "label": "Illinois",2291 "value": "US-IL"2292 },2293 {2294 "label": "Indiana",2295 "value": "US-IN"2296 },2297 {2298 "label": "Iowa",2299 "value": "US-IA"2300 },2301 {2302 "label": "Kansas",2303 "value": "US-KS"2304 },2305 {2306 "label": "Kentucky",2307 "value": "US-KY"2308 },2309 {2310 "label": "Louisiana",2311 "value": "US-LA"2312 },2313 {2314 "label": "Maine",2315 "value": "US-ME"2316 },2317 {2318 "label": "Maryland",2319 "value": "US-MD"2320 },2321 {2322 "label": "Massachusetts",2323 "value": "US-MA"2324 },2325 {2326 "label": "Michigan",2327 "value": "US-MI"2328 },2329 {2330 "label": "Minnesota",2331 "value": "US-MN"2332 },2333 {2334 "label": "Mississippi",2335 "value": "US-MS"2336 },2337 {2338 "label": "Missouri",2339 "value": "US-MO"2340 },2341 {2342 "label": "Montana",2343 "value": "US-MT"2344 },2345 {2346 "label": "Nebraska",2347 "value": "US-NE"2348 },2349 {2350 "label": "Nevada",2351 "value": "US-NV"2352 },2353 {2354 "label": "New Hampshire",2355 "value": "US-NH"2356 },2357 {2358 "label": "New Jersey",2359 "value": "US-NJ"2360 },2361 {2362 "label": "New Mexico",2363 "value": "US-NM"2364 },2365 {2366 "label": "New York",2367 "value": "US-NY"2368 },2369 {2370 "label": "North Carolina",2371 "value": "US-NC"2372 },2373 {2374 "label": "North Dakota",2375 "value": "US-ND"2376 },2377 {2378 "label": "Northern Mariana Islands",2379 "value": "US-MP"2380 },2381 {2382 "label": "Ohio",2383 "value": "US-OH"2384 },2385 {2386 "label": "Oklahoma",2387 "value": "US-OK"2388 },2389 {2390 "label": "Oregon",2391 "value": "US-OR"2392 },2393 {2394 "label": "Pennsylvania",2395 "value": "US-PA"2396 },2397 {2398 "label": "Puerto Rico",2399 "value": "US-PR"2400 },2401 {2402 "label": "Rhode Island",2403 "value": "US-RI"2404 },2405 {2406 "label": "South Carolina",2407 "value": "US-SC"2408 },2409 {2410 "label": "South Dakota",2411 "value": "US-SD"2412 },2413 {2414 "label": "Tennessee",2415 "value": "US-TN"2416 },2417 {2418 "label": "Texas",2419 "value": "US-TX"2420 },2421 {2422 "label": "United States Minor Outlying Islands",2423 "value": "US-UM"2424 },2425 {2426 "label": "Utah",2427 "value": "US-UT"2428 },2429 {2430 "label": "Vermont",2431 "value": "US-VT"2432 },2433 {2434 "label": "Virgin Islands, U.S.",2435 "value": "US-VI"2436 },2437 {2438 "label": "Virginia",2439 "value": "US-VA"2440 },2441 {2442 "label": "Washington",2443 "value": "US-WA"2444 },2445 {2446 "label": "West Virginia",2447 "value": "US-WV"2448 },2449 {2450 "label": "Wisconsin",2451 "value": "US-WI"2452 },2453 {2454 "label": "Wyoming",2455 "value": "US-WY"2456 }2457 ],2458 "default": "",2459 "description": "",2460 "example": "Washington",2461 "label": "State",2462 "placeholder": "",2463 "refresh": false,2464 "tip": "",2465 "type": "SELECT"2466 },2467 "path": "beneficiary.address.state",2468 "required": true,2469 "rule": {2470 "type": "string",2471 "pattern": "US-AK|US-AL|US-AR|US-AS|US-AZ|US-CA|US-CO|US-CT|US-DC|US-DE|US-FL|US-GA|US-GU|US-HI|US-IA|US-ID|US-IL|US-IN|US-KS|US-KY|US-LA|US-MA|US-MD|US-ME|US-MI|US-MN|US-MO|US-MP|US-MS|US-MT|US-NC|US-ND|US-NE|US-NH|US-NJ|US-NM|US-NV|US-NY|US-OH|US-OK|US-OR|US-PA|US-PR|US-RI|US-SC|US-SD|US-TN|US-TX|US-UM|US-UT|US-VA|US-VI|US-VT|US-WA|US-WI|US-WV|US-WY"2472 }2473 },2474 {2475 "enabled": true,2476 "field": {2477 "key": "nickname",2478 "default": "",2479 "description": "For your reference only. Nicknames are only visible to you and will not be sent to the recipient.",2480 "example": "Complete Concrete Pty Ltd",2481 "label": "Nickname",2482 "placeholder": "",2483 "refresh": false,2484 "tip": "",2485 "type": "INPUT"2486 },2487 "path": "nickname",2488 "required": false2489 },2490 {2491 "enabled": true,2492 "field": {2493 "key": "personal_email",2494 "default": "",2495 "description": "",2496 "example": "[email protected]",2497 "label": "Email address",2498 "placeholder": "",2499 "refresh": false,2500 "tip": "",2501 "type": "INPUT"2502 },2503 "path": "beneficiary.additional_info.personal_email",2504 "required": false,2505 "rule": {2506 "type": "string",2507 "pattern": "^(\\S+@\\S+)$"2508 }2509 }2510 ],2511 "key": "newRecipient"2512}
Get supported financial institutions
GET /api/v1/beneficiary_form_schemas/supported_financial_institutions
Retrieve an array of Airwallex’s supported financial institutions for beneficiaries, which can be used to build your own interface. Specify the beneficiaries' attributes in your request, and use keyword to search and narrow down your results.
Account currency (3-letter ISO 4217 currency code)
Bank country code (2-letter ISO 3166-2 country code)
Entity type of the beneficiary, i.e., COMPANY, PERSONAL
Transfer method, i.e., SWIFT, LOCAL
A valid bank code. When specified, this bank’s branches will be returned instead of a list of banks. Note that this is available only in regions where branch-level information is supported
A substring to filter the financial institutions with. When a keyword is specified, financial institutions will only be returned in the response if this substring is contained in their label (bank name) or value (bank code).
Local clearing systems are available for selection when making local transfers to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value. To learn more, please visit: https://www.airwallex.com/guides/payout
Unpaginated results
Name of the financial institution
Routing code of the financial institution
Whether all relevant results are returned. Refine the keyword in the request to narrow down results when this is true
| Error status | Description |
|---|---|
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/beneficiary_form_schemas/supported_financial_institutions' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "items": [3 {4 "label": "Bank of America, NA",5 "value": "021202162"6 },7 {8 "label": "PNC Bank National Association",9 "value": "021202191"10 },11 {12 "label": "PNC Bank National Association",13 "value": "021202311"14 },15 {16 "label": "JPMorgan Chase Bank, NA",17 "value": "021202337"18 },19 {20 "label": "PNC Bank National Association",21 "value": "021202447"22 },23 {24 "label": "Bank of America, NA",25 "value": "021202609"26 },27 {28 "label": "JPMorgan Chase Bank, NA",29 "value": "021202719"30 }31 ],32 "truncated": false33}