Create 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 platform, 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-of
header of your API request. To learn about how you can register as a platform and set up this solution, see Global Treasury and Banking as a Service solutions.
Create a Global Account
Use the dynamic schema API, you can retrieve the full list of supported currencies and their respective transfer methods in the sample API request for the selected country where the Global Account will be held. Based on this information, call the Open a Global Account API endpoint with the following parameters:
alternate_account_identifiers
*:email
: Specify an email address for receiving funds via Interac e-Transfer Autodeposit. If omitted, Airwallex will register and return an Airwallex email. Refer to Update your Global Account for an example request and supported email format.
country_code
: Specify the region where the Global Account will be held.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.request_id
: Specify a unique identifier for the request.required_features
: Specify the supported currencies and transfer methods that you require for the region provided by passing an array of:currency
: Specify the currency that’s supported for the region provided.transfer_method
: SpecifyLOCAL
orSWIFT
depending on the region and currency.- Each currency may support either
LOCAL
,SWIFT
, or bothLOCAL
andSWIFT
transfer methods. - The Global Account opened may support more than the specified transfer_method. Specifying
LOCAL
for a particular currency may open a Global Account that supports onlyLOCAL
, or bothLOCAL
andSWIFT
transfer methods.
- Each currency may support either
- See Supported regions and currencies to learn more about our supported transfer methods.
*Note:
- Applicable to Canada CAD Global Accounts only
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
),alternate_account_identifiers
- Global Account status (
ACTIVE
,INACTIVE
) - The
required_features
that was specified in the Open a Global Account API request - The
supported_features
of this Global Account, including the respectivetransfer_method
,local_clearing_system
,routing_codes
andtype
of eachcurrency
supported by the Global Account in an array.- Each currency may support multiple
transfer_method
and/orlocal_clearing_systems
, and in such cases, multiple objects of the same currency may appear in thesupported_features
array. - The
routing_codes
object specifies information such asbank_code
andbranch_code
of the correspondingtransfer_method
orlocal_clearing_system
. For example,FEDWIRE
andACH
routing_codes
will be returned in an array with different values underlocal_clearing_systems
for a US Global Account. - The
type
returned insupported_features
indicates the transaction type supported by the Global Account.DEPOSIT
: Supports receiving deposits for the respective currency and corresponding transfer method or local clearing system.DIRECT_DEBIT
: Supports direct debit payouts for the respective currency and corresponding transfer method or local clearing system.- When
DEPOSIT
andDIRECT_DEBIT
are both supported, this will be returned as two line items under thesupported_features
array.
- Each currency may support multiple
- Global Account financial institution details, including bank name, branch name, bank address, and SWIFT code
For further considerations related to Interac e-Transfer Autodeposit, please refer to this help article
Example request
If you are registered as a 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 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.
You may filter the results based on:
- Time period: indicating
from_created_at
andto_created_at
- Currency requested during Global Account opening:
required_features.currency
- Currency supported by the Global Account:
supported_features.currency
- Pagination: utilising
page_size
andpage
cursor - Status:
ACTIVE
,INACTIVE
,CLOSED