Airwallex logo
Airwallex logo

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 Airwallex 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 .

Get started in sandbox

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. Enter your business email, name, business country, password and click Create sandbox account. Your sandbox account will be ready to use instantly.

Testing in the 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 organization or account. 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, follow these steps:

  1. Generate sandbox API keys: Navigate to Account > Developer > API keys in the sandbox web app and generate your sandbox API keys. For details, see Manage API keys.

  2. Obtain an access token by calling Obtain access token API in the sandbox environment. Specify your unique sandbox Client ID and API key generated in the web app in the x-client-id and x-api-key HTTP request headers, respectively.

    Shell
    1curl --request POST \
    2--url 'https://api-demo.airwallex.com/api/v1/authentication/login' \
    3--header 'Content-Type: application/json' \
    4--header 'x-api-key: <your_api_key>' \
    5--header 'x-client-id: <your_client_id>'

  3. Include the returned access token in the Authorization header as Bearer [token] to authenticate API requests.

    Shell
    1curl --request GET \
    2--url 'https://api-demo.airwallex.com/api/v1/balances/current' \
    3--header 'Authorization: Bearer <your_access_token>' \

When you're ready to switch to production, generate your production API keys by logging in to the Airwallex web app and update the API host in your API requests to https://api.airwallex.com/api/v1/.

Next steps

Use Simulation APIs: Test end-to-end integrations with simulation APIs for the following use cases.

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?