Alipay | EasyStore - Documentation | JoomShaper
SP Page Builder 6 is Here! Learn More →

EasyStore

Updated Last: 23 September 2025

Alipay

Alipay is a major third-party online payment platform established in China and is widely used for domestic and international transactions. The Alipay payment gateway provides a secure, efficient, and widely accepted payment method, making it a valuable tool for businesses looking to expand their reach and improve transaction processes.

Alipay browser payments are supported for transactions in the following currencies: AUD, CAD, EUR, GBP, HKD, SGD, USD, CHF, JPY, NZD, and CNY. 

Adding Alipay to Your Payment Options

  • Log in to your Joomla Dashboard and navigate to Components > EasyStore > Settings > Payments.
  • Within Payment Settings, locate the “Add Payment Method” button and click on it.
  • From the list of available payment methods, choose Alipay and click on the “Add” button.
  • This action will successfully add Alipay to the list of available payment options for your online store.

Configuring Alipay Integration

Once you have added Alipay to your payment method list, click on the "Setup" button right beside the Alipay payment method.

Alipay Payment Gateway

This action will prompt a popup screen to appear, allowing you to configure the plugin according to your preferences.

Alipay Payment Gateway

Title

Give your Alipay integration a title (e.g., "Alipay"). This user-defined title helps you identify this integration within your Joomla Dashboard.

Select Region

Alipay offers integration support for two regions: Asia and North America. Select the Asia option if your store is located in any Asian country, or choose North America if your store is based in any North American country.

Payment Environment

Choose between the "Sandbox" or "Production" payment environment depending on whether you want to test payments in a demo/test environment or process real transactions in a live environment.

How to Create an Application to Start With the Alipay Payment Gateway Integration

You must create an application on the Alipay Global platform to obtain the required Client ID, Private Key, and Alipay Public Key (for both Sandbox and Production environment). Follow these steps to create an account and log in to the Alipay Application dashboard:

  1. Visit the  Alipay developer console, and follow the compulsory steps to create your account.
  2. Log in to your newly created account and follow the instructions to complete the steps needed to reach the application creation stage. Create an Application.
    Alipay Payment Gateway
  3. Once the Application is created, click on it and navigate to Integration Settings.
    Alipay Payment Gateway
    You can find the Sandbox and Production tabs here to select your work environment.

How to Obtain Client ID for Sandbox/Production

Alipay Payment Gateway

From your Alipay Application dashboard, navigate to Integration Settings. You'll see two modes: Sandbox and Production. In the Integration Information section, you'll find your Client ID.

How to Obtain Private Key and Alipay Public Key for Sandbox/Production Mode

  1. In the Integration Settings of your Application dashboard, click on the “Set public key” button.
    Alipay Payment Gateway
  2. On the pop-up screen, you will find two options: one for Mac and one for Windows. Choose and download the appropriate Key Generation Tool for your operating system.
    Alipay Payment Gateway
  3. Once downloaded, extract the Key Generation Tool folder and locate and run the “Run” executable file.
    Alipay Payment Gateway
  4. After running the Run executable file, the Alipay Signature tool will appear. Click on the “New” button to obtain the Private and Public Key. Use this Private key while integrating the Alipay payment gateway in EasyStore. 
    (Please note that the Public key generated in the signature tool is NOT the Alipay Public Key needed for the integration in EasyStore) 
    Alipay Payment Gateway
  5. Now copy the Public Key generated in your Signature tool and return to the Alipay Application dashboard. Click on the "Set Public Key" button again. Paste the copied key in the given “Step 2” field and hit the "Submit" button.
    Alipay Payment Gateway
  6. You will see a success message at this point. Now click on the “View” button to view and copy your Alipay Public Key. This Alipay Public Key should be pasted onto your EasyStore’s Alipay Integration.
    Alipay Payment Gateway
    Users who have an account with the Antom payment solution can refer to the Antom documentation for instructions on obtaining their Client ID, Private Key, and Alipay Public Key.

Payment Instruction

If needed, supply your customers with any payment instructions or supplementary information. This could encompass details on completing a payment or any special instructions regarding Alipay payments.

After configuring the above settings, click Save & Close to save the integration. 

To make the Alipay payment method available for your online store, you need to add it to your list of payment methods from EasyStore > Settings > Payments. Learn more.