OpenCart 3
Technical manual for MultiSafepay's free plugin.
More information
For more information about the plugin and a preview, see OpenCart – MultiSafepay .
Prerequisites
- MultiSafepay account
- OpenCart 2.X, 3.X
- PHP version 7.2, 7.3, or 7.4
Installation
✅ Tip! We recommend first installing the plugin in a test environment, following the OpenCart installation procedure. Always make a backup.
- Download the
Plugin_OpenCart_3.x.x.ocmod.zip. - Sign in to your OpenCart backend.
- Go to Extensions > Installer.
- Click the Upload button, and then select the downloaded file.
- Once installed, click the Dashboard menu.
- To clear both caches, click the blue cog wheel button in the top-right corner, and then click the Refresh icon.
- Go to Extensions > Modifications, and then click the Refresh button.
- Go to Extensions > Payments > MultiSafepay, and then click the Install button.
Configuration
- Sign in to your OpenCart backend and go to Extensions > Extensions > Payments > MultiSafepay.
- On the MultiSafepay configuration page, configure the:
- Payment methods tab
- Order status tab
- Options tab
To retrieve your API key, see Site ID, API key, and security code.
User guide
Checkouts
The plugin supports the OpenCart core checkout and is compatible with most premium themes, unless you have a custom checkout.
Patches for third-party themes and extensions
The table belows shows the patches available for third-party themes and extensions:
The Integration Team will do their best to provide support for third-party plugins and premium themes. Email
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: 3.9.0, March 19th 2021.
How to configure generic gateways
To configure generic gateways, follow these steps:
- Sign in to your OpenCart backend.
- Go to Plugin settings > Payment methods tab.
- Set the:
- Gateway identifier
- Gateway logo
- Gateway label
- Whether to include the shopping cart in refunds (required for BNPL gateway IDs)
You can filter payment methods by:
- Geographic zone
- Currency
- Minimum amount
- Maximum amount
- Customer groups
Full and partial refunds (except for BNPL orders), and backend orders are fully supported. You can also set a custom initial order status.
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]
- Sign in to your OpenCart backend.
- Go to Extensions > Type: Payments > MultiSafepay > Edit.
- Select the Payment methods tab and then expand the method of your choice.
- Enable Payment Component and optionally Tokenization.
❗️ Note: Tokenization is available only when Payment Component is activated.
💬 Support: 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 for backend orders
- Sign in to your OpenCart backend.
- Go to System > Localisation > Order status.
- Enter a custom order status for when the payment link is sent.
- Go to Extensions > Payments > MultiSafepay.
- Set the Generate payment links at the admin field to Yes.
- On the Options tab > Payment request field, set the Previously created order status.
- To reserve stock units of order items generated by the admin, while the order status is still Pending, go to System > Settings > Store > Options tab.
- In the Processing order status field, set the order status previously registered as Payment request.
- Go to Sales > Orders > Add new order.
- Enter all the order details in the following tabs:
- Customer details
- Products
- Payment details
- Shipping details
- At the fifth step Totals, in the Payment method field, select a MultiSafepay payment method.
- In the Order status field, select the order status previously registered as Payment request.
- To process the order, click Save.
The customer receives the payment link in the email sent by OpenCart containing the order details. The payment link is also added to the order history details.
Payment methods
Supported payment methods
- Cards: All
- Banking methods: All, except TrustPay
- BNPL: All
- Wallets: Alipay, Apple Pay, PayPal
- Prepaid cards:
- Baby Cadeaubon
- Beauty & Wellness
- Boekenbon
- Fashion Cheque
- Fashion gift card
- Fietsenbon
- Gezondheidsbon
- Nationale tuinbon
- Parfumcadeaukaart
- Paysafecard
- Podium
- Sport en Fit
- VVV gift card
- Webshop gift card
- Wellness gift card
- Wijncadeau
- Winkelcheque
- Yourgift
Refunds
Full refunds are supported in your MultiSafepay dashboard and backend.
You can't refund more than the original amount in your backend.
How to process backend refunds
- Sign in to your OpenCart backend.
- Go to Orders > Order view button > Order history panel.
- Click the Refund button.
This only appears if the order status is Completed or Shipped.
Shopping carts
If you notice any errors in shopping cart calculations, email [email protected]
As a temporary solution, you can disable payments with shopping carts.
How to disable shopping carts
❗️ Note: This disables all BNPL methods.
- Sign in to your OpenCart backend.
- Go to Extensions > Payments > MultiSafepay.
- In the MultiSafepay extension, go to the Options tab.
- From the Disable Shopping Cart list, select Yes.
- Click Save.
Surcharges
Surcharges are no longer supported, but you can request a patch.
Email [email protected]
Attention Dutch merchants
We strongly recommend not applying surcharges to BNPL orders. 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).
Updates
You can update the plugin using the extension installer tool in your OpenCart backend.
How to update from version 2.2.0 to 3.x.x
- For security, always create a backup of your OpenCart application.
- Download the Plugin_OpenCart_3.x.x.ocmod.zip.
- Sign in to your OpenCart backend.
- Go to Extensions > Installer.
- Click the Upload button, and then select the downloaded file.
- Once installed, in the menu go to Dashboard.
- To clear both caches, click the blue cog wheel icon in the top-right corner, and then click the Refresh icon.
- Go to Extensions > Modifications, and then click the Refresh icon.
- Go to Extensions > Payments > MultiSafepay.
- To access the Settings page, click the Edit button.
- A warning appears requesting you to delete old plugin files.
- In the Maintenance tab, click Delete old plugin files.
How to update from version 2.1.0 or below
- For security, create a backup of your OpenCart application.
- Manually remove all files from the MultiSafepay extension using an FTP program or server file administration program.
- Follow the installation instructions above.
Support
Contact MultiSafepay:
- Telephone: +31 (0)20 8500 500
- Email: [email protected]
- GitHub: create a technical issue
Updated about 1 year ago