PrestaShop
Technical manual for MultiSafepay's free plugin.
Action required
If you are still using the deprecated plugin , we recommend upgrading to the latest version as soon as possible.
Prerequisites
- MultiSafepay account
- PrestaShop 1.7.6 up to PrestaShop 8.2.x
- PHP version 7.2 or higher
Installation
💡 Tip! We recommend first installing the plugin in a test environment, following the PrestaShop installation procedure. Always make a backup.
- Sign in to your PrestaShop Back Office.
- Go to Modules > Module Manager > Upload a module.
- Select the Plugin_PrestaShop.zip file, and then click Configure.
- Clear your cache.
Configuration
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay, and enter your site API key.
- On the Payment methods tab, enable the relevant payment methods.
- Click Save.
Additional configuration steps
After completing the configuration, enable specific countries to make the payment methods available.
How to enable countries
- Go to Improve > Payment > Preferences > Country restrictions.
- Select the checkbox to enable the relevant countries.
- Click Save.
User guide
Backend orders
In the previous release, PrestaShop Back Office orders were only created for MultiSafepay orders with Completed status.
In the current release, 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:
- One Page Checkout PS
- The Checkout – Payment options must be set on separate pages in the plugin settings page.
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 allows you to add a payment method manually. This is particularly useful for integrating gift cards specific to your business.
Supported since release: 5.0.0-RC-1, Oct 27th 2021.
How to configure generic gateways
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay > Payment methods > Generic gateway.
- Set the relevant payment method gateway IDs and the gateway icon.
You can filter payment methods by:
- Country
- Currency
- Customer group
- Minimum and maximum amount
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.
How to switch order flows
To change the flow you are using, follow these steps:
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay > General settings tab.
- In the Create order before payment field, select the flow.
- 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.
Supported payment methods
- Cards: Amex, Maestro, Mastercard, and Visa
- BNPL: Pay After Delivery installments
How to activate payment components
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay > Payment methods tab.
- Select the relevant payment methods.
- Set Enable payment component toggle to Enabled.
- Click Save.
💬 Support: If you're new to accepting card payments, email a request to activate them to [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 links
How to generate payment links from back office
- Sign in to your PrestaShop back office.
- Go to Orders > Orders.
- Click on Add new order at the top right corner.
- To add new order, follow all steps in PrestaShop 8 core reference page - see PrestaShop back office page
⚠️ Note: To successfully generate payment links from the back office, ensure that you have followed the steps below:
Under Summary section:
- Select MultiSafepay as Payment.
- Select MultiSafepay initialized as Order status.
Payment methods
Supported payment methods
- Cards: All
- Banking methods: All
- BNPL: 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
The plugin supports recurring payments.
How to enable recurring payments
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay > Payment methods tab.
- Select either the bundled card payments gateway, or select specific card.
- Set the Enable tokenization toggle to Enabled.
- Click Save.
Refunds
- Full and partial refunds are supported in your MultiSafepay dashboard and PrestaShop backend.
- BNPL refunds are supported in the dashboard only.
- Refunds for orders that include shopping cart rule discounts are supported in the dashboard only.
How to disable 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:
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay > Manage hooks.
- Select Display non-positionable hooks.
- For actionOrderSlipAdd, select the three dots, and then click Unhook.
For more information, see PrestaShop – Creating returns and refunds .
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: BNPL methods do not work if the shopping cart is disabled.
How to disable the shopping cart
- Sign in to your PrestaShop Back Office.
- Go to MultiSafepay > General settings tab.
- Set the Disable Shopping Cart toggle to Enabled.
- Click Save.
Surcharges
Surcharges are not supported by default.
How to apply 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 BNPL 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
How to translate the MultiSafepay module
To translate elements of the MultiSafepay module in the plugin, follow these steps:
- Sign in to your PrestaShop Back Office.
- Go to International > Translations.
- On the Modify translations tab, from the Type of translation list, select Installed module translations.
- Select the MultiSafepay module and the Language, and then click Modify.
- Enter the required translations, and then click Save.
To translate the names of payment methods:
- Go to MultiSafepay > Payment methods.
- Select the payment method you want to translate.
- Make sure the Title field is empty.
Updates
How to update in your backend
💡 Tip! Make sure you have a backup of your production environment, and that you test the plugin in a staging environment.
- Download the plugin again above.
- Follow the Installation instructions.
Upgrades
How to upgrade to version 5.x
We recommend upgrading to version 5.x from older versions.
- Go to Modules > Module manager > MultiSafepay > Configure.
- On the Payment methods tab, set all payment methods to Off.
- On the Gift cards tab, set all gift cards to Off.
- Install and configure the new plugin following the instructions below.
- 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.
Support
Contact MultiSafepay:
- Telephone: +31 (0)20 8500 500
- Email: [email protected]
- GitHub: create a technical issue
Updated 23 days ago