PrestaShop 1.7 plugin


This technical manual is for installing and configuring MultiSafepay’s free plugin for integrating with Prestashop 1.7.

If you are still using the deprecated plugin, we recommend upgrading to the latest version as soon as possible.
Requirements

If you’re on PrestaShop 1.7.5 or lower, consider updating PrestaShop or use an older version (4.x) of our plugin which can be found in our PrestaShop GitHub repository.

Support

We support versions 1.7.6, 1.7.7, 1.7.8.

To use an older version of the plugin, see MultiSafepay GitHub – PrestaShop releases.

Contact us:

  • Telephone: +31 (0)20 8500 500
  • Email: [email protected]
  • GitHub: Create a technical issue

Installation

We recommend first installing the plugin in a test environment, following the PrestaShop 1.7 installation procedure. Always make a backup.
  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Modules > Module Manager > Upload a module.
  3. Select the Plugin_PrestaShop.zip file, and then click Configure.
  4. Clear your cache.

Configuration

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Improve > MultiSafepay, and enter your API key.
  3. On the Payment methods tab, enable the relevant payment methods.
  4. Click Save.

User guide

Backend orders

In the previous version of the plugin, PrestaShop backend orders were only created for MultiSafepay orders with Completed status. Now, a backend order is created for every order attempt, that is for MultiSafepay orders with Initialized status.

Checkouts

The plugin supports the PrestaShop core checkout and is compatible with most premium themes, unless you have a custom checkout.

Supported third-party modules

The following third-party modules are supported:

The Integration Team will do their best to provide support for third-party plugins and premium themes. Email [email protected]

Generic gateways

The plugin supports generic gateways, which redirect customers from your checkout to a MultiSafepay payment page. You can use them to integrate custom gift cards, or co-branded credit cards.

Configuring generic gateways

  1. Sign in to your Prestashop 1.7 backend.
  2. Go to Improve > MultiSafepay > Payment methods > Generic gateway.
  3. Set the relevant payment method gateway IDs and the gateway icon.

The generic gateway supports:

Gift cards

Generic gateways are particularly useful for integrating gift cards, including custom gift cards. This is because we don’t support all open-loop gift cards in our ready-made integrations and no closed-loop gift cards.

Co-branded credit cards

You can integrate Visa co-branded credit cards (Cartes Bancaires, Dankort, and V Pay), using the generic VISA gateway.

For the logo, see MultiSafepay GitHub – MultiSafepay icons.

Order flows

The plugin supports two flows for creating orders: before or after the transaction is completed.

Before flow

By default, order confirmation emails are sent before the payment is finalized.
You can disable this feature.

The status of abandoned payments changes to Cancelled.

After flow

Orders are created via a MultiSafepay notification to PrestaShop using the cart ID. After completing payment, the customer is redirected to your order confirmation page.
If the notification hasn’t been processed yet, a waiting page with a loader displays while the order is created.

Switching order flows

To change the flow you are using, follow these steps:

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Improve > Module manager > MultiSafepay.
  3. In the MultiSafepay module, go to the General settings tab.
  4. In the Create order before payment field, select the flow.
  5. Click Save.

Order flows

The plugin supports two flows for creating orders: before or after the transaction is completed.

Before flow

By default, order confirmation emails are sent before the payment is finalized.
You can disable this feature.

The status of abandoned payments changes to Cancelled.

After flow

Orders are created via a MultiSafepay notification to PrestaShop using the cart ID. After completing payment, the customer is redirected to your order confirmation page.
If the notification hasn’t been processed yet, a waiting page with a loader displays while the order is created.

Switching order flows

To change the flow you are using, follow these steps:

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Improve > Module manager > MultiSafepay.
  3. In the MultiSafepay module, go to the General settings tab.
  4. In the Create order before payment field, select the flow.
  5. Click Save.

Payment components

The plugin supports payment components, which:

  • Provide a seamless checkout experience to increase conversion.
  • Encrypt customer payment details for secure processing.
  • Shift responsibility for PCI DSS compliance to MultiSafepay.
Activating payment components

If you’re new to accepting credit card payments, email a request to activate them to [email protected]

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to MultiSafepay module > Payment methods > Credit card.
  3. Slide the Enable payment component radio button to Enabled.
  4. Click Save config.

For support, email [email protected]

Note: If you have a custom checkout and encounter a conflict with the payment component, the Integration Team will do their best to provide support, but we can’t guarantee compatibility in all cases.

Payment methods

Payment methods

  • Cards: All
  • Banking methods: All
  • Pay later methods: All
  • Wallets: All
  • Prepaid cards:
    • Baby Giftcard
    • Beauty and wellness
    • Boekenbon
    • Degrotespeelgoedwinkel
    • Fashioncheque
    • Fashion gift card
    • Fietsenbon
    • Gezondheidsbon
    • Givacard
    • Good4fun
    • Goodcard
    • Nationale tuinbon
    • Parfumcadeaukaart
    • Paysafecard
    • Podium
    • Sport en Fit
    • VVV gift card
    • Webshop gift card
    • Wellness gift card
    • Wijncadeau
    • Winkelcheque
    • Yourgift

Recurring payments

Enabling recurring payments

To enable Recurring Payments, follow these steps:

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Improve > Module manager > MultiSafepay.
  3. In the MultiSafepay module, go to the Payment methods tab.
  4. Select either the bundled credit cards gateway, or select specific credit cards.
  5. Set the Enable tokenization toggle to Enabled.
  6. Click Save.

Refunds

Full and partial refunds are supported in your MultiSafepay dashboard and backend.
Pay later refunds are only supported in your dashboard.

Disabling API refunds

By default, refunds initiated in your backend are automatically processed via our API, except for voucher refunds.

To disable this, follow these steps:

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to MultiSafepay module > Manage hooks.
  3. Select Display non-positionable hooks.
  4. For actionOrderSlipAdd, select the three dots, and then click Unhook.

Shopping carts

If you notice errors in shopping cart calculations, email [email protected]

As a temporary solution, you can disable sending the shopping cart with the payment request.

Note: Pay later methods do not work if the shopping cart is disabled.

Disabling the shopping cart

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Improve > Module manager > MultiSafepay.
  3. In the MultiSafepay module, go to the General settings tab.
  4. Set the Disable Shopping Cart toggle to Enabled.
  5. Click Save.

Surcharges

Surcharges are not supported by default.

Applying surcharges with third-party add-ons

There are several third-party add-ons available. However, we can’t guarantee compatibility with our plugin. Make sure that you test them carefully before installing.

Attention Dutch merchants

We strongly recommend not applying surcharges to pay later methods. This is now considered providing credit under the Wet op het consumentenkrediet and article 7:57 of the Burgerlijk Wetboek, and requires a permit from the Authority for Financial Markets (AFM).

Translation

Translating the MultiSafepay module

To translate elements of the MultiSafepay module in the plugin, follow these steps:

  1. Sign in to your PrestaShop 1.7 backend.
  2. Go to Improve > International > Translations.
  3. On the Modify translations tab, from the Type of translation list, select Installed module translations.
  4. Select the MultiSafepay module and the Language, and then click Modify.
  5. Enter the required translations, and then click Save.

To translate the names of payment methods:

  1. Go to Improve > MultiSafepay > Payment methods.
  2. Select the payment method you want to translate.
  3. Make sure the Title field is empty.

Updates

Updating in your backend

  1. Make sure you have a backup of your production environment, and that you test the plugin in a staging environment.
  2. Download the plugin again above.
  3. Follow the Installation instructions.

Upgrading from 4.x or lower

Upgrading to version 5.x

To upgrade to version 5.x from an older version, follow these steps:

  1. Go to Modules > Module manager > MultiSafepay > Configure.
  2. On the Payment methods tab, set all payment methods to Off.
  3. On the Gift cards tab, set all gift cards to Off.
  4. Install and configure the new plugin following the instructions below.
  5. Only uninstall the older plugin when you’re sure that orders created with the new plugin are being processed successfully.

If upgrading from 5.x to a newer version, see Updates.

Feedback

Propose a change on GitHubexternal-link-icon or
send an email to [email protected]

Other languages

For an explanation in another language, contact your account manager.