MultiSafepay plugin for Shopware 5


This technical manual is for installing and configuring our free plugin for integrating MultiSafepay payment solutions into your Shopware 5 webshop.

Test environment


We recommend first installing the plugin in a test environment following the recommended Shopware 5 installation procedure. Make sure you have made a backup.

Support

Contact us:

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

Requirements

  • MultiSafepay account – See Getting started.
  • Shopware 5.6.x or 5.5.7 and above.
  • Tested on PHP 7.0

Installation and configuration

  1. Sign in to your Shopware 5 backend.
  2. Go to Configuration > Plugin manager.
  3. Search for the MultiSafepay plugin and click Download now.
  4. Go to Configuration > Plugin manager > Installed.
  5. Search for the installed MultiSafepay plugin and click on the pencil icon.
  6. In the API key field, enter your API key.
  7. Fill out the other fields as required.
  8. Go to Configuration and select the required payment methods.

User guide

Transaction and order numbers

Shopware 5 generates an order number and a transaction number.

The order number is generated after the payment is completed (unlike most ecommerce integrations where it is generated at the beginning of the order).

The transaction number is generated when the transaction is initialized. MultiSafepay uses this number as the order ID in transactions.

Configuring generic gateways

The plugin supports generic gateways, e.g. for branded gateways. They work much like other redirect payment methods. All features are supported, except for recurring payments.

  1. Sign in to your Shopware 5 backend.
  2. Go to the MultiSafepay settings page.
  3. Enter the gateway code provided by MultiSafepay.
  4. Upload a custom gateway image, if relevant.
  5. Specify if the gateway requires a shopping cart or not.

For any questions about integrating generic gateways, email the Integration Team at [email protected]

Migrating to Shopware 6

About Shopware 6
Shopware 6 is the latest version of the Shopware ecommerce platform. It maintains simplicity, but features a great new interface and functionalities, including:

  • Sales Channels function that links to social shopping platforms (e.g. Facebook, Instagram), and supports mobile apps and POS systems
  • Rule Builder that lets you set price rules per country, and supports multi-currency options, VAT rules, and delivery options, e.g. free delivery for orders above a specified amount
  • Content management function that uses stylized blocks on Experience and Storytelling pages
  • Text editor that is easier and more user-friendly

Shopware 5 phase out

Support for Shopware 5 will be phased out as follows:

  1. General support until mid-2024
  2. Regular functional releases until mid-2021
  3. Bug fixes and small releases until mid-2023
  4. Security updates until mid-2024

MultiSafepay will continue to support Shopware 5 as long as it remains in the market.

Migrating to Shopware 6

For instructions, see the Shopware migration manual.

For questions, email the Integration Team at [email protected]

Missing session data

It can happen that Shopware 5 will remove sessions before the order is created within the Shopware backend. To prevent this from happening we recommend making the following changes to the config.php.

'session' => [
    'save_handler' => 'db',
    'gc_probability' => 0,
    'gc_divisor' => 1000
],

This is also explained on the following page: https://developers.shopware.com/sysadmins-guide/sessions/#blocking-transactions

Processing refunds

You can process refunds for all Shopware 5 payment methods except pay later methods from your:

Refund rules

Shipping orders

For pay later payment methods, after you ship the order to the customer, you need to change the order status from Completed to Shipped. This prevents the order expiring, and lets the payment method initiate the billing process with the customer and pay the transaction out to your MultiSafepay balance.

If you change the order status to Delivered in your backend, the updated status is passed to your MultiSafepay account automatically.

Updating the plugin

There are 3 ways to update the Shopware 5 plugin:

  • In your Shopware 6 backend
  • In the CMS marketplace
  • Using SFTP

To update the plugin in your backend, follow these steps:

  1. Make sure you have a backup of your production environment, and that you test the plugin in a staging environment.
  2. From the Shopware 6 manual, download the plugin again.
  3. Follow the Installation and configuration instructions from step 2.

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.