Get started with Global Accounts
Global Accounts enable you to receive bank transfers into and authorize direct debit payouts from the Wallet. Learn how to create, manage and use Global Accounts in the region and currency of choice, as well as retrieve transaction details for the purposes of reconciliation, proof of funds, data analysis using Airwallex API API.
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.
- Set up webhooks to receive notifications on Global Account events.
- If your business requires a large number of Global Accounts, please contact your Airwallex Account Manager.
- As a Scale platform account, you can call all Global Accounts API endpoints on behalf of your connected accounts by specifying the connected account's open ID (in the format
acct_xxxxxx) in thex-on-behalf-ofheader of your API request. To learn about how you can register as a platform and set up this solution, see our step-by-step guide on Scale integration.
Create a Global Account
Use the dynamic schema API to retrieve the supported currencies and payment methods for the country where the Global Account will be held. Based on this information, call the Open a Global Account API endpoint with the following parameters:
country_code: Specify the region where the Global Account will be held.currency: Specify a currency that’s supported for the region provided.nick_name: Specify a name to uniquely identify the Global Account. This is for your own record keeping only, and will not show up on bank statements.payment_methods: SpecifyLOCALorSWIFTdepending on the region and currency.request_id: Specify a unique identifier for the request.
The response will contain the bank account information of the Global Account including:
- Global Account ID
- Global Account details,
account_name,account_number,account_type(CHECKING,SAVING,CURRENT) - Global Account status (
ACTIVE) - Global Account capabilities including supported
clearing_systemsandpayment_methods, as well as whether direct debit payouts are supported (support_direct_debit) - Global Account financial institution details, including bank name, branch name, bank address, routing code, and SWIFT code
Example request
If you are registered as a Scale platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
Retrieve details of your Global Account
Call Get Global Account by ID API by specifying Global Account ID in the endpoint URL.
Example request
If you are registered as a Scale platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
You can also retrieve all Global Accounts associated with your Airwallex account using Get a list of Global Accounts API. If you want to filter the results, provide additional parameters for time period (from_created_at, to_created_at), pagination (page_size,page_num), status, etc.
Example request
If you are registered as a Scale platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.