Transcription

Worldpay Payments Plugin for Magento 2Installation guide1

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 2020Table of contents1. How to install the plugin . 31.1 Install the plugin using Composer . 31.1.1 Install the plugin from Packagist (recommended) . 31.2 Install the plugin after manual download. 52. Basic configuration . 63. Troubleshooting. 8If you need support . 102

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 20201. How to install the pluginThe Worldpay Payments Plugin for Magento 2 is hosted on GitHub and on Packagist.1.1 Install the plugin using ComposerPrerequisite: You must download Composer and install it on your machine.1.1.1 Install the plugin from Packagist (recommended)Please check the version you need to install from Packagist.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.You will see the following as an output:3

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 20201.1.2 Install the plugin from GitHubWe recommend the Packagist installation, but if you have issues with that download the plugin fromGitHub.Run following command to add the Worldpay GitHub repository to your composer.json file:composer config repositories.repo-name git itThe Worldpay GitHub repository is now added to your composer.json file:Run the following command to install the plugin. Please include the version to be installed:composer require sapient/module-worldpay: v2.3.4-rc0620You will see the following as an output:1.1.3 Install the plugin from GitHub branchDo this if Worldpay has provided a patch. To install the plugin from Github branch, please get the branchdetails from Worldpay. If the branch name is release-v2.3.4-rc0620, run following command:composer require sapient/module-worldpay:dev-release-v2.3.4-rc06204

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 2020In this case, the “dev” parameter informs Composer that you are trying to download the package from theGitHub branch. You will see the following as an output:After completing 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/magentocache:flush1.2 Install the plugin after manual downloadPlease follow these steps to perform a manual installation:1.Download the extension from the Magento marketplace (recommended).2.If you have any issues with the Magento marketplace, download the extension from GitHub.3.Unzip the file in a temporary directory.4.You must create an app/code/Sapient/Worldpay directory to hold the unzipped Magento filestructure mentioned in step 3.5.After completing the steps above, run the following command to refresh the Magento cache:php bin/magento setup:upgrade && php bin/magento setup:static-content:deploy -f && phpbin/magento cache:flush5

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 20202. Basic configuration6

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 2020The table below covers the basic configurations needed to test your first Worldpay payment:General configuration settingsDescriptionEnable Worldpay*When set to Yes, shoppers can processtransactions using the Worldpay Payment Gatewayat checkout.Environment Mode*Toggles between Test and Live modes. Set it to Liveafter testing is completed and before productionlaunch.Test URL*The Worldpay test environment’s URLLive URL**The Worldpay Live environment’s URL - which yourWorldpay support contact provides.Merchant Code*Your Worldpay merchant code, which yourWorldpay support contact provides.XML Username*Your Worldpay XML username, which you will findin the Worldpay Merchant Admin Interface.XML Password*Your Worldpay XML password, which you can set inthe Worldpay Merchant Admin Interface.All fields marked (*) are mandatory.All fields marked (**)are mandatory for production mode.To find out more about features and configurations, please refer to the Worldpay Payments Plugin UserGuide. You can also find out more on the Worldpay Payment Gateway Guide.7

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 20203. Troubleshooting Please refer to the User Guide to verify the plugin’s configurations You can also check the installation information at Worldpay General Error You can customize error messages. Find out more in the User Guide, under Worldpay Exception Codes Make sure Worldpay module is enabled, the correct environment mode is set and the correctenvironment URL has been updated under Stores/Configuration/Sales/Worldpay/General ted issue with error code 4Please verify your merchant code, XML username andXML password guration.Please check with Worldpay that IP address mapping hasbeen implemented correctly.Debugging modeYou must set “Enable Logging” to Yes nfiguration.Switch between Direct Integration and HPPMake sure you have set the appropriate “IntegrationMode” at ent side encryption not workingYou must set “Client Side Encryption Enabled” to Yesand the correct Public Key must be updated atStores/Configuration/Sales/Worldpay/Credit Card.CVC not displaying on Checkout formCheck that “Require CVC” is set Yes atStores/Configuration/Sales/Worldpay/Credit Card3DS1 not workingCheck that “Activate 3DS Authentication” and “Enable3DS1 Authentication” are set to Yes atStores/Configuration/Sales/Worldpay/Credit Card 3DSAuthentication.8

Magento 2 Installation Guide. Worldpay Payments Plug-In3DS2 not workingAugust 2020Please check that “Activate 3DS Authentication” and“Enable 3DS2 Authentication” are set to Yes and thatyou have set all the parameters under “Configure 3DS2”correctly at Stores/Configuration/Sales/Worldpay/CreditCard 3DS Authentication.Please refer to the User Guide to verify the pluginconfigurations and all other details.For more details, please refer to the online Worldpay 3DSFlex guide.Hosted payment page not workingMake sure that “Integration Mode” is set to Redirect atStores/Configuration/Sales/Worldpay/Credit Card.Also, check that “HPP Enabled” is set to Yes and thecorrect “Installation ID” has been updated atStores/Configuration/Sales/Worldpay/Hosted PaymentPage.Unable to save card for future usageCheck that “Saved Card” is set to Yes and that either“Enable Tokenization” or “Enable Merchant Tokens” isset to Yes .Refer to the User Guide to verify the pluginconfigurations and other details.Refer to the User Guide to find out more about various features.Note: For any issues not included in the table above, please contact your Worldpay support representativewith the following details to help them resolve the issue. Screenshot of the issue Screenshot of the particular admin configuration Plugin-specific log Worldpay.log Version of the plugin and Magento you are using9

Magento 2 Installation Guide. Worldpay Payments Plug-InAugust 2020If you need supportPlease get in touch with your Worldpay support contact. If they’re not available, call our customer serviceteam on 0800 096 3997.10

Magento 2 Installation Guide. Worldpay Payments Plug-In August 2020 10 If you need support Please get in touch with your Worldpay support contact. If they're not available, call our customer service team on 0800 096 3997.