Overview of Scale

Learn how to use Scale, our solution for any business that needs to transact with multiple counterparties. Scale allows you to establish transactional relationships between yourself and your subsidiaries, business partners and clients, utilising a single platform to efficiently receive, convert and move funds.

Traditionally, transaction clearing between trading entities is limited by the efficiency of the underlying banking system. International collection and payout, particularly involving currency exchange, often incur unreasonable fees and charges, further plaqued by lengthy processing delays.

With Scale, your platform account and the counterparty accounts can be grouped together in the same ecosystem, allowing for quick fund transfers and efficient reconciliation between parties. Airwallex's feature-rich APIs allow platform customers to focus on building innovative business models, while improving operational efficiency and optimising fund management involving multiple currencies.

You can tailor your Scale experience according to your business requirements, including:

  • Registering your subsidiaries, business partners and clients for Airwallex accounts to get a set of capability required to facilitate your business transactions
  • Connecting your Airwallex account to another Airwallex account and defining the nature of this connection
  • Specifying how funds move from your account to the connected Airwallex account and vice versa.

Why use Scale?

With technology and digital innovation at our core, our Scale solution is catered towards serving the new economy.

Scale provides a tailored cross-border solution that is automated, efficient and transparent. Access our collection, FX conversion and global payment capability in a single platform and offer the same to your ecosystem. Scale is a comprehensive solution capitalising on an efficient and streamlined client onboarding process to onboard your ecosystem, creating seamless connections between your business and your counterparty accounts, enabling fast fund transfers between those accounts.

Scale gives both you and your users access to our best-in-class FX capabilities. Through direct connection to the interbank FX market and partnerships with world-class liquidity providers, we source and distribute competitive FX rates for our clients. Backed by our robust infrastructure and architecture, we offer a diverse set of FX products, ranging from SPOT to forwards, available as live or carded rates, supporting G10 as well as exotic currencies, equipping your platform with the relevant tools to better manage your FX risks.

Scale also allows you to receive, convert, and transfer funds between connected accounts, and pay out funds to bank accounts. With Scale, you are provided with a set of features that are customisable to support a broad range of business models, including:

  • Marketplaces
  • Invoicing / supply chain financing platform
  • Streaming services
  • Education platforms
  • On-demand services
  • Booking platforms
  • Travel and event providers
  • Software as a service (SaaS) platform

Scale can facilitate specific parts of your business as well. You can access our collection, conversion and payment services on a standalone basis.

The Scale offering is available to platforms and their counterparties located in all countries supported by Airwallex.

Registration

Register as a platform and create your platform account by submitting your business information via the online sign up form or by contacting us directly. Once your platform account is activated, you can start creating Airwallex accounts for your subsidiaries, business partners and customers via our API. Alternatively, Airwallex accounts can be created independently by your counterparties and subsequently connected to your platform account.

Define your Scale experience by determining the way you want to transact with your counterparties.

You can create a counterparty account via API by submitting the required information and documentation. Once a counterparty account is created, it will be connected to your platform account and your platform can carry out actions on behalf of the connected account in line with the authorisations provided, such as:

  • Account debits for the purpose of processing fees and charges
  • Account credits to pay commissions, proceeds of sale or refunds
  • Performing payments and withdrawals
  • Converting from one currency to another
  • Querying balances and transactional history including payment history, conversion history and deposit history

Case study - Marketplace platform

As a marketplace, you have merchants offering their goods or services on your platform. Use Scale to onboard your merchants into the Airwallex ecosystem allowing them to immediately receive sales proceeds, convert from sale currency to their home currency and withdraw to their bank account. Merchants may tap into these functionalities directly through Airwallex’s web portal, or you can simply adopt our API solution to merge our components into your user interface, allowing your merchants to indirectly access all of our product features.

Scale provides a complete set of customized solutions for you and your merchants. With Airwallex's flexible account system, the platform enables transparent management of end-to-end capital flows, while merchants have more control over collections, exchanges, and capital flows between virtual wallets and physical accounts. Scale unifies the management of transactions done via fragmented online and offline channels.

Scale is a comprehensive wallet solution built on top of our collection, FX conversion and global payments infrastructure, allowing you and your merchants to conduct pay-in, pay-out, funds conversion and view multi-currency wallet balances in one system. It also allows you to credit sale proceeds and charge fees from your merchants’ wallets in real-time (subject to the arrangements between you and your merchants).

Scale empowers marketplaces by supporting onboarding, establishing connections between accounts and real-time fund transfers at scale via API, seamlessly integrating the following processes:

  • Onboarding: Register merchants, suppliers and other entities onto the Airwallex network via API, with an optional express KYC process;
  • Connect: Establish connections between marketplace accounts to newly onboarded merchant accounts and automatically define the nature and operational rules of such connections (e.g. by default, platform is authorised to debit merchant’s account for fees, etc);
  • Transfer: Facilitate pay-in / pay-out transactions as per the agreements between platform and merchants, and take full advantage of Airwallex’s Collection / FX / Payment capabilities.

Scale from the marketplace's perspective

Scale is built and designed to support marketplaces’ requirements to process large volumes of transactions across multiple jurisdictions and currencies. Once merchants are onboarded, the system defines authorized relationships between the marketplace and merchants’ accounts, enabling real-time transaction functionality and wallet transfers to simplify settlement.

These real-time funds transfers are requested via an API and may include:

  • Account debit from merchants for processing charges and fees and sales refunds
  • Account credit to merchants for sales proceeds
  • Initiate wallet-to-wallet transfers between merchant accounts
  • Query balances and transactions history

Airwallex will be able to create merchant accounts and global accounts for merchants through an API.

Scale from merchant's perspective

Once an Airwallex account is created for the merchant, the merchant will have access to a multi-currency wallet that records and displays all transactional activities within the Airwallex system, and can be provisioned a global account that acts as a collection and disbursement portal to external bank accounts from our integrated bank partners. The Airwallex account allows merchants to transfer money into their global account and access our FX and payment capabilities which serves as a powerful node that handles the marketplace’s transactional demands, such as:

  • Wallet transfer from other Airwallex Accounts
  • Wallet transfer to other Airwallex Accounts
  • FX conversion within the Multi-Currency Wallets
  • Collection of funds from Bank Accounts
  • Fast/real-time disbursements to Bank Accounts

Case study - Invoicing / supply chain financing platform

As a global logistics warehouse operator, you offer your merchants a value-add service of supply chain financing to help them bridge the working capital settlement time gap between the purchase and sale of goods.

Airwallex’s Scale solution seeks to address the following pain points:

  • You, our platform client (the lender) has no control over the merchant’s (borrower) funds flow and repayment once inventory (the collateral) leaves the warehouse
  • Inefficient and manual onboarding of merchants (borrowers)
  • Complicated settlement relationship between multiple parties involving principals and interests of the loan

Our Scale solution equips you with the tools to strengthen your supply chain financing by providing:

  • Certainty and control over funds flow: Consolidate information and funds flow into one single ecosystem, allowing you to exercise a level of control and visibility over your borrower’s wallet. This will give you the flexibility to manage your supply chain financing process as the lender, with access to your borrower’s sales proceeds from the global marketplace and hence reducing the risk of default by the borrower. Such assurance also allows you to reduce costs of borrowing and offer more competitive pricing to your borrowers.
  • Integrated platform for platform and borrower: Efficient onboarding process and account creation for merchants via our Accounts API, integrating yours and borrowers accounts into one platform.
  • Global account: You can create global accounts for each borrower enabling them to collect proceeds locally and globally and optimise the efficiency of incoming fund flows.
  • Wallet debit and credit functionalities: Full access to control financing, repayments and fee charges as the lender
  • Friendlier user experience: Embed Scale features in your existing user interface through our API and minimise the user experience impact for your users (i.e. borrowers).

Get Started

Scale offers you access to the Airwallex API, allowing you to use it on behalf of connected accounts in line with authorisations provided by the account holders. Follow these simple steps to get started:

  1. Register your platform
  2. Register your transactional counterparties and connect their accounts with your own
  3. Start transacting

Step 1: Register your platform

Register as a platform and create your platform account by submitting your business information via the online sign up form or by contacting us directly. Upon successful completion of a brief compliance review period, your platform account will be activated and your IP address will be whitelisted. You will then be set to use the Airwallex API.

Airwallex will offer a standard tri-party agreement template to cover the legal relationship between Airwallex, your business and the counterparty for which you intend to create an account and connect with your own.

Step 2: Create and connect a counterparty account

Once your Platform account is activated, you will be able to create accounts for your subsidiaries, business partners and clients via the Accounts API. The counterparty account that you create via the Accounts API will be connected to your platform account and you will have authorisation to transact on behalf of the connected account using Airwallex's Scale APIs.

You can create a new account for your counterparty instantly by submitting three pieces of basic information: primary contact email address, confirmation of agreement to Airwallex's terms and conditions, and business name. The new account will subsequently be connected to your own account.

By confirming agreement to Airwallex's terms and conditions, you consent to the terms covering the tri-party relationship between Airwallex, your business and your counterparty, and in doing so, Airwallex is authorised to take action on the connected account according to your instructions.

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/accounts/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'Content-Type: application/json' \
-d '{
"account_details": {
   	"business_details": {
	    "agreed_to_terms":true,
	    "business_name":"your_buisness_name"
	}
},
"primary_contact": {
    "email": "your_accou[email protected]"
},
"request_id": "6D36D9C0-8F3C-4AF2-B81D-25DC14C60F5B"
}

The response includes the Airwallex account ID pertaining to the connected account, which you will use in the next steps.

By providing the account ID in the Update a connected account API, you can amend and submit account information along with the file IDs related to any supporting documents that you submit via the File Service API

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/accounts/160748422/update \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'Content-Type: application/json' \
-d '{
"account_details":{
	"business_details": {
	    "address": {
	        "address_line1": "200 Collins Street",
	        "address_line2": "200 Collins Street",
	        "postcode": "1111",
	        "country_code":"HK",
	        "state": "HK",
	        "suburb": "HK"
	    },
	    "attachments": {
            "business_documents": [
                {
                    "description": "description about your Registration certificate file",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCw0LjLvvIlHTFDkuJrliqHpnIDmsYIgJiBBV1jlr7nmjqXmlrnmoYggMTIuMjAueGxzeA==",
                    "tag": "REGISTRATION_CERTIFICATE"
                },
                {
                	"description": "description about your Certificate of Incorporation file",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCxEb2MxICgxKS5kb2N4",
                    "tag": "CERTIFICATE_OF_INCORPORATION"
                },
                {
                	"description": "description about your Annual report file",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCwtLnR4dF8xNTQ2NTk1NTY1",
                    "tag": "ANNUAL_REPORT"
                }
            ]
        }
	},
	"legal_rep_details":{
        "attachments": {
            "identity_files": [
            	{
                    "description": "nation_id front",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCwtLnR4dF8xNTQ2NTk1NTgw",
                    "tag": "NATIONAL_ID_FRONT"
                },
                {
                    "description": "nation_id back",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCwtLnR4dF8xNTQ2NTk1NTkx",
                    "tag": "NATIONAL_ID_BACK"
                }
                 
                ]
        },
        "nationality":"HK”
   		 }
 	}

Upon provision of all required information and documentation, you can submit the connected account for verification using our Submit account for activation API.

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/accounts/160748422/submit \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \

Airwallex will return a response containing full account information and will indicate any missing or invalid fields as appropriate.

Step 3: Transact on behalf of the connected account

Using the Airwallex account id of the account connected to your platform, you will be able to transact on behalf of the connected account in line with the authorisation level provided using the following endpoints:

  • Open a global account - submit a request to open a new global account for the connected account in your chosen currency. This account can be used for the purpose of receiving funds via the local clearing system or via SWIFT.
  • Create a new transfer - debit your platform’s wallet and move funds to the connected account’s wallet
  • Create a new charge or a new transfer on behalf your merchant - debit the connected account’s wallet to move funds to your platform’s wallet
  • Create a new conversion - debit the connected account’s wallet in one currency, convert funds to another currency and credit funds to the connected account’s wallet in the target currency
  • Create a new payment - debit the connected account’s wallet to payout to a bank account
  • Get balances - view the wallet balances of the connected account

Account Management

Creating accounts

Create Airwallex accounts for your subsidiaries, business partners and clients via the Accounts API. The counterparty account that you create via the Accounts API will be connected to your platform account and you will have authorisation to transact on behalf of the connected account using Airwallex's Scale APIs.

You can create a new account for your counterparty instantly by submitting three pieces of basic information: primary contact email address, confirmation of agreement to Airwallex's terms and conditions, and business name. The new account will subsequently be connected to your own account.

By confirming agreement to Airwallex's terms and conditions, you consent to the terms covering the tri-party relationship between Airwallex, your business and your counterparty, and in doing so, Airwallex is authorised to take action on the connected account according to your instructions.

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/accounts/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'Content-Type: application/json' \
-d '{
"account_details": {
   	"business_details": {
	    "agreed_to_terms":true,
	    "business_name":"your_buisness_name"
	}
},
"primary_contact": {
    "email": "[email protected]"
},
"request_id": "6D36D9C0-8F3C-4AF2-B81D-25DC14C60F5B"
}

The response includes the Airwallex account ID pertaining to the connected account, which you will use in the next steps.

By providing the account ID in the Update a connected account API, you can amend and submit account information along with the file IDs related to any supporting documents that you submit via the File Service API

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/accounts/160748422/update \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'Content-Type: application/json' \
-d '{
"account_details":{
	"business_details": {
	    "address": {
	        "address_line1": "200 Collins Street",
	        "address_line2": "200 Collins Street",
	        "postcode": "1111",
	        "country_code":"HK",
	        "state": "HK",
	        "suburb": "HK"
	    },
	    "attachments": {
            "business_documents": [
                {
                    "description": "description about your Registration certificate file",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCw0LjLvvIlHTFDkuJrliqHpnIDmsYIgJiBBV1jlr7nmjqXmlrnmoYggMTIuMjAueGxzeA==",
                    "tag": "REGISTRATION_CERTIFICATE"
                },
                {
                	"description": "description about your Certificate of Incorporation file",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCxEb2MxICgxKS5kb2N4",
                    "tag": "CERTIFICATE_OF_INCORPORATION"
                },
                {
                	"description": "description about your Annual report file",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCwtLnR4dF8xNTQ2NTk1NTY1",
                    "tag": "ANNUAL_REPORT"
                }
            ]
        }
	},
	"legal_rep_details":{
        "attachments": {
            "identity_files": [
            	{
                    "description": "nation_id front",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCwtLnR4dF8xNTQ2NTk1NTgw",
                    "tag": "NATIONAL_ID_FRONT"
                },
                {
                    "description": "nation_id back",
                    "file_id": "NWRiYjUzMTItNWY2MC00MDNiLWE4ZmUtOTllYjRjZGZhZmU4LHwsc2hlbnpoZW4sfCwtLnR4dF8xNTQ2NTk1NTkx",
                    "tag": "NATIONAL_ID_BACK"
                }
                 
                ]
        },
        "nationality":"HK”
   		 }
 	}

Upon provision of all required information and documentation, you can submit the connected account for verification using our Submit account for activation API.

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/accounts/160748422/submit \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \

Airwallex will return a response containing full account information and will indicate any missing or invalid fields as appropriate.

Connecting accounts

When you register a client, business partner or subsidiary via the Accounts API, the account created will automatically be connected to your own platform account and you will have authority to take action on behalf of the account created.

When an Airwallex account is created independently, the account can subsequently be connected to your platform upon request submitted by the account holder to [email protected]

Authorisation

Different levels of authority to take action on behalf of a connected account are provided at the time an account is connected to your platform.

In line with your business requirements, we can configure the appropriate level of authority between your account and your counterparty’s account.

Update account information

To update business information or information on the ultimate beneficial owners after an account is created, please contact [email protected]

Transacting

Receiving funds

Funds can be received from bank settlements into your platform wallet via the following actions:

  • Wallet top up

A wallet top up is executed by your business whereby funds are directed to the settlement account allocated to your Airwallex account. To get your settlement account details, use the Settlement accounts API and a response will be returned for each currency relevant to your platform account.

Sample code

curl -X GET \  http://api-demo.airwallex.com/api/v1/global_accounts?currency=USD&country_code=HK&nick_name=Wishcom&page_num=0&page_size=10 \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'Content-Type: application/json' \

  • Global account deposit

A global account deposit is executed by a payer to which you provide your global account details. You can open a global account and immediately receive your global account details using the Open a global account API.

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/global_accounts/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"account_name": "Airwallex",
"country_code": "GP",
"currency": "GBP",
"nick_name": "GBP in UK for Subsidiary Company ABC",
"open_id": "189109846",
"payment_methods": ["LOCAL"],
"request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2"
}'

Funds can also be deposited to a connected account via the above mentioned actions. To create a global account on behalf of your counterparty, you can use the on_behalf_of header along with the Open a global account API.

Sample code

curl -X POST \
http://api-demo.airwallex.com/api/v1/global_accounts/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIwZGE4YjVlMi0xZWNhLTRmN2EtODY4Ni1mNTYzOGUzZmFkZmQiLCJzdWIiOiIwZGZlMTgyNS05ODUxLTRjNDctOTNiMy1mMzViNTQzMDJiOTAiLCJpYXQiOjE1NDcwMDQyNjYsImV4cCI6MTU0NzAxNjI2Nn0.PPIM2Ve2VwCzPS2swa6L7JGzDC_i26Guls02YDzI668' \
-H 'x-on-behalf-of: 133097196' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"account_name": "Airwallex",
"country_code": "GP",
"currency": "GBP",
"nick_name": "GBP in UK for Subsidiary Company ABC",
"open_id": "189109846",
"payment_methods": ["LOCAL"],
"request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2"
}'

Any deposits to a global account will immediately reflect in the wallet upon settlement.

As designated accounts for users with local and global collections needs, global accounts support both domestic and global collections via local clearing systems and SWIFT. Domestic collections enable platforms and their counterparties to establish a local presence in their target markets, allowing them to collect local currencies (or other currencies supported by the domestic clearing system) in that particular jurisdiction. Global collections allow platforms to receive proceeds globally in supported currencies via SWIFT, giving it the maximum flexibility over funds collection in supported currencies regardless of its physical presence.

Global account domicileCollection typeSupported currenciesPayment types accepted
United StatesLocalUSDNacha, IAT
United KingdomLocalGBPFast Payments, BACS, CHAPS
GermanyLocalEURSEPA
Hong KongLocalUSD, HKD, CNH, EURCNH, HKD - CHATS, Faster Payments System EUR, USD - RTGS
Hong KongSWIFTUSD, HKD, CNH, EUR, JPY, AUD, CHF, CAD, GBP, SGD, NZDSWIFT
AustraliaLocalAUDBECS

Funds originating within the Airwallex ecosystem can be received into your platform wallet via the following actions:

  • Charges
  • Wallet transfers executed on behalf of a connected account.

As a platform, you can access deposit information for your own account using the Get list of deposits API. The same API can be used to view wallet deposits for a connected account in line with authorisation levels by using the on behalf of tag.

Charges

You can directly debit the wallet balance of a connected account and subsequently credit your own wallet in the same currency using the Create a new charge API. This action may support processing fees and charges from your clients or business partners. For example, if you are collecting a loan repayment from your counterparty, you can debit the repayment amount and the interest for the applicable time period separately. The Charges API facilitates efficient and precise reconciliation with respect to payment from debtors.

Sample code

curl -X POST \
http://awx-dev24:5882/api/v1/charges/create \
-H 'Content-Type: application/json' \
-H 'Postman-Token: 2ef4db00-9b61-414d-83f0-1c0b9ffeb6aa' \
-H 'cache-control: no-cache' \
-d '{
  "request_id":"d9af1814a6a14840461c9078c3225",
  "reference":"55667788",
  "amount": 9,
  "currency": "CNY",
  "reason": "travel",
  "source": "189109846"
 }'

As charges are debited and credited within the Airwallex ecosystem, rapid settlement of funds to the target wallet occurs.

Wallet transfers

Scale supports wallet transfers whereby your platform instructs a debit to your own wallet which is then credited to the wallet of a connected account in the same currency using the create a new transfer endpoint. This action may support payment of commissions, proceeds of sale or refunds.

Sample code

curl -X POST \
http://awx-dev24:5882/api/v1/transfers/create \
-H 'Content-Type: application/json' \
-H 'Postman-Token: 0b68f140-b40e-4966-8c82-25be3776eee6' \
-H 'cache-control: no-cache' \
-d '{
  "request_id":"d9af1814a6a14840461c9078c3125",
  "reference":"55667788",
  "amount": 19,
  "currency": "CNY",
  "reason": "travel",
  "destination": "189109846"
 }'

You can also instruct wallet transfers on behalf of a connected account subject to authorisation. For example, when your counterparty wishes to settle a fee with you, to reflect a record of this commercial activity, you can instruct Airwallex to debit the connected account wallet and credit your own wallet.

Sample code

curl -X POST \
http://awx-dev24:5882/api/v1/transfers/create \
-H 'Content-Type: application/json' \
-H 'Postman-Token: c9493a12-c8d6-4e7e-a422-cc9e38826992' \
-H 'cache-control: no-cache' \
-H 'x-on-behalf-of: 133097196' \
-d '{
  "request_id":"d9af1814a6a14840461c9078c3125",
  "reference":"55667788",
  "amount": 19,
  "currency": "CNY",
  "reason": "travel",
  "destination": "103164505"
}'

As wallet transfers occur within the Airwallex ecosystem, rapid settlement of funds to the target wallet occurs.

Currency conversion

Although FX risk is one of the major risks faced by global businesses, it is poorly managed given its complexities. To allow our clients to hedge against FX volatility, better manage their FX risks and maximise profitability, we offer an extended spectrum of FX services integrated with our solutions that are easily customisable to suit our customers’ requirements. Whether it is to protect e-commerce platforms against adverse FX movements when holding FX rates for international buyers while they shop online, or to empower online travel agencies to offer “guaranteed 24 hours rates” when customers book their holiday packages, our FX solutions powered by the FX Engine is designed to meet these needs.

Our FX conversions services are readily integratable with Scale and could be utilised in parallel to allow Sellers control over the timing, denomination, and amount of funds converted. Powered by our FX Engine, we provide real-time access to wholesale interbank rates for users, allowing them to access a variety of FX products as required by business models. We offer:

  • Live FX rates, SPOT & Forwards
  • Wholesale comparable rates
  • Carded rates
  • Single platform for FX and payout

As a platform, currency conversion may be triggered in two ways:

  1. Using the Create a new conversion API to transfer funds between your wallets

Sample code

curl -X POST \
'https://api-demo.airwallex.com/api/v1/conversions/create' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI4Mjg5NTRiNC02ZjgzLTQ1MTktYWZkOC00NmQ2MTViMjMxOTkiLCJzdWIiOiJlYWQzOWQzZS1lMWU2LTQ3MjUtOWE0OS1iYmNhYTM5Y2Y2MzUiLCJpYXQiOjE1NDcxMjAzMzQsImV4cCI6MTU0NzEzMjMzNH0.ZFI38fBQUE5g48ndrtoBbutXjmMBPJJDmLDYcofu66g' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"buy_amount": "10000",
"buy_currency": "USD",
"client_data": "string",
"reason": "Settling invoices",
"request_id": "67f687fe-dcf4-4462-92fa-203353a01d9d96",
"sell_currency": "AUD",
"settlement_date": "2018-12-11",
"term_agreement": true
  }'

  1. Using the Create a new conversion API on behalf of the connected account. You can simply use the same conversion code and add in the on behalf of header.

Sample code

curl -X POST \
'http://api-demo.airwallex.com/api/v1/conversions/create' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI4Mjg5NTRiNC02ZjgzLTQ1MTktYWZkOC00NmQ2MTViMjMxOTkiLCJzdWIiOiJlYWQzOWQzZS1lMWU2LTQ3MjUtOWE0OS1iYmNhYTM5Y2Y2MzUiLCJpYXQiOjE1NDcxMjAzMzQsImV4cCI6MTU0NzEzMjMzNH0.ZFI38fBQUE5g48ndrtoBbutXjmMBPJJDmLDYcofu66g' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-on-behalf-of: 133097196' \
-d '{
"buy_amount": "10000",
"buy_currency": "USD",
"client_data": "string",
"reason": "Settling invoices",
"request_id": "67f687fe-dcf4-4462-92fa-203353a01d9d96",
"sell_currency": "AUD",
"settlement_date": "2018-12-11",
"term_agreement": true
 }'

Currency conversion may also be triggered when creating a payment either from your own profile or on behalf of a connected profile using the Create a new payment API where the debit currency is different to the payment currency.

Sample code

curl -X POST \
https://api-demo.airwallex.com/api/v1/payments/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiMmJmYjcyMy0yZWFhLTQyZmItODkxYy04MDhhZDU2ZTdlMDkiLCJzdWIiOiJlYTgwYWM3MC02NjlhLTQwMWItOWMxZi0yMzFjMjYwNWNmNWEiLCJpYXQiOjE1NDcxNzc4MjAsImV4cCI6MTU0NzE4OTgyMH0.dIPFFYx-uLKloSBWalHXkcEMepqbpF6GgVYf9bGPZHE' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
  "beneficiary": {
	"additional_info": {},
	"address": {
		"city": "Melbourne",
		"country_code": "AU",
		"postcode": "3000",
		"state": "VIC",
		"street_address": "15 William Street"
	},
	"bank_details": {
		"account_currency": "AUD",
		"account_name": "Complete Concrete Pty Ltd",
		"account_number": "12750852",
		"account_routing_type1": "bpay_biller_code",
		"account_routing_value1": "252957",
		"account_routing_type2": "bpay_customer_reference",
		"account_routing_value2": "4805064560558",
		"bank_country_code": "AU",
		"bank_name": "BPay"
	},
	"company_name": "Complete Concrete Pty Ltd",
	"entity_type": "COMPANY"
},
"fee_paid_by": "PAYER",
"payer": {
  "additional_info": {
    "business_registration_number": "EU300503",
    "business_registration_type": "Partnership",
    "personal_email": "[email protected]",
    "personal_id_number": "1234567890"
  },
  "address": {
    "city": "Melbourne",
    "country_code": "AU",
    "postcode": "3000",
    "state": "VIC",
    "street_address": "15 William Street"
  },
  "company_name": "Example Company",
  "date_of_birth": "1976-08-26",
  "entity_type": "COMPANY",
  "first_name": "James",
  "last_name": "Smith"
},
"payment_amount": "19500",
"payment_currency": "AUD",
"payment_date": "2019-01-12",
"payment_method": "LOCAL",
"reason": "Education_Training",
"reference": "ID 480506456 Mali Wu Tuition CRN 4805064560558",
"request_id": "ET20181015120501496742-0000000000-0002",
"source_currency": "USD"
 }'

Payout to bank account

Scale facilitates cost effective and time efficient withdrawals and payments via Airwallex’s comprehensive global payment networks. We connect to domestic clearing systems in each of the jurisdictions in which we operate through partnerships with local and international banks, ensuring constant availability.

Scale allows platforms to make payments to a bank account in two ways:

  1. Use the Create a new payment API to trigger a debit to the platform wallet and trigger payment to a specified beneficiary. Optionally specify the bank account details of the intended recipient using the Create a new beneficiary API. If your account is configured to allow payments from your wallet on behalf of an entity other than yourself, you can also specify details of the payer using the Create a new payer API.

Sample code

curl -X POST \
https://api-demo.airwallex.com/api/v1/payments/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiMmJmYjcyMy0yZWFhLTQyZmItODkxYy04MDhhZDU2ZTdlMDkiLCJzdWIiOiJlYTgwYWM3MC02NjlhLTQwMWItOWMxZi0yMzFjMjYwNWNmNWEiLCJpYXQiOjE1NDcxNzc4MjAsImV4cCI6MTU0NzE4OTgyMH0.dIPFFYx-uLKloSBWalHXkcEMepqbpF6GgVYf9bGPZHE' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"beneficiary": {
	"additional_info": {},
	"address": {
		"city": "Melbourne",
		"country_code": "AU",
		"postcode": "3000",
		"state": "VIC",
		"street_address": "15 William Street"
	},
	"bank_details": {
		"account_currency": "AUD",
		"account_name": "Complete Concrete Pty Ltd",
		"account_number": "12750852",
		"account_routing_type1": "bpay_biller_code",
		"account_routing_value1": "252957",
		"account_routing_type2": "bpay_customer_reference",
		"account_routing_value2": "4805064560558",
		"bank_country_code": "AU",
		"bank_name": "BPay"
	},
	"company_name": "Complete Concrete Pty Ltd",
	"entity_type": "COMPANY"
},
"fee_paid_by": "PAYER",
"payer": {
  "additional_info": {
    "business_registration_number": "EU300503",
    "business_registration_type": "Partnership",
    "personal_email": "[email protected]",
    "personal_id_number": "1234567890"
  },
  "address": {
    "city": "Melbourne",
    "country_code": "AU",
    "postcode": "3000",
    "state": "VIC",
    "street_address": "15 William Street"
  },
  "company_name": "Example Company",
  "date_of_birth": "1976-08-26",
  "entity_type": "COMPANY",
  "first_name": "James",
  "last_name": "Smith"
},
"payment_amount": "19500",
"payment_currency": "AUD",
"payment_date": "2019-01-12",
"payment_method": "LOCAL",
"reason": "Education_Training",
"reference": "ID 480506456 Mali Wu Tuition CRN 4805064560558",
"request_id": "ET20181015120501496742-0000000000-0001",
"source_currency": "AUD"
 }'

  1. Pay on behalf of a connected account by specifying the Airwallex account ID of the connected account when using the Create a new payment API. This will trigger a debit to the connected account wallet and create a payment to a specified beneficiary.

Sample code

curl -X POST \
https://api-demo.airwallex.com/api/v1/payments/create \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiMmJmYjcyMy0yZWFhLTQyZmItODkxYy04MDhhZDU2ZTdlMDkiLCJzdWIiOiJlYTgwYWM3MC02NjlhLTQwMWItOWMxZi0yMzFjMjYwNWNmNWEiLCJpYXQiOjE1NDcxNzc4MjAsImV4cCI6MTU0NzE4OTgyMH0.dIPFFYx-uLKloSBWalHXkcEMepqbpF6GgVYf9bGPZHE' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-H 'x-on-behalf-of: 133097196' \
-d '{
"beneficiary": {
	"additional_info": {},
	"address": {
		"city": "Melbourne",
		"country_code": "AU",
		"postcode": "3000",
		"state": "VIC",
		"street_address": "15 William Street"
	},
	"bank_details": {
		"account_currency": "AUD",
		"account_name": "Complete Concrete Pty Ltd",
		"account_number": "12750852",
		"account_routing_type1": "bpay_biller_code",
		"account_routing_value1": "252957",
		"account_routing_type2": "bpay_customer_reference",
		"account_routing_value2": "4805064560558",
		"bank_country_code": "AU",
		"bank_name": "BPay"
	},
	"company_name": "Complete Concrete Pty Ltd",
	"entity_type": "COMPANY"
},
"fee_paid_by": "PAYER",
"payment_amount": "19500",
"payment_currency": "AUD",
"payment_date": "2019-01-12",
"payment_method": "LOCAL",
"reason": "Education_Training",
"reference": "ID 480506456 Mali Wu Tuition CRN 4805064560558",
"request_id": "ET20181015120501496742-0000000000-0003",
"source_currency": "USD"
}'

Supported payment currencies

By using the Supported currencies API, you are able to access a client-specific list of currencies that can be bought or sold. Where you select to debit a wallet in a currency which is different to the payment currency, a conversion will be triggered as part of the payment process. You can retrieve an indicative rate via the Get indicative quote API.

Sample code

supported currencies

curl --request GET \ --url 'https://api-demo.airwallex.com/api/v1/reference/supported_currencies' \ --header 'Content-Type: undefined' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q'

get indicative quote

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/rates/quote?buy_amount=10000&buy_currency=AUD&sell_amount=0&sell_currency=USD&settlement_date=2017-04-01' \
--header 'Content-Type: undefined' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q'

Formatting payment instructions

Under the Create a new payment section in API docs, we have provided a dynamic schema that will return required fields based on some key criteria that we need to determine the destination of the payment and the route it will take to reach that destination. Use this tool to retrieve bank account formats by country and payment method.

Sample code

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/payments/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
--data '{ \
"beneficiary": { \
"additional_info": { \
  "personal_email": "[email protected]" \
}, \
"address": { \
  "city": "Seattle", \
  "country_code": "US", \
  "postcode": "98104", \
  "state": "Washington", \
  "street_address": "412 5th Avenue" \
}, \
"bank_details": { \
  "account_currency": "USD", \
  "account_name": "John Walker", \
  "account_number": "50001121", \
  "account_routing_type1": "aba", \
  "account_routing_value1": "021000021", \
  "bank_country_code": "US", \
  "bank_name": "JP Morgan Chase Bank" \
}, \
"company_name": "ABC University", \
"date_of_birth": "1976-08-26", \
"entity_type": "COMPANY" \
}, \
"payer": { \
"additional_info": { \
  "business_registration_number": "EU300503", \
  "personal_email": "[email protected]" \
}, \
"address": { \
  "city": "Melbourne", \
  "country_code": "CN", \
  "postcode": "3000", \
  "state": "VIC", \
  "street_address": "15 William Street" \
}, \
"company_name": "Complete Concrete Pty Ltd", \
"entity_type": "COMPANY" \
}, \
"payment_amount": "10000", \
"payment_currency": "USD", \
"payment_method": "LOCAL", \
"reason": "travel", \
"reference": "PMT1936398", \
"request_id": "f17d267e-4b72-4b1d-9c3b-d3e1d7145161", \
"source_currency": "CNY" \
 }'

Managing contacts

Save payer and beneficiary details for future use via the Contact API. Specify the bank account details of an intended recipient using the Create a new beneficiary API. If your account is configured to allow payments from your wallet on behalf of an entity other than yourself, you can also specify details of the payer using the Create a new payer API.

Sample code

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/beneficiaries/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
--data '{ \
"beneficiary": { \
"additional_info": { \
  "personal_email": "[email protected]" \
}, \
"address": { \
  "city": "Seattle", \
  "country_code": "US", \
  "postcode": "98104", \
  "state": "Washington", \
  "street_address": "412 5th Avenue" \
}, \
"bank_details": { \
  "account_currency": "USD", \
  "account_name": "John Walker", \
  "account_number": "50001121", \
  "account_routing_type1": "aba", \
  "account_routing_value1": "021000021", \
  "bank_country_code": "US", \
  "bank_name": "JP Morgan Chase Bank" \
}, \
"company_name": "ABC University", \
"date_of_birth": "1976-08-26", \
"entity_type": "COMPANY" \
}, \
"nickname": "ABC University", \
"payment_methods": [ \
"LOCAL" \
] \
}'

create a new payer

Sample code

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/payers/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
--data '{ \
"nickname": "Complete Concrete Pty Ltd", \
"payer": { \
"additional_info": { \
  "business_registration_number": "EU300503", \
  "personal_email": "[email protected]" \
}, \
"address": { \
  "city": "Melbourne", \
  "country_code": "CN", \
  "postcode": "3000", \
  "state": "VIC", \
  "street_address": "15 William Street" \
}, \
"company_name": "Complete Concrete Pty Ltd", \
"entity_type": "COMPANY" \
} \
}'

Wallet balances

You can retrieve balances for your platform account and any accounts connected to your platform in line with authorisation levels. To retrieve your platform wallet balance, use the Get current balances API.

Sample code

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/balances/current' \
--header 'Content-Type: undefined' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q'

To retrieve wallet balances for accounts connected to your platform, use the on behalf of API by specifying the Airwallex account ID of the connected account

Sample code

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/balances/history?currency=USD&from_post_at=2018-10-01T00%3A00%3A00%2B0800&page_num=0&page_size=100&to_post_at=2018-10-07T00%3A00%3A00%2B0800' \
--header 'Content-Type: undefined' \
--header 'x-on-behalf-of: 133097196' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q'

Fee

Fees may be applied at an account and transaction level. For certain transactions, such as payments, you can determine which party (payer versus beneficiary) bears the fee applied by Airwallex . Your fee schedule will be based on a range of factors and can be tailored to fit your business model. You may contact us for additional details regarding your fee schedule.