Access Worldpay
/
Plugins
/
Magento

Last Updated: 23 September 2024 | Change Log

Magento

Worldpay eCommerce merchants only

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.

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.
  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.

  2. Go to "Payment methods" and scroll down.

  3. Copy and paste your credentials and entity from your dashboard into the Magento config screen as shown below:

config1.png

Retrieve your credentials

  1. Log into your dashboard.
  2. Click on "Developer Tools".
  3. Click on "API Credentials".
  4. Switch between "Try mode" and "Live mode" and retrieve your username and password. You need:
    • a Try API username
    • a Try API password

Retrieve your entity

  1. Log into your dashboard.
  2. Click on "Developer Tools".
  3. You can find your entity under "Entity ID"

Go live

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

  1. Log into your dashboard and get your LIVE credentials (see steps below). You need:

    • a Live API username
    • a Live API password
    • an entity

    These will be different from any other worldpay credentials you have already.

  2. Navigate to the Magento config screen

  3. Copy and paste the credentials from your dashboard to the config screen. This time making sure they are going into the "Live" section.

  4. Ensure the "debug" toggle is off.

  5. You can now initiate a live transaction.

Errors & where to find support

Support

For any other issues or further support log into dashboard and visit our support centre.