Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 13 Next »

This section describes installation and configuration of the Everifin paygate plugin for Prestashop ecommerce solution.

IMPORTANT UPGRADE NOTICE

  • Backup of Configuration - when upgrading from version lower than v1.1.0 to higher version, first manually backup settings (Client ID, Client Secret and Bank accounts).

  • Running Upgrade procedure - some version may require running upgrade procedure in Prestashop Admin environment. The details on how to do so are described further below in separate section. The description of the plugin version on the downloads page indicates if this is needed.

Prerequisites

  • PrestaShop 1.6+ (up to 8.0)

  • PHP 7.1.1 or later

Installation

  1. Download the module version here: Prestashop plugin versions

  2. From your PrestaShop administration, go to Module Manager.

  3. Click 'Upload a module' and select downloaded file.

  4. Wait for the module to be installed.

Plugin Configuration

After installing the Everifin module, you need to configure it with your Everifin account details:

  1. From your PrestaShop administration, go to Module Manager.

  2. Find the Everifin module and click 'Configure'.

  3. Fill in the following fields:

    • For each currency of the e-shop configure (if you received just one set of Client ID and Secret, populate the same values for all currencies):

      • Client ID: Enter your Everifin Client ID here (value provided by Everifin)

      • Client Secret: Enter your Everifin Client Secret here (value provided by Everifin)

      • Bank account: Enter a bank account where you would like to receive payments in this currency (use string without spaces).

        image-20240118-151830.png
    • Environment: Set this field to value Production if not specified otherwise by Everifin representative.
      Both testing and production access for our clients are being set up in our Production environment. Staging environment is used by clients only in special occasions - e.g. testing new custom development.

    • IP address whitelist: (Optional) This configuration is useful for live testing. By entering an IP address here you are able to restrict the payment method to be available only when accessing the e-shop web pages from provided IP address.

  4. Click 'Save' to save your changes.

Upgrading

Sometimes the new version of the plugin requires running the upgrade procedure in Prestashop Admin environment. If running upgrade procedure is required, it is indicated in the description on the downloads page. To run the upgrade procedure please follow these steps:

  1. install the new version of the plugin

  2. Go to Modules > Module Manager and find Everifin - Fast bank transfer plugin

  3. Run the Upgrade procedure. In some prestashop versions it is option in dropdown menu next to Configure button.

image-20240417-101202.png

In other version it might be directly the button:

image-20240417-103756.png

Usage

Once the module is configured, customers can select Everifin Fast Bank Transfer as a payment method during checkout. The module will direct them to complete the transfer through the Everifin platform.

Webhooks

This functionality is available since plugin version v1.2.5

This functionality allows merchant online store system to receive payment updates in the background instantly when the payment status changes and react on them automatically (order is updated). The online store gets the notification when it happens regardless the presence of the customer in the payment flow. In other words the merchant is getting the information about the payment even if the customer leaves the payment flow. For example, in case the customer finishes authorization of the payment in his bank successfully but then just closes the browser (or turns off the phone screen) normally the order in the online store stays in opened state and merchant would need to investigate the payment status. When webhooks functionality is used the online store will get the update in the background and plugin automatically moves the order to correct state.

Webhook Configuration

Webhooks can be configured on plugin configuration page:

image-20240417-121953.png

Webhook URL

Webhook URL needs to be copied and used in webhook configuration in Everifin Paygate Back Office. How to configure webhook in Back Office is described here:
https://everifin.atlassian.net/wiki/spaces/EPAD/pages/2740748296/Webhook+Definition#Defining-webhooks

Webhook Secret

The communication between Everifin server and the online store needs to be secured. The Webhook Secret is used to ensure requied level of security.

The secret needs to be generated in Back Office as described here: https://everifin.atlassian.net/wiki/spaces/EPAD/pages/2740125725/Webhooks+Security#Hook-secrets

After the generation the secret value needs to be copied and placed in Prestashop admin environment into the field “Webhook secret” (picture above).

Finally the configuration needs to be saved

  • No labels