Shopware6 - 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 shopware site.

Requirements:

PHP	8.1+
Shopware-6	6.5.0.0 - 6.5.8.4
Novalnet Payment Plugin	13.4.0

Change Log

Version	13.4.0
Date	12.12.2023
Remarks	[New] Implemented configuration options for On-hold and Completion payment statuses[New] Implemented Zero amount authorization for Apple Pay, Google Pay and Direct Debit ACH payments[Fix] Order update emails will dynamically display payment method name associated with an order[Fix] Console error when an undefined payment variable is processed during iFrame initialization

For previous version changelog, go to GitHub

To get started:

Log in to the Novalnet Admin Portal with your merchant account details (user credentials).
Log in to your Shopware 6 shop system.
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 plugin package (zip file), install the payment module via composer.

Plugin Installation

Plugin Installation via Composer

Follow the below steps to install the Novalnet payment plugin via composer from the shop root directory.

Step 1: Run the following command in your terminal to upload Novalnet payment plugin,

composer require novalnet/shopware6-payment

Step 2: Run the following command in your terminal to refresh Novalnet payment plugin and its status,

php bin/console plugin:refresh

Step 3: : Run the following command in your terminal to install, activate and clear the cache in Novalnet payment plugin

php bin/console plugin:install --activate --clearCache NovalnetPayment

Once you have installed the Novalnet payment plugin through composer, skip the section Plugin Installation via Package.

Plugin Installation via Package

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

Step 1: Navigate to Extensions -> My extensions in your shop admin panel as shown below

Step 2: Click Upload extension and choose the NovalnetPayment.zip file that is included in the Novalnet Shopware plugin package.

Step 3: Once uploaded, the Novalnet Payments plugin will be shown under Apps tab as shown below

Step 4: Now click on Install app link to install the Novalnet Payments.

Then click on the slide button to activate Novalnet Payments as shown below

Upgrading the Novalnet Payment Plugin

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

Earlier version of the Novalnet Payment plugin should be Installed in the shop to make the Store update.

Plugin Update via Composer

Update the Novalnet Payment plugin in your shop backend to the current version without changing the previous plugin configurations.

Follow the below steps to update the latest Novalnet payment plugin via composer from the shop root directory,

Step 1: Run the following command in your terminal to upload Novalnet payment plugin,

composer require novalnet/shopware6-payment

Step 2: Run the following command in your terminal to refresh Novalnet payment plugin and its status,

php bin/console plugin:refresh

Step 3: Run the following command in your terminal to update and clear the cache in Novalnet payment plugin,

php bin/console plugin:update --clearCache NovalnetPayment

Updates (Local Update)

Update the Novalnet Payment plugin in your shop backend to the current version without changing the previous plugin configurations.

A Shopware account is not required to update the Novalnet Payment plugin in your shop system.

Step 1: Navigate to Extensions -> My extensions and click Upload extension as shown in Plugin Installation via Package.

Step 2: Click icon under Novalnet Payments and then click Update to [version number].

Next, the updated version of Novalnet Payment plugin will be displayed in your shop backend (as shown in the image below).

Global Configuration in the Shopware shop system

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

In your Shopware 6 shop admin panel navigate to Setting -> Extensions -> Novalnet as shown below

Next, you will be forwarded to the Global Configuration page as shown below to enter the following keys:

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 choose your project as shown below

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

Paste the Product activation key and Payment access key in the respective fields in your shop admin panel. Next, choose the Tariff ID from the Select Tariff ID drop down menu that you have created.

Then click to update the changes.

Notification/Webhook configuration in the Novalnet Admin Portal

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

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

After successful configuration, your shop Notification / Webhook URL will be linked with your Novalnet Merchant account which can be seen under Vendor script URL/ Notification & Webhook URL field 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

Notification / Webhook URL Setup - 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 multiple domains under a particular project in the Novalnet Admin Portal. The domain must be a valid (secured https://) website. Please follow the below steps to whitelist the domains under a single client key in the Novalnet Admin Portal.

Step 1: Go to the Novalnet Admin Portal.

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 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, 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 below

Next, select the preferred payment methods as shown below

To use the Apple Pay payment method, go to Projects -> [Select desired project] -> Payment Methods -> 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://shopware6.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 the Novalnet Admin Portal as shown below

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

Payment Configuration in the Shopware shop system

After activating the payment methods in the Novalnet Admin Portal, you must enable these payment methods in your shop admin panel to display them on your Shopware 6 checkout page. Navigate to Settings -> Shop -> Payment methods as shown below

Available payment methods will be shown.

Click toggle to activate the respective 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

Readme procedures to display the Novalnet transaction details

To display the Novalnet transaction comments in shop order mail, follow the below steps,

Step 1: Navigate to Settings -> Shop -> Email templates -> Type -> choose the relevant status and click Edit to view the HTML section under Mail text.

Step 2: Add the code in the HTML block and click Save to save the changes as shown below

HTMLMIXED_TEXT

//Add the following code based on your wish in HTML block

{% set comments = '' %}
{% for transaction in order.transactions|sort((a, b) => a.createdAt <=> b.createdAt) %}
{% if transaction.customFields['novalnet_comments'] != '' %}
{% set comments = transaction.customFields['novalnet_comments'] %}
{% endif %}
{% endfor %}
{% if comments != '' %}
<br/><strong>{{"NovalnetPayment.text.commentsHeader"|trans}}</strong><br/>
{{ comments|replace({'/ ': "<br/>"}) | raw }}
{% endif %}

Based on the shop languages, you must configure the above mentioned code for respective Email template.

Uninstallation

Plugin Uninstallation via Composer

Follow the below steps to uninstall the Novalnet Payment Plugin via Composer from the shop root directory,

Run the following command in your terminal to uninstall the Novalnet Payment Plugin.

composer remove novalnet/shopware6-payment --update-with-dependencies

Plugin Uninstallation via Package

To uninstall the Novalnet Payment Plugin, please follow the steps below.

Step 1: Navigate to Extensions -> My extensions as shown below

Step 2: Then click Activated switch to deactivate Novalnet Payments as shown below

Step 3: To uninstall the Novalnet payment plugin, click Uninstall as shown below

Step 4: Click switch to remove all plugin data permanently and click Uninstall as shown below

Step 5: To delete the Novalnet payment plugin, click Remove as shown below

Step 6: In Pop up notification, click Remove as shown below