Integration checklist
After successfully configuring your account and creating conversions in the demo environment, you can go live in the production environment.
Test in the demo environment
Set up your demo Airwallex account using the following guidelines and get started with testing.
API keys
- Log into the demo Airwallex web app and generate test API keys and obtain the unique client ID to make API calls. Note that if you have multiple accounts, you will need demo API keys for each account.
Account configuration
- Contact your Airwallex Account Manager to configure your Airwallex demo account. FX capabilities that are available for configuration include:
- Currencies, see Supported regions and currencies
- Conversion per trade:
- Min: $1 (default)
- Max: $5,000,000 (default)
- Conversion max value date:
- Trade days: SPOT, T+2 (default)
- Fund deduction mode (see Funding and settlement models):
- Pre-fund (default)
- Post-fund
- FX Product:
- Rates
- Quotes
Web app configuration
- Optionally, configure webhooks on the demo Airwallex web app . Follow the getting started with webhooks guide and review the webhook events you can listen to.
Integration
- Use demo API endpoints for your integration:
https://api-demo.airwallex.com/api/v1/
- Create conversions: See tutorial for creating conversions. See Error codes for troubleshooting steps.
- Create a payout with conversion using Rates or Quotes.
- Webhook tests: Ensure your subscribed webhook events are received and managed in your integration.
Reporting
- Download reports from Airwallex to learn about what data is available for your reporting. Learn more about our financial reports API and balance activity reports API
- You can retrieve your conversions using List all conversions API.
- If you decide to download reports programatically, use demo endpoints
https://api-demo.airwallex.com/api/v1/
Go live in the production environment
Set up your production Airwallex account using the following guidelines and get started with transacting live.
API keys
- Log into the production Airwallex web app to generate production API keys and obtain the unique client ID to make API calls. Note that if you have multiple accounts, you will need production API keys for each account.
Web app configuration
- If you have webhooks configured on the demo account, configure webhooks on the production Airwallex web app . Follow the getting started with webhooks guide and review the webhook events you can listen to.
Integration
- Update demo API endpoints to point to the production URLs:
https://api.airwallex.com/api/v1/
- Create conversions (Rates or Quotes) in the production environment. See Error codes for troubleshooting steps.
- Create a payout with an underlying conversion (Rates) or using Quotes.
- Webhook tests: Ensure your subscribed webhook events are received and managed in your integration.
Reporting
- If you are downloading reports programmatically, update to production endpoints
https://api.airwallex.com/api/v1/