Checkout with ShopeePay — WooCommerce Setup Guideline

Requirements

System requirements

  • WordPress and WooCommerce installed and active
  • Admin access to the WordPress dashboard (Plugins and WooCommerce → Settings)
  • A store currency and billing address 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

  1. In the WordPress dashboard, go to Plugins → Add Plugin.
  2. Search for checkout with shopeepay.
  3. Locate Checkout with ShopeePay by shopeepay and click Install Now, then Activate.

Option B — Upload manually

  1. Download the plugin zip file from https://wordpress.org/plugins/checkout-with-shopeepay/.
  2. In the WordPress dashboard, go to Plugins → Add Plugin and click Upload Plugin.
  3. Select the downloaded zip file, click Install Now, then Activate.

Step 2 — Confirm store General settings

  1. Go to WooCommerce → Settings → General.
  2. Confirm Store Address → Country/State and Currency options → Currency match the market you are onboarding to (e.g., Vietnam / VND).
  3. Click Save changes.

Step 3 — Locate ShopeePay under Payments

  1. Go to WooCommerce → Settings → Payments.
  2. Under Payment providers, find the ShopeePay row — it will show as Inactive immediately after plugin activation.
  3. Click Manage (or click on Enable to enable it first, then Manage to configure credentials).

Step 4 — Configure ShopeePay settings

On the ShopeePay settings page, fill in the following fields:

FieldDescription
Enable / DisableCheck Enable ShopeePay to activate this method at checkout.
TitlePayment method name shown to customers (default: ShopeePay).
DescriptionText shown below the payment option (Pay securely with your ShopeePay wallet.).
EnvironmentProduction or Sandbox/Test (as confirmed/issued to you).
Country / MarketMarket and currency for this store (e.g., Vietnam (VND)).
Client IDIssued by ShopeePay Integration Team.
Client SecretIssued by ShopeePay Integration Team — kept masked once saved.
Merchant IDIssued by ShopeePay Integration Team.
Store IDIssued by ShopeePay Integration Team.
Debug LoggingOptional — logs API requests/responses at 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 receives the payment notifications.

Step 5 — Save and verify connection

  1. Enter your Client ID, Client Secret, Merchant ID, and Store ID.
  2. Click Save changes.
  3. Use Test Connection to confirm the Connection Status turns green/successful.

Step 6 — Verify at checkout

  1. Add a product to the cart and proceed to Checkout.
  2. Confirm ShopeePay appears under Payment options, with the description text configured in Step 4.
  3. 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 are correctly entered/saved
  • Callback URL registered by ShopeePay Integration Team
  • Test Connection status is successful / green
  • ShopeePay appears as a selectable option at checkout
  • Test order redirects correctly to ShopeePay to complete payment

Troubleshooting

IssueLikely cause
ShopeePay not visible at checkoutMethod not enabled, or store currency/market not supported for the entered Country/Market.
Connection Status failsIncorrect Client ID/Secret, or wrong Environment (Sandbox vs. Production) selected.
No payment notification receivedCallback URL not registered by ShopeePay Integration Team.
Credentials rejectedMerchant ID, Store ID mismatch with the Client ID and key pair provided.