Create a transfer to an Airwallex account
You can send funds directly to businesses who also own Airwallex accounts by creating a transfer to an Airwallex account. Learn how to do this programmatically with our Access own account info API and Wallet Transfer API API endpoints in the following sections.
Creating a transfer to an Airwallex account to be routed through the transfer approval workflow set up on the Airwallex account is currently not supported.
Before you begin
- Obtain your access token API by authenticating to Airwallex using your unique Client ID and API key. You will need the access token to make API calls.
Step 1: Prepare required beneficiary information
Before creating a transfer to an Airwallex account, you will need to obtain your beneficiary’s Airwallex account number and account name. This is similar to obtaining a beneficiary’s bank account number and account name when making a bank transfer to their bank account.
There are two ways you can do this:
Use OAuth to allow your beneficiary to grant your application permission to access its Airwallex account number and account name via Access own account info API.
Ask your beneficiary to provide you with its Airwallex account number and account name (currently they can only access them via Access own account info API).
In this section, we will elaborate on using OAuth to obtain your beneficiary’s Airwallex account info.
Set up your application
To do this, you will need to:
- Register an application with us, and obtain an app ID and client secret
Define the scope for your application
- In this case, the required scope for accessing your beneficiary’s Airwallex account number and account name is
r:awx_action:account.wallet_info_view
- In this case, the required scope for accessing your beneficiary’s Airwallex account number and account name is
Provide a redirect URI that your application takes beneficiaries to after granting authorization
For more information, read this Get started page for partner connections.
Obtain your beneficiary’s Airwallex account number and account name
With the access token, your application can retrieve your beneficiary’s Airwallex account number and account name by calling the Access own account info API endpoint with Authorization: Bearer <access_token> in the request header.
Example request
Example response
Step 2: Create a transfer to an Airwallex account
Using your beneficiary’s Airwallex account number and account name, you can create a transfer from your own Airwallex account to the beneficiary’s Airwallex account by calling Create a new wallet transfer API.
Note that you can currently only create a transfer to an Airwallex account without currency conversions. Also, future dated transfer to an Airwallex account is not supported.
Example request
Example response
Fund deduction
Funds will be immediately deducted from the Wallet upon transfer creation. Please ensure that you have sufficient balance in your Wallet when creating transfers. Transfer to an Airwallex account currently does not support the post-fund model (see Funding and settlement models).
Errors
Airwallex uses conventional HTTP response codes API to indicate the success or failure of an API request.
A HTTP 400 status code indicates an error that has been triggered due to the information provided in the request. See Error codes to learn about all possible errors associated with the HTTP 400 status when creating a transfer to an Airwallex account.
Step 3: Retrieve a transfer to an Airwallex account
Retrieve transfers to Airwallex accounts by calling Get a wallet transfer by ID API or Get list of wallet transfers API to view statuses and other details. Additionally, you can subscribe to Transfers webhook events to receive any transfer status transitions. See Transfer to an Airwallex account statuses for more information.
Retrieve a transfer to an Airwallex account
Call Get a wallet transfer by ID API to retrieve details of a transfer to an Airwallex account by specifying the wallet_transfer_id. A successful request will return a response in the same format as Create a new wallet transfer API.
Example request
Example response
Retrieve a list of transfers to Airwallex accounts
Call Get list of wallet transfers API to retrieve a list of transfers to an Airwallex account. You can specify the date range of transfer creation (from_created_at and to_created_at, inclusively) as parameters in the request. You can also use other optional parameters such as transfer_currency and status to filter the list, and the pagination parameters (page, page_size) to refine the results.
Example request
Example response
What happens on the beneficiary’s side?
When the transfer is settled, the transfer amount is credited to the beneficiary’s wallet balance.
- Users of the beneficiary’s Airwallex account can subscribe to email notifications that they receive at the settlement of a transfer to an Airwallex account. An email notification includes the short reference ID, transfer amount, transfer currency, the account name of the payer, and the reference.
Other ways to see the settlement of a transfer to an Airwallex account on the beneficiary’s side:
- Viewing the Wallet Transactions list in the web app.
- Calling Get balance history API.