How to install the plugin
The Worldpay Payments Plugin for Magento 2 is hosted on the
Use Composer to install the plugin
Prerequisite: You must
Use Packagist to install the plugin (recommended)
Check the version you need to install from
Run the following command:
composer require sapient/module-worldpay to install the updated version.
Or:
composer require sapient/module-worldpay: v2.3.4-rc0620 to install that specific version.
The following appears as an output:
Install the plugin from GitHub
We recommend the Packagist installation, but if you have issues with that then download the plugin from
Run following command to add the Worldpay GitHub repository to your composer.json file:
composer config repositories.repo-name git https://github.com/Worldpay/Worldpay- Magento2.4-AW.git
Run the following command to install the plugin, and include the version to be installed:
composer require sapient/module-access-worldpay: 2.4.1-rc1220
You will see the following as an output:
Install the plugin from GitHub branch
Do this if Worldpay has provided a patch. To install the plugin from GitHub branch, get the branch details from Worldpay. If the branch name is release-v2.4.1-rc1220 run the following command:
composer require sapient/module-access-worldpay:dev-release-v2.4.1-rc1220
In this case, the “dev” parameter informs Composer that you are trying to download the package from the GitHub branch. You will see the following as output:
After you complete the installation, run the following command to refresh the Magento cache:
php bin/magento setup:upgrade && php bin/magento setup:static-content:deploy -f && php bin/magento cache:flush
Install the plugin after manual download
For a manual installation, do the following:
Download the extension from the Magento marketplace (recommended).
If you have any issues with the Magento marketplace, download the extension from the GitHub.
Unzip the file into a temporary folder.
You must create an app/code/sapient/AccessWorldpay folder to hold the unzipped Magento file for the AccessWorldpay module and app/code/sapient/AccessWorldpayGraphQl folder to hold the unzipped Magento file for the AccessWorldpayGraphQl module structure mentioned in step 3.
After you complete the steps above, run this command to refresh the Magento cache:
php bin/magento setup:upgrade && php bin/magento setup:static-content:deploy -f && php bin/magento cache:flush
Basic configuration
After you've installed the extension, follow this menu path to configure it:
Go to Stores > Configuration > Sales > Access Worldpay.
The table below covers the basic configurations needed to test your first Worldpay payment.
| General configuration settings | Description |
|---|---|
| Enable AccessWorldpay* | Select Yes to use Access Worldpay to process transactions. |
| Environment Mode* | Toggles between Test and Live modes. Set it to Live after testing is complete and before the production launch. |
| Test URL* | The |
| Live URL | The Worldpay Live environment’s URL - Your Worldpay support contact provides this. |
| Merchant Code* | Your Worldpay merchant code, which your Worldpay support contact provides. |
| XML Username* | Your Worldpay XML username, which you will find in the |
| XML Password* | Your Worldpay XML password, which you can set in the |
| Enable Logging | If this is enabled, all requests and responses, along with other debug information, are logged in the Magento2Root/var/log/worldpay.log file. You should disable logging on production and enable it on staging for debugging. This may be a useful feature if you are troubleshooting. |
All fields marked (*) are mandatory.
All fields marked (**) are mandatory for production mode.
To find out more about features and configurations, see the Worldpay Payments Plugin User Guide. You can also find out more in the Worldpay Payment Gateway Guide.
Troubleshooting
Here are some basic ideas to help you identify and fix problems:
See the User Guide to verify the plugin’s configurations
You can also check the installation information at the
Worldpay Troubleshooting, General Errors sectionYou can customize error messages. Find out more in the User Guide, under AccessWorldpay Exception Codes
Make sure AccessWorldpay module is enabled, the correct environment mode is set and the correct environment URL has been updated under Stores/Configuration/Sales/AccessWorldpay/General Configuration.
| Issues | Troubleshoot |
|---|---|
| Authentication-related issue with error code 4 | Verify your merchant code, XML Username and XML Password at Stores/Configuration/Sales/AccessWorldpay/General Configuration. Check with Worldpay that IP address mapping has been implemented correctly. |
| Debugging mode | You must set “Enable Logging” to Yes under Stores/Configuration/Sales/AccessWorldpay/General Configuration. |
| Switch between Direct Integration and AccessCheckout (Web SDK) | Make sure you have set the appropriate “Integration Mode” at Stores/Configuration/Sales/AccessWorldpay/Credit Cards. |
| CVC not displaying on Checkout form | Check that “Require CVC” is set to Yes at Stores/Configuration/Sales/AccessWorldpay/Credit Cards |
| 3DS Flex not working | Check that “Activate 3DS Authentication” is set to Yes at Stores/Configuration/Sales/AccessWorldpay/Credit Card 3DS Authentication. See the User Guide to verify the plugin configurations and all other details. For more details, see the online |
| Unable to save card for future use | Check that “Save Card” is set to Yes at Stores/Configuration/Sales/AccessWorldpay/Credit Cards. See the User Guide to verify the plugin configurations and other details. For more details,see the online |
See the User Guide to find out more about various features.
Help
For any issues not included in the table above, contact your Worldpay support representative with the following details to help them resolve the issue:
Include a screenshot of the issue
Include a screenshot of the particular admin configuration
Plugin-specific log
Worldpay.log
The version number of the plugin and Magento you are using
