Payment-Plugins SAP Commerce Cloud Quick Setup
Quick Setup | Novalnet Docs

 SAP Commerce Cloud

This guide describes the quick installation procedure of Novalnet payment module in your shop system and to start accepting payments worldwide. For this integration, a Novalnet merchant account is required, 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

Requirements:

Novalnet Payment Extension
1.1.0
SAP
2205

Change Log

Version
1.1.0
Date
30.06.2022
Remarks
[New] Implemented Online bank transfer payment
[Enhanced] Updated payment logo for sofort payment

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

Module Installation

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

Step 1: Upload the contents of the folder NovalnetGateway (which you have extracted from the payment module package/zip file) into your gitlab directory ${HYBRIS_BIN_DIR} -> Custom.

Step 2: To add the Novalnet payment module, in the manifest.json file in your root directory of SAP Commerce Cloud, include the below code within storefrontAddons section.

Step 3: To add Novalnet extensions in the shop, open < Root_Directory > /hybris/ config/localextensions.xml file and paste the following code as shown below.

Step 4: Navigate to Repository -> Repository URL, provide your SAP Commerce Cloud Git repository URL and click Save to confirm the changes.


Step 5: Then generate a new public key by clicking Regenerate and click Copy to Clipboard to copy the public key and past it into the configuration of your repository.


Step 6: Now, navigate to Builds -> Create in the SAP Cloud portal as shown below.


Step 7: In the Create Build page, provide the Name and Git Branch or Tag details in the fields and click Save to create the build.


Step 8: After the build is created, click Deploy to Environment under Builds as shown below.


Step 9: In the Deploy Build page, choose Initialize Database under Data migration mode. Finally, click Deploy to complete the installation.


Global Configuration in the SAP Commerce Cloud shop system

The main configuration occurs in your SAP commerce cloud shop system as well as in the Novalnet Admin Portal. In your SAP commerce cloud shop system navigate to Base Commerce -> Base Store -> < Store > -> Novalnet. Enter the following keys as shown below:

  • Product activation key - a unique token for merchant authentication and payment processing.
  • Payment access key - your secret key used to encrypt the data to avoid user manipulation and fraud.
  • Tariff ID - a unique identifier which is dynamically created based on the tariff type at Novalnet.
  • Client key - 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.


    • To get your Product activation key, Tariff ID and Payment access key, go to the Novalnet Admin Portal, navigate to Projects menu and click view icon on the right of your project to view the project details.


    Click API credentials tab, copy the API Signature (Product activation key), Tariff ID, Payment access key and Client key as shown below.


    Paste the Product activation key, Tariff ID, Payment access key and Client key in the respective fields in your shop system and click SAVE to update / save the changes made.


    Notification/Webhook configuration in the SAP Commerce Cloud shop system

    Novalnet Webhooks are used to communicate with your site. Webhook URL configuration is required to keep the merchant’s database/system up to date and synchronized with Novalnet (example: up-to-date transaction status delivery).

    For Webhook synchronization, navigate to Environments -> -> Services -> Storefront -> choose Properties tab. Add the Novalnet webhook URL csrf.allowed.url.patterns=(/novalnet/callback)$ in the properties field.

    Finally, click Save to update/save the properties.


    Notification/Webhook configuration in the Novalnet Admin Portal

    Configure the Webhook Endpoint URL into your Novalnet Admin Portal account by following the below steps,

    1. Copy the Webhook Endpoint URL from the shop admin panel and in the Novalnet Admin Portal navigate to Projects menu and choose your project.
    2. Go to API credentials and click Edit as shown below.

    3. Then paste the copied Webhook Endpoint URL into the Vendor script URL/ Notification & Webhook URL and click Update.

    The absolute path of the Webhook Endpoint URL must look like the below URL: http://www.yourwebsite.com/novalnet/callback

    Client key configuration in the Novalnet Admin Portal

    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.

    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


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


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


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


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


    Payment Configuration in the SAP Commerce Cloud shop system

    To view the Novalnet payment methods in the shop system, go to Price Settings -> Payment Modes. Select each payment method, and click the PROPERTIES tab.


    Set the status of Is Active as True to activate the preferred payment methods in the shop system. By default, the payment status will be set as False. Finally, click Save to save the changes.


    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.

    Uninstallation

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

    Step 1: Open the file path: < Root_Directory >/bin/platform in your terminal and run the below command to uninstall the Novalnet Payment Module.

    Step 2: To remove novalnetcheckoutaddon file from the shop, open the file path: < Root_Directory >/config/localextensions.xml and remove the below code under </extensions>.