Log inGet started
Airwallex logo
Core API
Transactional FX
Back to home
OverviewChoose your payments solutionGet started with payments
Online payments
Online payments overviewGet started with online paymentsHosted Payment Page
Drop-in Element
Embedded Elements
Mobile SDK
Install the WooCommerce plugin
Enable and Configure Payment Methods
SpreedlyFrequently Asked Questions
Native API
Automatic Currency Conversion
Invoice integrations

Install the WooCommerce plugin

This page describes how to install the Airwallex Online Payments plugin for your WooCommerce store.

Before you begin

  • If you have not done so already, submit information about your online store via the Airwallex web app > Payments page to enable Online Payments capabilities and apply for the preferred payment methods you wish to offer to be enabled on your account.
  • Fill in all the required fields and send the PCI-SAQ-A form to your Airwallex Account Manager. If you are completing the process by yourself, please email the signed version to [email protected].
  • Obtain your Client ID and secret API Key from the Airwallex web app > Developer > API Keys page for your installation configuration. Please make sure you obtain keys for the correct account if you have multiple accounts. For more information, see Manage API keys.
Enable Payment Methods

Please ensure you have your preferred payment methods enabled on your Airwallex account before installing and activating the WooCommerce plugin

Install the plugin

Follow these steps to install the Airwallex Online Payments app for your WooCommerce store.

  1. Go to the Airwallex Online Payments plugin and click Download.SCR-20231204-plxp
  2. After completing the checkout process click Add to site SCR-20231204-pnht
  3. Add your website URL SCR-20231204-pnom
  4. Authorize the connection and your installation is complete

Configure API settings and Webhooks

  1. After installing and activating the plugin, click Airwallex API settings to configure the authentication details. Install WooCommerce - Step 2

Enter your Client ID and API Key from the Airwallex web app > Developer > API keys page. We recommend that you use a restricted API key to authenticate to the WooCommerce plugin. For information on restricted API keys and how to create them, see Restricted API keys. Install WooCommerce - Step 5a

Next, subscribe to our webhook events with the url displayed and add the webhook secret key to this screen. (This is a mandatory installation step)

  1. Configure webhooks for your WooCommerce plugin custom callbacks.

a. Log in to Airwallex web app > Developer > Webhooks. b. Add a webhook by specifying your notification URL and selecting the relevant webhook events for your business operation. We recommend that you subscribe to the following webhook events as shown below.WooCommerce - webhooks

Test mode (Sandbox)

Select Enable sandbox when you are using a demo Airwallex account’s Client ID and API keys to test transactions on your WooCommerce store.

Note that you must use your demo account details (Client ID and API key) in your API settings for sandbox testing.

Airwallex provides a sandbox testing account on an as-needed basis. Please contact [email protected] to request a demo account for testing. Provide your Airwallex registered company name and the payment methods you want to test using the demo account.

Enable and Configure Payment Methods

Set up the payment methods you want you offer, and customize how they are shown to your shoppers during checkout by following the steps here

Additional configuration

Risk configuration

Configure risk for your business using these steps.

  1. Log in to your Airwallex web app > Payments > Risk. WooCommerce - risk config Step 1
  2. Alter the risk score threshold to trigger risk assessments for suspicious transactions. WooCommerce - risk config Step 2

Theme Compatibility

Due to some customised themes, checkout pages may not render properly. If this happens to your site

  1. Please go to your wordpress admin site and select Plugins. Select Airwallex API settings under Airwallex Online Payment Gateway

  2. In the API settings page select Wordpress Page Shortcodes under Payment Form Template

Airwallex checkout pages will be created as official Wordpress pages under your pages. This will allow the payment elements to be embedded within your theme. You can also customise each of the pages accordingly under Pages in the admin panel

Screenshot 2023-09-25 at 6.49.08 PM

  1. Test your checkout page again
  2. If compatibility issues persist, please reach out via your Account Manager and we will be more than happy to assist.
On this page