Magento - Quick Setup | Novalnet Docs

  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 sales@novalnet.de.

Download the latest version of the Novalnet module to get started with Novalnet on your Magento site.

Requirements:

PHP
7.3 - 8.2
Magento
2.3.0 - 2.4.7-p3
Novalnet Payment Plugin
13.4.0

Change Log

Version
13.4.0
Date
13.10.2025
Remarks
[New] EPC/SPC QR code implemented for Prepayment, Invoice, Invoice with payment guarantee and Instalment by Invoice payments [Removed]Sofort, Giropay and Barzahlen/Viacash payments - Order creation process handled from the shop admin panel.

For previous version changelog, go to GitHub

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.

  Module Installation

Module Installation via Composer

To install the latest Novalnet payment module via composer, please follow the below steps,

Step 1: Log in to Magento Marketplace with the username and password you used to purchase the extension.

Step 2: In the upper-right corner, click Your name -> My Profile and open the Access Keys page in your Marketplace account as shown below


Step 3: Make sure that you have Access Keys created for your Magento account, other wise click on the Create a New Access Key button, and the keys will be generated automatically.


Use the Public key as your username and the Private key as your password

Step 4: Go to My Purchases, find the Novalnet extension to install and click Technical Details as shown below.


Step 5: Run the following command in your terminal from the shop root directory composer require novalnet/module-payment


Step 6: Now, enter the Username and Password which you generated in the Step 3 for authorisation..


Step 7: Execute the following command to verify whether the Novalnet payment module has been appropriately activated php bin/magento module:status


Step 8: In your terminal, from shop root directory execute the following command to enable the Novalnet payment module. php bin/magento module:enable Novalnet_Payment


Step 9: Run the following command in your terminal, to proceed further php bin/magento setup:upgrade


Step 10: 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


Step 11: Execute the following command to deploy static-content files (images, CSS, templates and js files) php bin/magento setup:static-content:deploy -f


Once you have installed the payment module through composer, skip the section Module Installation via Package.

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


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


Step 3: To verify whether the Novalnet payment module has been activated properly, execute the following command. php bin/magento module:status


Step 4: To get the changes reflected in the shop system follow the steps 9-11 given in the Module Installation via Composer

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


Step 3: Upload the contents of the NovalnetGateway folder into the Root_Directory as shown below


Step 4: To get the changes reflected in the shop system follow the Steps 9 - 11 given in the section 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 5: After Novalnet payment module installation, navigate to STORES -> Configuration as shown below


Step 6: Navigate to SALES -> Payment Methods -> OTHER PAYMENT METHODS -> Novalnet and click Configure as shown below


Global Configuration in the Magento shop system

The main configuration occurs in your Magento shop system as well as in the Novalnet Admin Portal.

In your Magento shop system navigate to STORES -> Configuration -> SALES -> Payment Methods -> OTHER PAYMENT METHODS -> Novalnet and click Configure. Enter the following keys under Configuration as shown below:

  • Product Activation Key - a unique token which is used for merchant authentication and payment processing.
  • Payment Access Key - a secret key that encrypts the data to avoid user manipulation and fraud.

To get your Product activation key and Payment access key, go to the Novalnet Admin Portal, navigate to Projects menu and click icon on the right to view your project details as shown below


Click API credentials and copy API Signature (Product activation key) and Payment access key as shown below


Paste the copied Product activation key and Payment access key in the respective fields and click Activate in your shop system.

Next, choose the Tariff ID that you have created in the Novalnet Admin Portal for this Magento shop system. Tariff ID is a unique identifier created based on the tariff type at Novalnet. Select your preferred Tariff ID from the drop-down menu and click Save Config as shown below:


Payment Activation in the Magento shop system

To display payment methods on the shop checkout page, select Yes under the Display payment method drop down on the Configuration page. Saving the configuration settings will enable the payment methods activated in the https://admin.novalnet.de/


Notification/Webhook configuration in the Novalnet Admin Portal

In the Configuration section in your shop system you will find your Notification / Webhook URL under Notification / Webhook URL Setup. Click Configure to link your Notification / Webhook URL to the Novalnet Admin Portal as shown below.

Notification / Webhook URL is available as a default setting which is common for all stores.


After successful configuration, your shop Webhook URL will be linked with your Novalnet Merchant account in the Novalnet Admin Portal under Vendor script URL/ Notification & Webhook URL field of your desired project as shown below


In your shop system, you can additionally test the Webhook URL manually and send notification email to specific email address as shown below


  • Notification / Webhook URL - Required to keep the merchant’s database/system up to date and synchronized with Novalnet always (for example: up-to-date transaction status delivery).
  • Allow manual testing of the Notification / Webhook URL - Enable this to test the Novalnet Notification / Webhook URL manually. Disable this before setting your shop system into live, to block unauthorized calls from external parties.
  • Send e-mail to - Every execution will be sent as a message to the e-mail address defined in this field.

Client key configuration in the Novalnet Admin Portal

The client key is a unique key which is linked with your Novalnet merchant account to authenticate your client based requests. You need the client key to render the secure payment form and tokenize (temporarily) the sensitive information.

Novalnet allows client-side request(s) only from the whitelisted domains under a particular project so you must whitelist your domains in the Novalnet Admin Portal. The whitelisted domain should always be a valid (secured https://) website. Please follow the below steps to whitelist the domains in the Novalnet Admin Portal. You can configure multiple domain URLs under a single client key.

Step 1: Go to the Novalnet Admin Portal with your Novalnet merchant account details.

Step 2: Navigate to the Projects menu and click view icon on the right to view your project details as shown below


Step 3: On the project details page click API credentials and click shown below beside Allowed Domain(s) as shown below


Step 4: Paste your webshop URL in the Domain name field and click the + Add as shown in below


Step 5: After successfully adding the Domain name, the web URLs are listed under Allowed Domain(s) as shown below


Payment Activation in the Novalnet Admin Portal

All the Novalnet supported payment methods can be viewed here: www.novalnet.com/payment if you have questions about the payment methods or additional payment method requests, please contact sales@novalnet.de

To activate the preferred payment methods for your webshop, go to the Novalnet Admin Portal -> Projects ->choose your project ->Payment Methods -> click Edit Payment Methods in the top right corner as shown belowT


Next, select the preferred payment methods as shown below


You can also sort the payment methods in any order through "Drag and Drop" positioning. Finally, click Update to save them on the checkout page.


To use the Apple Pay payment method, configure the domain details by click Add new domain in the Novalnet Admin Portal as shown below


Then paste your shop domain for which you enable Apple Pay, and click Download verification file. You will need to host the verification file you downloaded at your domain's root directory.

For example: https://magento.novalnet.de/.well-known/apple-developer-merchantid-domain-association

Please note that if the .well-known directory is not available, you have to create it.

To use the PayPal payment method, configure the PayPal API details in Novalnet Admin Portal as shown below


To use the PostFinance payments, configure Ep2-Merchant ID details in Novalnet Admin Portal as shown below


Payment Configuration in the Novalnet Admin Portal

For additional payment configuration settings for each payment method, navigate to Novalnet Admin Portal -> Account -> Payment plugin configuration on the right. Then, choose the required payment methods, configure the additional payment settings and save the changes made.


Refer chapter ADDITIONAL CONFIGURATION for more payment configurations.

  • If you have any recommendations or suggestions for improvement, kindly share your thoughts with us to develop our payment module further technic@novalnet.de or call us at +49 89 9230683-19.
  • Are you happy with our service and support? Please spend a few minutes to share your success here

Uninstallation

To deactivate and delete the Novalnet Payment module, please follow the steps below.

Step 1: In your terminal, from shop root directory execute the following command to disable the Novalnet payment module, php bin/magento module:disable --clear-static-content Novalnet_Payment


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


Step 3: Run the following command in your terminal, to proceed further. php bin/magento setup:upgrade


Step 4: After this, re-run Magento compile command, and execute the following command php bin/magento setup:di:compile


Step 5: Execute the following to deploy static-content files (images, CSS, templates and js files) php bin/magento setup:static-content:deploy -f