Plugin Installation

Required Actions Prior to Installation:

• Log in to the Novalnet Admin Portal.
• Log in to your Shopware 5 admin panel.
• 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), please send us a mail to technic@novalnet.de with your merchant ID
• Ensure that you have created Access Keys for your account. If not, click on Create a New Access Key to generate them. For more details, refer here.

Installation

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

Step 1: Navigate to Configuration -> Plugin Manager in your shop admin panel.

Step 2: Navigate to Installed, and click Upload plugin.

Step 3: In the window overlay that appears, click Select and choose the file NovalPayment.zip included in the Novalnet Shopware plugin package. Click Upload plugin to upload.

Step 4: After uploading, click Install icon .

Step 5: Then, click Activate to activate the plugin.

Upgrading the Novalnet Payment Plugin

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

Updates (Local Update)

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

Step 1: Navigate to Configuration -> Plugin Manager and click Upload plugin as shown in Plugin Installation via Package.

Step 2: To update the latest Novalnet Payment plugin in your shop, click Local update icon.

Step 3: After plugin update, the latest Novalnet Payment plugin will be updated in your shop backend and click edit icon to navigate to the Novalnet Payment page.

Step 4: Now, select Configuration tab. You can view the configuration details here. Click Click here to Configure Novalnet API and choose the tariff ID from the Select Tariff ID drop down menu and Save the settings.

Step 5: Once above mentioned steps are done, logout and login the shop backend.

Global Configuration in the Shopware shop system

In your shop admin panel navigate to Configuration > Basic settings.

Next, navigate to Payment methods > Novalnet Payment.

Next, you will be forwarded to the Novalnet API Configuration page 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.
• Select 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

Click API Credentials and copy the API Signature (Product activation key) and Payment access key.

Paste the Product activation key & Payment access key and click Click here to Configure Novalnet API. Next, choose the Tariff ID from the drop down menu that you have created in the Novalnet Admin Portal for this Shopware shop system. Then click Save to update/save the changes.

Notification/Webhook configuration

In the Novalnet API Configuration page, on your shop admin panel, you will find your Notification / Webhook URL under Notification / Webhook URL Setup.

Click Click here to auto configure Notification/ Webhook URL in Novalnet Admin Portal to setup your Notification / Webhook URL in to the Novalnet Admin Portal.

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 of your project.

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

• Notification / Webhook URL - Required to keep the merchant’s database/system up to date and always synchronized with Novalnet (for example: up-to-date transaction status delivery).
• Allow manual testing of the Notification / Webhook URL - Click the toggle to enable and 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.

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.

Step 3: On the project details page click API credentials and click edit beside Allowed Domain(s).

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

Step 5: After adding the Domain name, the web URLs are listed under Allowed Domain(s).

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

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.

Next, select the preferred payment methods and click Update to activate them.

To use the Apple Pay payment method, go to Apple Pay -> Configure -> Add new domain in the Novalnet Admin Portal.

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://shopware.novalnet.de/.well-known/apple-developer-merchantid-domain-association

To use the PayPal payment method, configure the PayPal API details in the Novalnet Admin Portal.

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

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 5 checkout page. Navigate to Configuration -> Shop -> Payment methods.

Select a particular payment method on the left sidebar and click Active checkbox to activate the payment method. Click Save button to update/save the changes made.

Refer ADDITIONAL CONFIGURATION for more payment configurations.

Uninstallation

Disabling Novalnet payment methods

To disable Novalnet payment methods, navigate to shop backend and go to Configuration -> Payment methods. Select a preferred payment method on the left and disable it. Click Save.

Uninstalling the Novalnet payment plugin

To deactivate and delete the Novalnet Payment Plugin, navigate to Configuration -> Plugin Manager and click the icon.

After clearing the cache, click the delete icon to the right of the Novalnet Payment plugin as shown below.

Next, click Yes in the confirmation pop-up that appears. By uninstalling and deleting the plugin you agree to remove all the details saved in the plugin.