Woocommerce - Quick Setup | Novalnet Docs

  Quick Setup

This guide describes the quick installation procedure of Novalnet payment plugin in 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 plugin to get started with Novalnet on your WooCommerce site.:

Requirements:

PHP
7.4 - 8.1
WordPress
5.0 - 6.4.3
Woocommerce
4.0.0 - 8.5.2
woo-subscription
2.0.0 - 5.9.1
Novalnet Payment Plugin
12.6.3

Change Log

Version
12.6.3
Date
31.01.2024
Remarks
[Fix] Return URLs integrated with payment requests during tokenization for Credit Card and Debit Card payments [Fix] Order numbers are included in the callback event email for accurate transaction mapping [Fix] Apple Pay transactions are restricted to countries other than the non-shipping country [Enhanced] Built-in Sub-Resource Integrity (SRI) integrated for JavaScript files to improve security for preventing unauthorized modifications

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)
  2. Log in to your WooCommerce shop system.
  3. Make sure that you have extracted the payment plugin package from the zip file you have received. If you have received only the installation guide without the payment module package (zip file), please send us a mail to technic@novalnet.de with your merchant ID.

Plugin Installation

To install the Novalnet Payment Plugin, please go to your shop system and follow the steps below.

Step 1: Navigate to Plugins -> Add New in your shop admin panel as shown below


Step 2: Next to Add Plugins, click Upload Plugin.


Step 3: In the next window that appears, click Choose File and choose the file woocommerce-novalnet-gateway.zip included in the Novalnet Woocommerce plugin package. Click Install Now to upload it into your shop system.


Step 4: After the installation, click Activate Plugin as shown below


Upgrading the Novalnet Payment Plugin

You can get the updated plugin either directly from the WordPress forum, or by contacting our technical team or via Novalnet homepage.

Earlier version of the Novalnet payment plugin should be installed in the shop to synchronize with the WordPress forum update.

Follow the below steps to update the latest Novalnet payment plugin - WooCommerce via shop admin panel.

Step 1: Navigate to Plugins -> Installed Plugins in your shop admin panel as shown below


Step 2: Under the Novalnet payment plugin -> WooCommerce, click update now as shown below


Now, updated version of Novalnet payment plugin -> WooCommerce will be displayed as shown below


Step 3: After installing (or) up-grading Novalnet payment plugin - WooCommerce and click Configuration as shown below


Refer section Global Configuration in the WooCommerce shop system to configure your Novalnet merchant account details.

Global Configuration in the WooCommerce shop system

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

In your WooCommerce shop system navigate to WooCommerce -> Settings -> Novalnet Global Configuration. Enter the following keys as shown below:

  • Product activation key - a unique token for merchant authentication and payment processing.
  • Payment access key - a secret key assigned to each merchant which encrypts the data to avoid user manipulation and fraud.
  • Tariff ID - a unique identifier created based on the tariff type at Novalnet.

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 of your project to view the project details


Click API credentials, copy the API Signature (Product activation key) and Payment access key. Create a Tariff ID for each tariff type for the webshop.


Paste the Product activation key and Payment access key in the respective fields in your shop system. Next, choose the Tariff ID from the drop down menu that you have created in the Novalnet Admin Portal for this WooCommerce shop system.


Then click to update the changes.

Notification/Webhook configuration in the Novalnet Admin Portal

In the Novalnet Global Configuration page on your shop system you will find your Notification / Webhook URL under Notification / Webhook URL Setup as shown below


Click Configure to setup your Notification / Webhook URL in the Novalnet Admin Portal as shown below


After successful configuration, your shop Webhook URL will be linked with your Novalnet Merchant account which can be seen under Vendor script URL/ Notification & Webhook URL field under API credentials of your project as shown below


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


  • Webhook URL - Required to keep the merchant’s database/system up to date and synchronized with Novalnet (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 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 in the Novalnet Admin Portal. The domain must be valid (secured https://) website. Please follow the below steps to whitelist the domains under the single client key in the Novalnet Admin Portal.

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

Step 2: Navigate to the Projects menu and choose your project as shown below.


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


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


Step 5: After adding the Domain name, they 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 for additional payment method requests, please contact our sales team.

To activate the preferred payment methods for your website, navigate to Novalnet Admin Portal -> Projects -> Choose your project -> Payment Methods -> click Edit Payment Methods in the top right corner as shown below.


Next, select the preferred payment methods as shown below


To use the Apple Pay payment method, go to Apple Pay -> Configure -> 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 that verification file in your domain's root directory.

For example: the path should be, https://woocommerce.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 WooCommerce shop system

Soon after the activation of the payment methods in the Novalnet Admin Portal, you must enable these payment methods in your shop system to display them on your WooCommerce checkout page. Navigate to WooCommerce -> Settings as shown below


In the settings page, click Payments tab as shown below


Click Enabled to activate the preferred payment methods as shown below


Refer chapter ADDITIONAL CONFIGURATION for more payment configurations.

  • If you have any recommendations or suggestions for improvement, kindly share your thoughts with us on 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 uninstall the Novalnet Payment Plugin, please follow the steps below.

Step 1: Navigate to Plugins -> Installed Plugins as shown below


Step 2: Under the plugin Novalnet payment plugin – WooCommerce, click Deactivate as shown below


Step 3: After deactivating, click Delete.


Step 4: Click OK to confirm that you wish to uninstall and delete the Novalnet payment plugin permanently from your shop system.