Log inGet started
Airwallex logo
Home
Online Payments
Treasury
Transactional FX
Payouts
Issuing
Scale
Open Banking
Developer Tools
API Reference
Home
Treasury
Overview
IntroductionGlobal Account Capabilities
Getting Started
Treasury Resources
Global AccountsLinked Accounts

Global Accounts

This guide describes how to open, update, and manage your Global Accounts for your Airwallex account.

Before you begin

Open 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 bank country where the Global Account will be held.
  • currency: Specify a currency that’s allowed for the country 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: Specify SWIFT or LOCAL depending on the country and currency.
  • request_id: Specify a unique identifier for the request

The response will contain the account details of the Global Account including:

  • Global Account ID
  • Global Account details, account_name, account_number, account_type(CHECKING, SAVING, CURRENT)
  • Global Account status (ACTIVE, INACTIVE, CLOSED)
  • Global Account capabilities including supported clearing_systems, payment_methods, and an indicator for direct debit payout support (support_direct_debit)
  • Global Account financial institution details, including address and branch name
  • Global Account routing_codes and swift_code

Example request

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/global_accounts/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_bearer_token>' \
--data '{ \
  "country_code": "US", \
  "currency": "USD", \
  "nick_name": "USD Account in US for Subsidiary Company ABC", \
  "payment_methods": [ \
    "LOCAL" \
  ], \
  "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" \
}'

Example response

{
  "account_name": "string",
  "account_number": "88888888",
  "account_type": "Checking",
  "capability": {
    "clearing_systems": [
      "ACH"
    ],
    "payment_methods": [
      "LOCAL"
    ],
    "support_direct_debit": true
  },
  "country_code": "GP",
  "currency": "GBP",
  "iban": "GB81LHVB04032900176471",
  "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",
  "institution": {
    "address": "Old Street Yard",
    "branch_name": "Wakatake ワカタケ",
    "city": "London",
    "name": "Saxo Payments A/S",
    "zip_code": "018982"
  },
  "nick_name": "GBP in UK for Subsidiary Company ABC",
  "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1",
  "routing_codes": [
    {
      "type": "sort_code",
      "value": "040329"
    }
  ],
  "status": "ACTIVE",
  "swift_code": "SXPYDEHH"
}

Retrieve details of your Global Account

Call Get global account by ID API by specifying Global Account ID in the endpoint URL.

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/global_accounts/<your_global_account_id>' \
--header 'Authorization: Bearer <your_bearer_token>'

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.

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/global_accounts?country_code=US&currency=USD&from_created_at=2017-04-01&nick_name=Tom&page_num=0&page_size=100&status=ACTIVE&to_created_at=2017-04-01T03%3A52%3A34%2B0000' \
--header 'Authorization: Bearer <your_bearer_token>'
On this page
  • Before you begin
  • Open a Global Account
  • Retrieve details of your Global Account