**Last updated**: 31 July 2025 | [**Change log**](/products/smb/plugins/changelog/)

# Magento

SMB (Worldpay eCommerce)

Use the Magento plugin to easily 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.com/).

## Magento version support

Developed for Magento version 2.4

Info
You must have the latest version of PHP.

## How to get the plugin

1. Install the [Magento plugin](https://github.com/Worldpay/Worldpay-Ecommerce/tree/main/EmbeddedCheckout/Magento).
2. Ensure the resulting folder from the archive is named "WorldpayEcommerce" and that it contains the "Payment" folder.


## How to add the plugin to Magento

1. Access the merchant server via FTP/SFTP and go to the project where Magento is installed.
2. Go to "app/code/" and upload the "WorldpayEcommerce" folder. The folder path is "/app/code/WorldpayEcommerce".
3. Access the merchant server via SSH and go to the project root where Magento is installed.


Make sure you have the right permissions to run the following commands:


```
--- php bin/magento module:enable WorldpayEcommerce_Payment
--- php bin/magento setup:upgrade
--- php bin/magento setup:di:compile
--- php bin/magento setup:static-content:deploy
```

## How to configure your Magento plugin

1. Go to "Stores" in your [Magento interface](https://account.magento.com/customer/account/login).
2. Go to "Payment methods" and  scroll down.
3. Copy and paste your credentials and entity from your [dashboard](https://dashboard.worldpay.com/) into the Magento config screen as shown below:


![config1.png](/assets/config1.c6d64500fb228172f68d803d6c792c5048ccb0e7e66fd6c5abe1711c9edc8d4a.2851199a.png)

### Retrieve your credentials

1. Log into your [dashboard](https://dashboard.worldpay.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


![](/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


![](/assets/checkout-try.2fa1c4084e3eee2a0e59130da9912802f576d22bcb2fed84e2e2b6460a75220a.5e4dae80.png)

### Retrieve your `entity`

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


![](/assets/entity.5108dc92b9d02c90d2a45327a98b6d126b84067bf184bf78703b6d6d5be623ec.5e4dae80.png)

## Go live

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

1. Log into your [dashboard](https://dashboard.worldpay.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


![](/assets/creds-live.e0b0dff280bda136e190bc5839201a58a9da0c7285968f63fb5309e37dcaac76.5e4dae80.png)

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


![](/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 Magento config screen.
2. Copy and paste the credentials from your dashboard to the config screen. This time making sure they are going into the "Live" section.
3. Ensure the "debug" toggle is off.
4. You can now initiate a live transaction.


## Errors & where to find support

### Support

For any other issues or further support log into [dashboard](https://dashboard.worldpay.com/) and visit our support centre.