# WooCommerce plugin installation guide

> Learn how to install the Antom Payments plugin for your WooCommerce store.

This guide will walk you through installing the Antom Payments plugin for your WooCommerce store.

## Supported features

The following table outlines the supported features of WooCommerce, allowing you to quickly access essential information regarding payment methods, transaction currencies, and regional availability, ensuring a smoother and more efficient plugin configuration experience.

| **Features** | **Features** |
| --- | --- |
| Merchant entity country/region | Hong Kong (China), Singapore, Australia |
| Payment methods & Shopper country/region | [Alipay (China)](https://docs.antom.com/ac/antomop/alipay_cn.md) |
| Payment methods & Shopper country/region | [Alipay HK (Hong Kong, China)](https://docs.antom.com/ac/antomop/aplusalipayhk.md) |
| Payment methods & Shopper country/region | [TrueMoney (Thailand)](https://docs.antom.com/ac/antomop/truemoney.md) |
| Payment methods & Shopper country/region | [Touch'n Go eWallet (Malaysia)](https://docs.antom.com/ac/antomop/touchngo.md) |
| Payment methods & Shopper country/region | [GCash (Philippines)](https://docs.antom.com/ac/antomop/gcash.md) |
| Payment methods & Shopper country/region | [DANA (Indonesia)](https://docs.antom.com/ac/antomop/DANA.md) |
| Payment methods & Shopper country/region | [Kakao Pay (South Korea)](https://docs.antom.com/ac/antomop/kakaopay.md) |
| Payment methods & Shopper country/region | [Toss Pay (South Korea)](https://docs.antom.com/ac/antomop/tosspay.md) |
| Payment methods & Shopper country/region | [NAVER Pay (South Korea)](https://docs.antom.com/ac/antomop/naverpay.md) |
| Payment methods & Shopper country/region | [Mastercard (SG/HK merchant entity, Global shopper)](https://docs.antom.com/ac/antomop/mastercard_mdx.md) |
| Payment methods & Shopper country/region | [Visa (SG/HK merchant entity, Global shopper)](https://docs.antom.com/ac/antomop/visa_mdx.md) |
| Features | Payment, Refund, 3DS authentication |
| Settlement Currencies (by region) | For Singapore merchants: SGD, USD |
| Settlement Currencies (by region) | For Hong Kong (China) merchants: HKD, USD |
| Settlement Currencies (by region) | For Australia merchants: AUD, USD |

## Install the plugin

Use the WordPress plugin directory to install the the Antom Payments plugin:

1.  Log in to WordPress as an administrator.
2.  In the left menu, go to **Plugins** > **Add New**.

![image.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724298331739-97ab64c0-52d1-449a-ad3f-ce6fed9967f6.png)

3.  Search for Antom Payments in the search bar on the right.
4.  Click **Install Now**.
5.  Click **Activate**.

## Create an Antom account

Follow the steps below to register your Antom account for WooCommerce business. 

> **Note**: Antom account for WooCommerce business has to be created by clicking the **Register new account** button. Account registered in other channels cannot be used for WooCommerce business.

### Step 1: Register an account

After installing and activating the plugin, click **Register new account** on the **Payments** page of the plugin to register an account, or click on this [registration link](https://dashboard.antom.com/global-payments/account/register?bizMode=ISV&isvBizScene=ISO_COMMON&registrationSource=WooCommerce) to register directly.

![1.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/ce87a4e5-8f4c-4cd4-86fe-35c275f15f52.png)

### Step 2: Activate your account

After registering your account, you need to activate it to obtain the required configuration information. Refer to the [Activate your account](#Lxef3) section for detailed process.

> **Note**: Activation approval generally takes 1-2 days to complete. Antom Dashboard cannot be switched to live mode until your account is activated. Before that, you can test your plugin in the sandbox, refer to [Test the plugin in the sandbox](#OPevG) for the detailed process.

## Configure the plugin

1.  Once your Antom account is activated, click **Connect your account** to enter the plugin's configuration page for the first time.

![image](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724071378831-45c79958-bf76-4caf-a5bd-d83ff4654d21.png)

2.  Click **Visit Antom** and switch your account to live mode to obtain the following configuration information:

-   **Live Mode Antom ClientId**: The unique ID assigned to your account in live mode.
-   **Live Mode Antom Public Key**: The public key provided to you in live mode.
-   **Live Mode Your Private Key**: The key used for authentication that matches the public key you configured on Antom Dashboard.

![2.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/0f0215e6-cfbc-485d-b0bc-9d160f7ed7e0.png)

Refer to [Antom Dashboard](https://docs.antom.com/ac/merchant_service/antom_dashboard.md#to4qC) for the detailed process.

3.  View the bound settlement card and settlement currency on the [**Settlement overview**](https://dashboard.alipay.com/global-payments/finance/overview) page.

Before initiating a transaction in live mode, ensure that you have completed the settlement card binding in Antom Dashboard and specified the corresponding currency on the plugin configuration page.

> **Note**: All the above operations need to be carried out in live mode.
>
> ![4.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/e961a503-1f2d-49fd-aa24-8c39a315c6f1.png)

## Configure the notification URL

After setting up the plugin configuration information, you need to configure the notification URL in live mode to receive payment notifications as following steps.

1.  Obtain the notification URL in the **Notify Url** option of the Antom Payments plugin.
2.  Set **alipay.ams.payments.payNotify** and **alipay.ams.payments.captureNotify** on [**Notification URL**](https://dashboard.alipay.com/global-payments/developers/iNotify) page in live mode.

![3.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/8bae1c03-1605-45c4-b746-7114d0fc8755.png)

> **Note**: All the above operations need to be carried out in live mode.
>
> ![4.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/36513634-d838-4295-ad3f-98df5dd4ef87.png)

## Go live

After completing the above configuration and checking the following items，you can use the plugin to initiate real transactions.

-   ✅Ensure you have completed a payment in sandbox and the order status has been successfully updated.
-   ✅Ensure the Enable Test option is unenabled on the plugin setting page.
-   ✅Ensure the payment method has been activated on Antom Dashboard [**Payment methods**](https://dashboard.alipay.com/global-payments/pay-methods) page.
-   ✅Ensure the notification address has been configured on Antom Dashboard [**Notification URL**](https://dashboard.alipay.com/global-payments/developers/iNotify) page.

### Test notification URL in live

In order to test whether you can receive the notification correctly in the live mode, you can initiate a payment request (such as ALIPAY\_HK). If you do not have an ALIPAY\_HK wallet to pay, you can wait until the payment expires (The default is 15 minutes; when you set the inventory expiration time, the payment expiration time is equal to your inventory expiration time). At this time, Antom will send a notification to your WordPress, setting the order status to FAIL.

-   If your notification configuration is correct, the order status will be set to FAIL after the deadline.
-   If the order status remains pending payment, it indicates that your notification may not be configured correctly. You need to check whether the notification URL, public/private key, and clientId on the plugin configuration page are consistent with those on the Antom Dashboard.

## Test the plugin in sandbox

Before you officially open the plugin to users, we recommend testing the plugin in sandbox mode, according to the following steps:

1.  Click **Connect your account** or **Settings** to access the plugin configuration page.

![image](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724311798345-64c69d6c-9c39-4472-ac6f-ace8a6709cd2.png)

2.  Check the **Enable Test Mode** box.

![image](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724137182405-c30d5902-5c60-40aa-8e72-7350f2f91cd6.png)

3.  Click **Visit Antom** to obtain configuration information in test mode. Refer to [Antom Dashboard](https://docs.antom.com/ac/merchant_service/antom_dashboard.md#kZRFb) for the detailed process.

> **Note**: Enable the test mode on Antom Dashboard to obtain configuration information for the test mode.
>
> ![5.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/afa29ccf-c9f6-49ba-99fe-5d1df3bf595a.png)

4.  Configure the [**Notification URL**](https://dashboard.alipay.com/global-payments/developers/iNotify) in test mode to receive payment notifications.
5.  Go to your store and add a product to your cart.
6.  Proceed to checkout.
7.  Enter the required billing details. We recommend using a real email address so that you can receive the order confirmation.
8.  Select the wallet payment provided by the Antom Payments plugin.
9.  Check the terms and conditions box.
10.  Click **Place order**. You'll be redirected to the code-scanning page. Use the wallet app scan the code and complete the payment.
11.  Sign in to your WordPress account as an administrator.
12.  Select WooCommerce in the left menu. Your test order is displayed with a **Processing** status. You can also view this order payment request in Antom Dashboard.

## Antom Dashboard

### Activate your account

After registering your account, log in to Antom Dashboard, click **Activate merchant account** on home page, fill in your business information in the displayed form, and submit it for approval to activate your account.

![6.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/b34ccdb3-7f1c-4a1d-bca9-368cccb11168.png)

Once your account is activated, the page will prompt you to **Switch to live mode**. Switch to live mode to obtain the live mode configuration information required to use the plugin.

![9.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/cae365f2-4833-4586-a3af-c3d821c210c9.png)

### Enable payment methods

After activating your account, Antom will automatically enable payment methods for you. You can view the activation status of payment methods through **Enable payment methods** on the home page.

![image](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724148307325-01e2a502-4bcd-4c97-87b7-c16116510163.png)

Once the payment method has been successfully activated, the status of the payment method on the [**Payment methods**](https://dashboard.alipay.com/global-payments/pay-methods) page will be displayed as **Activated**.

For payment methods that are not automatically activated, you can manually activate on this page.

![image](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724145462393-c0f48fe4-c59d-4bf3-ab39-b35cf6403f40.png)

Go to plugin settings page and enable the activated payment method.

![image.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1725516965715-43b694b8-3edc-4134-b879-25fed13bb76c.png)

You will then be able to view the payment method on the checkout page.

![image.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1725517332557-3967b73e-77be-4529-bb85-42946f471a24.png)

### Configure settlement plan

In live mode, you can change the settlement currency you need to use and bind the settlement card. Refer to [Antom Dashboard](https://docs.antom.com/ac/merchant_service/antom_dashboard.md#is5Ad) to change the settlement currency.

### Integration in live mode

When you initiate a payment in live mode, and the payment is successful, the **Integrate in Live mode** task will be marked as completed.

Congratulations! You have completed the configuration and use of the Antom Payment plugin. Enjoy the payment journey brought to you by Antom.

![image](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/1724148307325-01e2a502-4bcd-4c97-87b7-c16116510163.png)

## FAQs

**Q1: Why do I receive order\_is\_closed after payment, and the page does not redirect to the QR code scanning page?**

A: It is typically caused by a notification configuration error. Antom will send payment failure notification when a payment is deemed to have failed. WordPress plugin fails to correctly receive the verification notification, resulting in incorrect maintenance of the payment order status associated with this order, triggering an idempotent request.

You need to correct your notification and key configuration and initiate the payment again with the new order number.

**Q2:** **How can I obtain the Antom Public Key in plugi****n configuration page?**

A: Log in to Antom Dashboard and go to the [**Key configuration**](https://dashboard.alipay.com/global-payments/developers/iKeys) page.

-   If you want to obtain Live Mode Antom Public Key, click on the Test mode button to switch to live mode and obtain Antom public key.

![7.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/11457bf1-e30d-4b84-a9e7-a73074a89713.png)

-   If you want to obtain Test Mode Antom Public Key, click on the Test mode button to switch to test mode and obtain Antom public key.

![8.png](https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/84e431bc-306a-49f5-a241-17cf0d6f0a26.png)