SolutionsSystem status
Documentation
Create accountContact

Shopware

Technical manuals for MultiSafepay's free plugins.

Suggest Edits

Shopware 6

Prerequisites

Installation and configuration

āœ… Ā  Tip! We recommend first installing the plugin in a test environment, following the Shopware 6 installation procedure. Always make a backup.

Marketplace installation

Get the free MultiSafepay plugin from the Shopware 6 marketplace and connect your webshop with your Shopware account.

Composer installation

Run the following command in the root of your Shopware root directory. Make sure the composer is installed on your hosting server.

composer require multisafepay/shopware6

User guide

Generic gateways

The plugin supports generic gateways, which redirect customers from your checkout to a MultiSafepay payment page. This is particularly useful for integrating gift cards.

How to configure generic gateways
  1. Sign in to your Shopware 6 backend.
  2. Go to MultiSafepay settings.
  3. Set the relevant payment method gateway IDs.

You can filter generic gateways by country, and minimum and maximum amount.

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.
How to activate payment components

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

  1. Sign in to your Shopware backend.
  2. Go to Settings > Payment.
  3. Select each payment method, and then enable the Component toggle.

For questions, 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

Supported payment methods

Recurring payments

Recurring payments are supported.

How to enable recurring payments

Activate recurring payments and then:

  1. Sign in to your Shopware backend.
  2. Go to Settings > Payment.
  3. Select each payment method, and then enable the Tokenization toggle.

Refunds

Full and partial refunds except for BNPL methods are supported in your MultiSafepay dashboard and backend.
You cannot refund more than the original amount in your backend.

How to process backend refunds
  1. In your Shopware 6 backend, go to the Order details page.
  2. In the Refund field, enter the refund amount.

Shipping orders

For BNPL orders, after shipment, you must change the order status from Completed to Shipped. This prevents the order expiring and triggers invoicing.

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

Updates

You can update the plugin in your backend and the CMS marketplace, or via using SFTP.

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.

  1. Download the plugin again above.
  2. Follow the Installation and configuration instructions from step 3.

Top of page

Shopware 5

Prerequisites

Installation and configuration

āœ… Ā  Tip! We recommend first installing the plugin in a test environment, following the Shopware 5 installation procedure. Always make a backup.

  1. Sign in to your Shopware 5 backend.
  2. Go to Configuration > Plugin manager.
  3. Search for the MultiSafepay plugin, and then click Download now.
  4. Go to Configuration > Plugin manager > Installed.
  5. Search for the installed MultiSafepay plugin, and then click the Edit 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

Backend orders

To create backend orders in the MultiSafepay Shopware 5 plugin, Shopware uses a third-party plugin.

See shopwareLabs GitHub ā€“ SwagBackendOrder .

We support V2.x versions.

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 releases:

  • 2.3.0, March 24, 2021
  • 2.6.0, December 7, 2020
How to configure generic gateways
  1. Sign in to your Shopware 5 backend.
  2. Go to MultiSafepay settings.
  3. Set the relevant payment method gateway IDs.
  4. Upload a custom gateway image, if relevant.
  5. For BNPL orders, specify whether to include a shopping cart.

For support, email [email protected]

You can filter generic gateways by country, and minimum and maximum amount.

Payment methods

Supported payment methods

Refunds

You can process full refunds for all Shopware 5 payment methods except BNPL from your MultiSafepay dashboard and backend.
You cannot refund more than the original amount in your backend.

Session data

Shopware 5 can remove sessions before the order is created in the backend.
To prevent this, we recommend making the following changes to the config.php .

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

For more information, see Shopware ā€“ Blocking transactions .

Shipping orders

For BNPL orders, after shipment, you must change the order status from Completed to Shipped. This prevents the order expiring and triggers invoicing.

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

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.

Updates

You can update the plugin in your backend or the CMS marketplace, or via SFTP.

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.

  1. Download the plugin again above.
  2. Follow the Installation and configuration instructions from step 2.

Upgrading to Shopware 6

How to upgrade 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 [email protected]


šŸ’¬

Support

Contact MultiSafepay:

For support for Shopware 6 Professional/Enterprise, email [email protected]

Top of page

Updated 12 months ago