Gaming Store

Introduction

Welcome to Airwallex.

The Airwallex API is designed to be flexible and give you control in how and when you convert currencies, make payments and manage your accounts.

We recommend you read through the API Documentation in full to familiarise yourself with the features and workflows associated with the product. Demo account access can also be provided to you, and the Client ID and API key can be generated within Account settings > API keys in the Web Application.

For any assistance through the integration, your Airwallex Business Development Manager and your allocated Airwallex Client Integration Manager will be able to help guide you.

Getting Started

An example workflow is set out below for guidance on how the Airwallex API operates in practice.

In this example, we want to make a HKD$10,000 transfer in HKD to a beneficiary in HK, funded by an available account balance in USD.

1. Authentication

To begin you will need to obtain an access token to allow you to reach all other API endpoints. Using your unique Client ID and API key (these can be found in the API menu in the Airwallex Web Application) you can call the Authentication API endpoint. On success, an access token will be granted.

Example authentication request

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/authentication/login' \
--header 'Content-Type: application/json' \
--header 'x-client-id: W_ORsgAFTiuA9k2KuqZt8A' \
--header 'x-api-key: 8ac97c856c6d6cae7eb8fd05511f7a165be798d032381cb8026de7b4aa9aaee2e6312a8888a3474d783a40913ab6b55d'

Example authentication response

{
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q"
}

2. Get Balances

Before conducting a transaction, you may wish to query any balances you have available in your Airwallex account.

Example balances request

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

Example balances response

[
  {
    "available_amount": 100000,
    "currency": "USD",
    "pending_amount": 50000,
    "total_amount": 150000
  },
  {
    "available_amount": 0,
    "currency": "HKD",
    "pending_amount": 0,
    "total_amount": 0
  }
]

3. Get Quote

The Quote API will return a guaranteed rate for the currency pair you are looking to transact in.

A rate will return both the indicative rate and the amount of the prospective transaction.

A Quote will return a guaranteed rate for an agreed period of time.

Cart (0)

Introduction

Getting Started

1. Authentication

2. Get Balances

3. Get Quote