Checkout with ShopeePay — WooCommerce Setup Guideline
Requirements
System requirements
- WordPress with WooCommerce installed and active
- Admin access to the WordPress dashboard (Plugins and WooCommerce → Settings)
- Store's currency and country configured under WooCommerce → Settings → General
ShopeePay merchant account requirements
Before configuring the plugin, obtain the following from your ShopeePay Integration Team:
- Client ID: Client Key
- Client Secret
- Merchant ID: merchant_ext_id
- Store ID: store_ext_id
- Confirmation of environment (Sandbox/Test vs. Production) issued to you
Plugin
- Plugin name: Checkout with ShopeePay, published by shopeepay
- Installed via the WordPress Plugin Directory (no separate download needed)
Installation Steps
Step 1 — Install the plugin
There are two ways to install the plugin:
Option A — Install from WordPress Plugin Directory
- In the WordPress dashboard, go to Plugins → Add Plugin.
- Search for checkout with shopeepay.
- Locate Checkout with ShopeePay by shopeepay and click Install Now, then Activate.
Option B — Upload manually
- Download the plugin zip file from https://wordpress.org/plugins/checkout-with-shopeepay/.
- In the WordPress dashboard, go to Plugins → Add Plugin and click Upload Plugin.
- Select the downloaded zip file, click Install Now, then Activate.
Step 2 — Confirm store General settings
- Go to WooCommerce → Settings → General.
- Confirm Store Address → Country/State and Currency options → Currency match the market you are launching in (e.g. Vietnam / VND).
- Click Save changes.
Step 3 — Locate ShopeePay under Payments
- Go to WooCommerce → Settings → Payments.
- Under Payment providers, find the ShopeePay row — it will show as Inactive immediately after plugin activation.
- Click Manage to open its settings (or Enable to turn it on directly, then Manage to configure credentials).
Step 4 — Configure ShopeePay settings
On the ShopeePay settings page, fill in the following fields:
| Field | Description |
|---|---|
| Enable / Disable | Check Enable ShopeePay to activate the method at checkout |
| Title | Payment method name shown to customers (default: ShopeePay) |
| Description | Text shown under the payment option (default: Pay securely with your ShopeePay wallet.) |
| Environment | Production or Sandbox/Test, per credentials issued to you |
| Country / Market | Market and currency this store operates in (e.g. Vietnam (VND)) |
| Client ID | Issued by ShopeePay Integration Team |
| Client Secret | Issued by ShopeePay Integration Team — kept masked once saved |
| Merchant ID | Issued by ShopeePay Integration Team |
| Store ID | Issued by ShopeePay Integration Team |
| Debug Logging | Optional — logs API requests/responses to WooCommerce → Status → Logs |
Also note the Callback URL displayed at the top of the page — contact ShopeePay Integration Team to register the URL, so the store receive the payment notification.
Step 5 — Save and verify connection
- Enter your Client ID, Client Secret, Merchant ID, and Store ID.
- Click Save changes.
- Use Test Connection to confirm the Connection Status turns green/successful.
Step 6 — Verify at checkout
- Add a product to the cart and proceed to Checkout.
- Confirm ShopeePay appears under Payment options, with the description text configured in Step 4.
- Select ShopeePay and click Place Order to confirm the customer is redirected to complete payment.
Verification Checklist
- Plugin Checkout with ShopeePay is installed and activated
- Store Country/State and Currency match the target market
- ShopeePay shows Enabled under WooCommerce → Settings → Payments
- Client ID, Client Secret, Merchant ID, Store ID saved correctly
- Callback URL registered by ShopeePay Integration Team
- Test Connection returns a successful status
- ShopeePay appears as a selectable option at checkout
- Test order redirects correctly to ShopeePay to complete payment
Troubleshooting
| Issue | Likely cause |
|---|---|
| ShopeePay not visible at checkout | Method not enabled, or store currency/market not supported for the entered Country/Market |
| Connection Status fails | Incorrect Client ID/Secret, or wrong Environment (Sandbox vs. Production) selected |
| No payment notification received | Callback URL not yet registered by ShopeePay Integration Team |
| Credentials rejected | Merchant ID / Store ID mismatch with the Client ID/Secret pair issued |