**Last updated**: 22 April 2026 | [**Change log**](/products/plugins/change-log)

# Install

## How to get the Plugin

1. Go to the [Worldpay Payments Cartridge for B2C Commerce](https://appexchange.salesforce.com/appxListingDetail?listingId=b84e930e-9eb7-49b6-9868-cfc251a0a7b7) page on Salesforce AppExchange.
2. Click "Get It Now" to be redirected to our public GitHub repository. Download the Worldpay Payments cartridge source code zip file.
3. Make sure the "app_storefront_base" and Worldpay Payments cartridge folders appear under the same folder.
4. Open jobs.xml in the source code zip file. The relative path will be similar to "salesforce-commerce-cloud-master/metadata/jobs.xml".
5. Replace the `context site-id` value in jobs.xml with your storefront name, written without spaces (e.g. `AccessImplementation`). You can find this on your Business Manager home page.


Site ID screenshot
details
summary
Need help installing? Click here for more guidance
* Use node version 14 or higher.
* Run `npm install`.
* Run `npm run compile:js` and then `npm run compile:scss`.
* Using the same folder you have saved all the cartridge folders in, create a dw.json file and add the following:



```
{

               "hostname" : "your-sandbox-hostname.demandware.net",

               "username" : "your username to log in to SFCC",

               "password" : "your password to log in to SFCC",

               "code-version" : "the code version to upload to",

}
```

* Upload the code to your environments (for example, using the Prophet Debugger extension for VS Code).


## How to configure the Plugin

1. Log into the Salesforce Business Manager interface and go to **Administration →  Sites →  Manage Sites**. Click on "Business Manager", then include `int_worldpay_access` in the cartridge list.
Make sure `int_worldpay_access` is in front of `bm_app_storefront_base` in the cartridge path of your site (e.g. `int_worldpay_access:bm_app_storefront_base`).


Business Manager cartridge path screenshot
1. Include `int_worldpay_access` in the cartridge list for your storefront by going to **Administration →  Sites →  Manage Sites**. Click on your storefront site and the "Settings" tab.
Ensure `int_worldpay_access` is in front of `app_storefront_base` in the cartridge path of your site (e.g. `int_worldpay_access:app_storefront_base`).


Storefront cartridge path screenshot
1. Go to **Administration → Site Development → Site Import & Export** and import the metadata folder as a zip file.
2. Click on the App Launcher icon in the top left corner and select "Merchant Tools".
3. Navigate to **Merchant Tools →  Site Preferences →  Site Custom Preferences** and click on "AWP-Core" in the "ID" column.


* Enter the merchant entity that your Worldpay Implementation Manager has given you. The merchant entity used for transactions is the same for Try and Live.


Merchant entity field
br
Note
You can choose to use two integrations for our Plugin, using our **Hosted Payment Pages (HPP) API** as well as our **Checkout SDK**.

Make sure your Worldpay Implementation Manager gives you your Checkout ID to be able to integrate to our Checkout SDK.

The steps above integrate using our HPP API. To integrate to our Checkout SDK alongside this, follow the additional steps below:

* Enter the Checkout ID provided by your Worldpay Implementation Manager in the "Worldpay Checkout ID" field.
* Set the "Worldpay Environment" to "try" for testing or "live" for production.


Checkout SDK fields
## Supported payment methods

The two integrations for our Plugin offer the supported payment methods and features below.

| 
|  | Hosted Payment Pages API  | Checkout SDK  |
| Visa |  |  |
| Mastercard |  |  |
| Amex |  |  |
| Google Pay |  |  |
| Apple Pay |  |  |
| Guest card and repeat payments (Customer Initiated Transactions - CITs) |  |  |
| Subscriptions and recurring orders (Merchant Initiated Transactions - MITs) |  |  |


## Confirm the Plugin settings

A successful import of the metadata makes the below custom preferences available:

Custom preferences screenshot
* Verify that you have imported "Worldpay" as a Payment Processor by going to **Merchant Tools → Ordering → Payment Processors**.


Payment Processors page screenshot
Apply button to confirm payment processor
* Verify that you have imported "Worldpay" as an available payment method by going to **Merchant Tools → Ordering → Payment Methods**.


Payment Methods page screenshot
## Enable 3DS authentication

You can enable 3DS authentication functionality to verify your customer's identity and meet the Strong Customer Authentication (SCA) requirements under the PSD2 regulation. Learn more about [when SCA applies](/products/3ds-sca-exemptions#when-sca-applies).

* Go to **Merchant Tools →  Site Preferences →  Site Custom Preferences** and click on "AWP-Core".
* Select "Yes" for the "Enable ThreeDs" field.


Enable ThreeDs field screenshot
## Enable subscription functionality

You can allow your customer to make subscription purchases by enabling recurring tokenization within the Salesforce Business Manager interface.

* Go to **Merchant Tools →  Site Preferences →  Site Custom Preferences** and click on "AWP-Core".
* Select "Yes" for the "allow Recurring Tokenization" field.


Allow Recurring Tokenization field screenshot
**Next steps**

[Optional configuration for your Plugin](/products/plugins/salesforce/configuration)
[Test and go live](/products/plugins/salesforce/testing-go-live)
[Manage your orders](/products/plugins/salesforce/manage-orders)
[View your customer's journey](/products/plugins/salesforce/customer-journey)