Novalnet Payment Module for Magento
Total Page:16
File Type:pdf, Size:1020Kb
Feringastr. 4 85774 Unterföhring Germany Tel: +49 89 9230683-19 Fax: +49 89 9230683-11 Installation Guide for Novalnet Magento Module Version Date Remarks 12.1.1 07.07.2021 [Fix] Adjusted the redirect payment methods to adapt to the latest shop version 2.4.2-p1 [Fix] Callback/Webhook order status update during credit payments [Fix] Invoice mail generation for every transaction captured for invoice payments in the shop admin For previous version changelog, go to https://github.com/Novalnet-AG/magento2-payment-integration-novalnet/blob/master/changelog.txt NOVALNET AG Tel.: +49 89 9230683-19 Board of Directors: Gabriel Dixon (CEO), Johnson Rajdaniel (CFO) Payment Institution Fax: +49 89 9230683-11 Chairman of the supervisory Board: Frank Haussmann Feringastr. 4 E-mail: [email protected] Commercial register number: HRB 167381 85774 Unterföhring Tax id: DE254954139 TABLE OF CONTENTS 1 QUICK SETUP .................................................................................................................................. 3 1.1 Module Installation .............................................................................................................................. 3 1.1.1 Module Installation via Composer ..................................................................................................... 3 1.1.2 Module Installation via Package ........................................................................................................ 4 1.2 Upgrading the Novalnet Payment Module........................................................................................... 5 1.3 Global Configuration in the Magento shop system .............................................................................. 7 1.3.1 Notification/Webhook configuration in the Novalnet Admin Portal ............................................... 8 1.3.2 Client key configuration in the Novalnet Admin Portal .................................................................. 10 1.4 Payment Activation in the Novalnet Admin Portal ............................................................................ 11 1.5 Payment Configuration in the Magento shop system ........................................................................ 13 2 TESTING AND GOING LIVE ............................................................................................................. 15 3 ADDITIONAL CONFIGURATION ...................................................................................................... 15 3.1 Additional configuration for all the payment methods ...................................................................... 15 3.2 Additional configuration for Credit/Debit Cards ................................................................................ 21 3.3 Additional configuration for Apple pay Payment ............................................................................... 22 4 MANAGING MAGENTO ADMIN PANEL .......................................................................................... 23 4.1 Order Management ............................................................................................................................ 23 4.2 Transaction Overview ......................................................................................................................... 23 4.3 Order details for Instalment payments .............................................................................................. 24 4.4 Confirming / Cancelling a transaction ................................................................................................ 25 4.5 Refunding an order ............................................................................................................................. 26 4.5.1 Full Refund ....................................................................................................................................... 26 4.5.2 Partial Refund ................................................................................................................................... 27 4.6 Refunding instalment orders .............................................................................................................. 29 5 UNINSTALLATION ......................................................................................................................... 29 6 TECHNICAL SUPPORT THROUGH NOVALNET .................................................................................. 30 NOVALNET AG Tel.: +49 89 9230683-19 Board of Directors: Gabriel Dixon (CEO), Johnson Rajdaniel (CFO) Payment Institution Fax: +49 89 9230683-11 Chairman of the supervisory Board: Frank Haussmann 2 Feringastr. 4 E-mail: [email protected] Commercial register number: HRB 167381 85774 Unterföhring Tax id: DE254954139 1 QUICK SETUP This guide describes the quick installation procedure of Novalnet payment module (this guide comes along with the module), to integrate it with your shop system and to start accepting payments worldwide. For this integration, a Novalnet merchant account is needed to accept Novalnet payments, so please make sure that you have received your merchant account details from our sales team. If not, drop a mail to [email protected] This Novalnet payment module package version (12.1.1) supports the following versions of Magento 2: 2.3.0 – 2.4.2-p1 To get started: 1. Log in to the Novalnet Admin Portal with your merchant account details (user credentials) and 2. Log in to your Magento shop system. 3. Make sure that you have extracted the payment module package from the zip file you have received. If you have received only the installation guide without the payment module package (zip file), install the payment module via composer. 1.1 Module Installation 1.1.1 Module Installation via Composer To install the latest Novalnet payment module via composer, please follow the below steps, Step 1: Run the following command in your terminal from the shop root directory composer require novalnet/module-payment Figure 1 Step 2: Run the following command in your terminal, to proceed further php bin/magento setup:upgrade Figure 2 Step 3: After upgrading, you will be asked to re-run the Magento compile command. To proceed further, execute the following php bin/magento setup:di:compile Figure 3 NOVALNET AG Tel.: +49 89 9230683-19 Board of Directors: Gabriel Dixon (CEO), Johnson Rajdaniel (CFO) Payment Institution Fax: +49 89 9230683-11 Chairman of the supervisory Board: Frank Haussmann 3 Feringastr. 4 E-mail: [email protected] Commercial register number: HRB 167381 85774 Unterföhring Tax id: DE254954139 Step 4: Execute the following command to deploy static-content files (images, CSS, templates and js files) php bin/magento setup:static-content:deploy -f Figure 4 Once you have installed the payment module through composer, skip the section 1.1.2 Module Installation via Package. 1.1.2 Module Installation via Package If the payment module is not installed through composer, please go to your shop system and follow the steps below to install. Step 1: Upload the contents of the NovalnetGateway folder (which you have extracted from the payment module package/zip file) into the Root_Directory as shown below Figure 5 Step 2: In your terminal, from shop root directory execute the following command to enable the Novalnet payment module. php bin/magento module:enable Novalnet_Payment Figure 6 NOVALNET AG Tel.: +49 89 9230683-19 Board of Directors: Gabriel Dixon (CEO), Johnson Rajdaniel (CFO) Payment Institution Fax: +49 89 9230683-11 Chairman of the supervisory Board: Frank Haussmann 4 Feringastr. 4 E-mail: [email protected] Commercial register number: HRB 167381 85774 Unterföhring Tax id: DE254954139 Step 3: To verify whether the Novalnet payment module has been activated properly, execute the following command. php bin/magento module:status Figure 7 Step 4: To get the changes reflected in the shop system follow the Steps 2 - 4 given in the section 1.1.1 Module Installation via Composer 1.2 Upgrading the Novalnet Payment Module To upgrade the latest Novalnet payment module from the Magento marketplace, please follow the below steps. If you have installed through composer, upgrade the module only through composer. If you have installed the module via package, upgrade the module only through file server. Step 1: It is recommended to take a proper backup before deleting the existing Novalnet payment module for disaster recovery. Step 2: To remove the Novalnet payment module, run the following command in your terminal from the shop root directory rm -rf app/code/Novalnet Figure 8 Step 3: Upload the contents of the NovalnetGateway folder into the Root_Directory as shown below Figure 9 NOVALNET AG Tel.: +49 89 9230683-19 Board of Directors: Gabriel Dixon (CEO), Johnson Rajdaniel (CFO) Payment Institution Fax: +49 89 9230683-11 Chairman of the supervisory Board: Frank Haussmann 5 Feringastr. 4 E-mail: [email protected] Commercial register number: HRB 167381 85774 Unterföhring Tax id: DE254954139 Step 4: To get the changes reflected in the shop system follow the Steps 2 - 4 given in the section 1.1.1 Module Installation via Composer If you are facing file permission issues while executing the commands in the terminal, please give full permission to following folders and continue the execution. app generated pub var Step 7: After Novalnet payment module installation, navigate to STORES Configuration as shown below Figure 10 Step 8: Navigate to SALES Payment Methods OTHER PAYMENT METHODS Novalnet