MultiSafepay plugin for OpenCart


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

Test environment

 

We recommend first installing the plugin in a test environment following the recommended OpenCart 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.
  • OpenCart 2.X, 3.X
  • Tested on PHP 7.2, 7.3

Installation

  1. For security, always create backup of your OpenCart application.
  2. Download the Plugin_OpenCart_3.x.x.ocmod.zip.
  3. Sign in to your OpenCart backend, and go to Extensions > Installer.
  4. Click the Upload button, and then select the downloaded file.
  5. Once installed, click the Dashboard menu.
  6. To clear both caches, click the blue cog wheel button in the top-right corner, and then click the Refresh icon.
  7. Go to Extensions > Modifications, and then click the Refresh button.
  8. Go to Extensions > Payments > MultiSafepay, and then click the Install button.

Configuration

  1. Sign in to your backend and go to Extensions > Extensions > Payments > MultiSafepay.
  2. On the MultiSafepay configuration page, fill out each tab.
    To retrieve your API key, see Get your API key.
  3. On the Payment methods tab, enable and configure the relevant payment methods.
  4. Configure the Order status tab, matching each possible MultiSafepay callback status with one of the order statuses in your OpenCart webshop.
  5. Configure the Options tab.

User guide

Applying surcharges

Applying surcharges or payment fees is no longer supported, but you can request a patch. Email the Integration Team at [email protected]

PSD2 implications For more information about how the Payment Services Directive 2 may affect surcharges or payment fees, see Payment Services Directive 2.

Configuring generic gateways

The OpenCart plugin supports generic gateways for all payment methods.

To configure generic gateways, follow these steps:

  1. Sign in to your OpenCart backend.
  2. Go to Plugin settings > Payment methods tab.
  3. Set the:
    • Gateway code
    • Gateway logo
    • Gateway label
    • Whether to include the shopping cart in refunds. Required for pay later gateway codes.

You can also set a custom initial order status.

You can filter generic gateways by:

  • Geographic zone
  • Currency
  • Minimum amount
  • Maximum amount
  • Customer groups

Full refunds, partial refunds (except for pay later payment methods), and backend orders are fully supported.

Processing refunds

Refund rules

  • From your MultiSafepay account: Full refunds
  • From your OpenCart backend:
    • Full refunds
    • Refunding more than the original transaction is not supported

To process refunds from your backend, follow these steps:

  1. Sign in to your OpenCart backend.
  2. Go to Orders > Order view button > Order history panel.
  3. Click the Refund button. This only appears if the order status is Completed or Shipped.
Supported checkouts and themes

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

The following patches for third-party themes and extensions are available:

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

Updating the plugin

Updating version 2.2.0 to 3.x.x To update the plugin using the extension installer tool in your OpenCart backend:

  1. For security, always create a backup of your OpenCart application.
  2. Download the Plugin_OpenCart_3.x.x.ocmod.zip.
  3. Sign in to your OpenCart backend.
  4. Go to Extensions > Installer.
  5. Click the Upload button, and then select the downloaded file.
  6. Once installed, in the menu go to Dashboard.
  7. To clear both caches, click the blue cog wheel icon in the top-right corner, and then click on the Refresh icon.
  8. Go to Extensions > Modifications, and then click the Refresh icon.
  9. Go to Extensions > Payments > MultiSafepay.
  10. To access the Settings page, click the Edit button.
  11. A warning appears requesting you to delete old plugin files.
  12. In the Maintenance tab, click Delete old plugin files.

Updating version 2.1.0 or below

  1. For security, create a backup of your OpenCart application.
  2. Manually remove all files from the MultiSafepay extension using an FTP program or server file administration program.
  3. See the OpenCart manual and follow the installation instructions.

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.