**Last updated**: 10 April 2026 | [**Change log**](/access/products/smb/plugins/changelog/)

# WooCommerce

SMB (Worldpay eCommerce)

Use the WooCommerce Plugin to integrate your online store into Worldpay eCommerce.

Prerequisite
You must have a Worldpay eCommerce account with us and access to the [Dashboard Portal](https://dashboard.worldpay-bsh.securedataplatform.com/).

Compatibility
The Plugin is designed to function as the **only** active payment or checkout-related Plugin in your store. Using it together with other third-party Plugins performing similar functions may lead to conflicts and unexpected behavior.

If issues occur, we recommend you:

- deactivate all other payment, subscription, and checkout Plugins
- test with only the Worldpay Plugin enabled


br
*Go and watch our [video tutorial](https://www.youtube.com/watch?v=fxyCNlRE25s) on how to install the WooCommerce Plugin!*

br
## WooCommerce version support

Woocommerce version required at least: 8.4.0
Woocommerce version tested up to: 8.5.1
Wordpress required at least: 6.4.2
PHP version required at least: 7.4

## How to get the Plugin

1. Install the [WooCommerce Plugin](https://github.com/Worldpay/Worldpay-Ecommerce/tree/main/EmbeddedCheckout/Woocommerce).
2. Log in with your WooCommerce credentials.


### Retrieve your credentials

1. Log into your [dashboard](https://dashboard.worldpay-bsh.securedataplatform.com/).
2. Click on "Developer Tools".
3. Click on "API Credentials".
4. Choose "Try mode" and retrieve your credentials. You need:
  * your Try API username
  * your Try API password


![Dashboard Try username and password example screenshot](/access/assets/creds-try.d70152284bf1bd2581f9a280e401f6f1e86e1e66127550f890531250f23fb2a8.5e4dae80.png)

1. If you want to you use the embedded checkout, click on "Access Checkout". You also need:
  * your Try Checkout ID


![Try Checkout ID example screenshot](/access/assets/checkout-try.2fa1c4084e3eee2a0e59130da9912802f576d22bcb2fed84e2e2b6460a75220a.5e4dae80.png)

### Retrieve your `entity`

1. Log into your [dashboard](https://dashboard.worldpay-bsh.securedataplatform.com/).
2. Click on "Developer Tools".
3. You can find your `entity` next to "Entity" usually prefixed with "PO".


![Dashboard entity example screenshot](/access/assets/entity.5108dc92b9d02c90d2a45327a98b6d126b84067bf184bf78703b6d6d5be623ec.5e4dae80.png)

### Installing the WooCommerce Plugin

1. In your [WordPress Admin Dashboard](https://wordpress.com/log-in/), go to "Plugins" then click "Add New" then click "Upload Plugin"
2. Click "Install"
3. Once installed click "Activate"
4. Go to the "Payments" tab and tick the box to "Enable Worldpay"
![WordPress Payments tab, enable Worldpay box screenshot](/access/assets/config.ee66cb3eff2ebb4a05d1cb31cea6cd163ae0db28b03b69b6df01181bfe541433.72afc7f5.jpg)
5. Scroll down and enter your Worldpay Try username and password in the "Try API Credentials" section
![Try username and password form screenshot](/access/assets/woo_creds.9692fa01c65d0a64828b88071688ffd408274c7af1a85aaa09b6df783b5249dc.72afc7f5.png)
6. "Save changes"


### Setup recurring payments

You can offer subscription payments by navigating to "Settings" and then clicking on the "Subscriptions" tab in your [WooCommerce dashboard](https://wordpress.com/log-in/).

You can find full instructions on how to setup your recurring offering in the [WooCommerce subscription management guide](https://woocommerce.com/documentation/products/extensions/woocommerce-subscriptions/subscriptions-management/).

Among other things, the portal allows you to:

* edit button text
* set subscriber roles
* enable retries and customer notifications
* set a sales price - the initial charge that **is lower** than any subsequent amounts of the subscription e.g. promotions, offers etc.
* set a subscriptions price - the recurring subsequent amount you want to charge in the subscription
* set renewal schedules
* enable sign-up fees
* set free trial periods


## Testing

Note
Once you have configured your [WooCommerce Worldpay Plugin](https://wordpress.com/log-in/), you can take test transactions using our [test card numbers](/access/products/hosted-payment-pages/testing).

To view your test transactions, log into your [WordPress Admin Dashboard](https://wordpress.com/log-in/). Click on "Orders" where the test transactions appear.

![WordPress Orders tab screenshot](/access/assets/test.fa93e3db3bce839db0e60c9f2fe10bd5fc527bc308204c2e44a399222e3b34f9.72afc7f5.jpg)

## Go live

These are the steps you need to follow to go live:

1. Log into your [dashboard](https://dashboard.worldpay-bsh.securedataplatform.com/).
2. Click on "Developer Tools".
3. Click on "API Credentials".
4. Choose "Live mode" and retrieve your credentials. You need:
  * your Live API username
  * your Live API password


![Dashboard Live mode username and password example screenshot](/access/assets/creds-live.e0b0dff280bda136e190bc5839201a58a9da0c7285968f63fb5309e37dcaac76.5e4dae80.png)

1. If you are using embedded checkout, click on "Access Checkout" and get:
  * your Live Checkout ID


![Live mode Checkout ID example screenshot](/access/assets/checkout-live.673d3e98ff70f7fcc228b4be67a61fbd4a03c87d0d32d74e0b66b87303ddbab2.5e4dae80.png)

Your Live credentials and Checkout ID are different to any other Worldpay credentials you already have. The `entity` used for production transactions is the same for Try and Live.

1. Navigate to the WooCommerce "Payments" screen in your [WordPress Admin Dashboard](https://wordpress.com/log-in/).
2. Tick the "Enable live mode" box.
3. Copy and paste the credentials from your dashboard to the config screen. This time making sure they are going into the "Live API Credentials" section.
![Live API Credentials screenshot](/access/assets/woo_creds.9692fa01c65d0a64828b88071688ffd408274c7af1a85aaa09b6df783b5249dc.72afc7f5.png)
4. Ensure the "debug" toggle is off.
5. You can now initiate a live transaction.