Airwallex Integration Explained

There are three primary ways to integrate Airwallex with your external systems, each suited for different needs and technical capabilities.

Jul 1, 2024

There are three primary ways to integrate Airwallex with your external systems, each suited for different needs and technical capabilities.
💡 Three Integration Methods
  1. Native Integration: Direct, out-of-the-box connections.
  1. Zapier: Low-code/no-code automation for a wide range of apps.
  1. Webhook Integration: Flexible, real-time notifications for developers.

1. Native Integration

Airwallex provides direct, native connections with popular platforms, from accounting services to e-commerce.
Common Use Cases:
  • Processing invoice payments issued from Xero.
  • Handling customer checkouts on Shopify.
How to Connect:
The process is straightforward. You will typically log into your Airwallex web app, navigate to the integrations section, select the platform you want to connect, and follow the on-screen instructions to authorize the connection.
For a comprehensive list of available native integrations, see the official documentation.

2. Zapier

If your platform is not on the native integration list, Zapier offers a powerful low-code/no-code solution to connect Airwallex with thousands of other applications.
Zapier provides a wide variety of triggers (events that start a workflow) and actions (tasks that are performed) to help you automate your processes.
Supported Events:
The available nodes cover key events related to:
  • Card balance changes
  • Cardholder updates
  • Transactions
While Zapier covers many common scenarios, you may need to track other specific events. For the greatest flexibility, webhook integration is the best choice.
For more details, see the Airwallex integration page on Zapier.

3. Webhook Integration

Webhooks provide real-time push notifications from Airwallex to your application. This is ideal for handling events where the result doesn't immediately follow an API call, such as payment confirmations, chargebacks, or account status changes.

Available Event Types

You can listen to a comprehensive range of events, including:
  • Account status & capability
  • Transfers & Payouts
  • Online payments
  • Conversions & Deposits
  • Issuing (Cards)
  • And many more...
For a detailed list of all webhook events, refer to the developer documentation.

4 Steps to Create a Webhook

  1. Log into the Airwallex web app.
  1. Navigate to Developer > Webhooks to reach the summary page.
  1. Click Add Webhook to configure:
      • Notification URL: The endpoint in your system that will receive the notifications.
      • Events: Tick the boxes for the specific events you want to listen for (e.g., you can subscribe only to "payment created" and not "payment cancelled").
      • Note: The notification URL is the only destination field. If your endpoint requires an API token or other authentication parameters in the URL, this may require extra development effort to handle securely.
  1. (Optional) Use the "Test event" button in the demo environment to send a sample payload to your URL and verify your setup.

⚠️ Important Notes for Implementation

  • Use HTTPS: Always use a secure HTTPS URL for your webhook endpoint.
  • Acknowledge Events Promptly: Your endpoint should return a 200 OK status code as quickly as possible to acknowledge receipt. Perform any complex logic asynchronously to prevent timeouts.
  • Handle Retries: If your endpoint is unavailable, Airwallex will retry sending the notification several times over three days.
  • Handle Duplicate Events: Your system may occasionally receive the same event more than once. Use the unique id field in the event payload to make your processing idempotent and prevent duplicate actions.
  • Handle Out-of-Order Events: Airwallex does not guarantee that events will be delivered in the order they are generated. Use the created_at timestamp within the event payload to order events correctly on your end.