Install the Magento plugin

Installation

You can download the plugin from the official Magento marketplace or delivered by the Airwallex Merchant enablement team.

Older versions are available here

Install using Composer

Before you begin, make sure that you have installed Composer. In your command-line tool, go to the Magento folder and run the following commands:


1composer require airwallex/payments-plugin-magento
2bin/magento module:enable Airwallex_Payments // Enable the module
3bin/magento setup:upgrade // Install the module
4bin/magento indexer:reindex customer_grid
5bin/magento cache:clean // Clean Magento cache

Install manually

The Composer requirements still apply for manual installation.

Unzip Airwallex.zip and move contents to app/code.
In the Magento root directory, run two commands:

composer require mobiledetect/mobiledetectlib

composer require guzzlehttp/guzzle:^7.0

Upgrade to the latest version

Follow the steps below to upgrade your plugin to the latest version


1composer update airwallex/payments-plugin-magento
2bin/magento setup:upgrade
3bin/magento indexer:reindex customer_grid  # This command is required only during the first upgrade.
4bin/magento cache:clean
5bin/magento cache:flush

Connect your Airwallex account

Log in to your Magento admin panel.
In the left navigation bar, go to Stores > Configuration. In the menu, go to Sales > Payment Methods.
Click Configure in Airwallex section of Recommended solutions. on your Magent site. Click Airwallex API Setting within the Plugin you need to configure.
Select the mode you wish to connect with "Production" or "Demo". This will determine which account you use during connection
Click Connect via Airwallex log in
Complete the login with your relevant credentials

Connection Failed

The connection via login may fail if your store URL is not the same as the one provided during your Airwallex account registration. In such cases please follow the instructions below to connect via API Keys

Enter your Client ID, API Key and Webhook Secret Key obtained from your Airwallex account (please see where and how to obtain the credentials in the next section).
Choose the Mode > Demo if you wish to test before going live. If unselected, you will begin accepting payments with Airwallex immediately. Enter all details again for Demo mode. The new details will not remove the previously entered detail for Prod mode.
Select the Yes checkbox, if you wish to save logs for debugging purposes, and Save Config to proceed.

Magento Basic Settings

Retrieve API Keys and Webhooks

If you are using API keys to connect your Magento store and Airwallex, please follow the steps below to obtain your API keys and relevant webhook links.

In order to utilize Airwallex APIs API within the Plugin and let us take care of payment from your shoppers easily, you will need to get Airwallex’s API credentials as well as Webhook Secret Key from your Airwallex account.

Webhooks are used by Airwallex to communicate with your site. It provides information such as the status of the payment, and updates the order based on events associated with the payment.

To obtain the required credentials and assuming you have created your Airwallex account, please follow the steps below:

Go to the Account > Developer section on your Airwallex web app.

For sandbox testing please use your demo account here: https://demo.airwallex.com/app/login
For live production setup please use your usual Airwallex account here: https://www.airwallex.com/app/login

You can see and copy the required API credentials from the Developer Keys section “Client API key”
Below the Developer keys section, you can see and copy the required Webhook Secret Key from the Webhook section. This will later be copied into the required fields within the Airwallex plugin. To access the Webhook Secret Key, you will first need to click the reveal button and then enter your Airwallex account password to be able to copy and paste.

Was this page helpful?