Search...
APIJSLog inGet started in sandbox
Airwallex logo
Home
Platform APIs
Connected Accounts
Accounts
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewAPI
SDKs
Sandbox environment
Sandbox environment overview
Connected accounts
Deposits
Linked Accounts
Payments
Payouts
Issuing
Risk

Sandbox environment overview

Airwallex provides a sandbox environment, completely separate from the production environment, for testing your integration through simulations without using real money. It gives you access to all products in the web app and API (except Connected Account APIs) in a secure environment.

To test Connected Account APIs for Embedded Finance use cases, please contact the Airwallex Sales team .

Create a sandbox account

To create a sandbox account and get onboarded to Airwallex, click Get started in sandbox at the top right of this page or directly via the sandbox account creation link. Simply enter your business email, name, business country, password and click Create sandbox account. Your sandbox account will be ready to use instantly.

Testing in web app

After creating your sandbox account, you can log in to the web app in the sandbox environment using your sandbox credentials. After successfully logging in, you can simulate various product capabilities by creating test transactions. For example, you can navigate to Wallet > Conversions and convert balances in your Wallet from one currency to another. Note that your Wallet will be credited with funds in each currency to facilitate test transactions.

API Keys and webhooks

In the web app, navigate to Account > Developer > API keys to generate your sandbox API keys for testing APIs in the sandbox environment. You will need the sandbox Client ID and API key to obtain an access token, which grants you access to Airwallex API endpoints. For more details, see Testing APIs.

You can also configure webhook events to test notifications to your application on events that occur in your sandbox account. For details, see Test webhook events. We recommend that you whitelist IP addresses for the sandbox environment to receive webhook events successfully.

Testing APIs

To get started with Airwallex APIs in the sandbox environment, you must first obtain an access token using your unique sandbox Client ID and API key generated in the web app. Call the API access token API in the sandbox environment (API host: https://api-demo.airwallex.com/api/v1/) by specifying your Client ID and API key in the x-client-id and x-api-key HTTP request headers, respectively. The access token you receive must be included in the Authorization: Bearer [token] HTTP header to authenticate to Airwallex API calls.

When you're ready to switch to the production environment, generate your production API keys by logging in to the Airwallex web app in production and then generate a production access token. To start making live requests, update the API host to https://airwallex.com/api/v1/ and replace the sandbox access token with the production token.

API host

https://api-demo.airwallex.com/api/v1/ (sandbox)

https://airwallex.com/api/v1/ (production)

Simulation APIs

You can conduct end-to-end testing of your integration by simulating various use cases in the sandbox environment. Explore simulation APIs for:

As a platform account, you can call the simulation APIs on behalf of a connected account using the x-on-behalf-of header.

Was this page helpful?
On this page
  • Create a sandbox account
  • Testing in web app
  • Testing APIs
  • Simulation APIs
Was this page helpful?