VibeFox MultiSafepay for OpenCart — Help

Requirements

OpenCart: 3.0.x (tested on 3.0.5.0) or 4.0.2 and later (tested on 4.1.0.3).

PHP: 8.0 or later.

Currency: the checkout currency must be one MultiSafepay accepts, for example EUR, USD, GBP, PLN, CHF, SEK, DKK or NOK. For other currencies the payment method is hidden at checkout.

MultiSafepay account: you need the API key of your website in MultiSafepay Control. Test and live accounts have different keys. Nothing else has to be set up in MultiSafepay: the notification address is sent with every payment.

Public site: MultiSafepay must be able to reach your store to send notifications. Otherwise orders still get their status when the customer returns from MultiSafepay.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

The download is one zip file with the packages for both OpenCart versions. Unpack it on your computer. It contains README.txt, the OpenCart 3 package wcp_multisafepay_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_multisafepay_gateway.ocmod.zip. Install only the package for your OpenCart version. The license key is the same for both versions.

OpenCart 3

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_multisafepay_gateway-oc3-(version).ocmod.zip. The extension has no OCMOD modifications, so Extensions > Modifications does not need a refresh. Instead of the installer you can copy the contents of the upload folder of this package into the root folder of your store.

2. Go to Extensions > Extensions and choose the type Payments. Find VibeFox MultiSafepay Gateway and click Install (the green + button). Your admin user needs the right to modify the payment extensions list.

3. Click Edit (the pencil button) to open the settings page. Paste your VibeFox license key into License key in the license block at the top of the page and click Activate (see License key).

4. Paste the test and/or live API key from MultiSafepay Control (see Configuration).

5. Turn on Enable/Disable and click Save. Test a payment with Test mode on, then turn it off to accept real payments.

OpenCart 4

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_multisafepay_gateway.ocmod.zip. Do not rename the file: OpenCart 4 takes the extension code from the file name, and a renamed package does not work.

2. The package appears in the list of installed extensions on the same page. Click Install (the green + button) next to it.

3. Go to Extensions > Extensions and choose the type Payments. Find VibeFox MultiSafepay Gateway, click Install (the green + button), then Edit (the pencil button).

4. Enter the license key and the API keys as in steps 3 to 5 for OpenCart 3. The settings page and its fields are the same in both versions. Only the notification URL is different (see Notification URL).

A new install starts with the payment method turned off and test mode on.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox MultiSafepay Gateway > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Above the settings the page shows Test mode: new payments use the MultiSafepay test environment (no real payments). while test mode is on, warns you when the payment method is enabled but the current mode has no API key (the payment method is then not shown at checkout), and when MultiSafepay does not accept the default currency of your store. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must be 1 to 128 characters long, Sort Order must be a whole number (negative numbers are allowed), Total must be a number, 0 or greater, and the geo zone and order statuses must exist; otherwise nothing is saved and the page names the problem. If the payment method is enabled without the API key of the current mode, the settings are saved with a warning.

Checkout

Enable/Disable: Enable MultiSafepay turns the payment method on or off. Default: off.

Title: the payment method name the customer sees at checkout. It is also the payment method name stored in the order. Default: MultiSafepay. Required, up to 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay securely with iDEAL, cards, Bancontact, PayPal and more via MultiSafepay.

Sort Order: the position of MultiSafepay among the payment methods at checkout. Leave it empty or enter a whole number.

Geo Zone: offer MultiSafepay only for payment addresses in the selected geo zone. Default: All zones. Geo zones are set up in System > Localisation > Geo Zones.

Total: the checkout total, in the default currency of the store, that an order must reach before MultiSafepay is offered. Leave it empty to offer MultiSafepay for any total.

API keys

Find the API key in MultiSafepay Control > Manage settings > Website settings. The section links to the test account (testmerchant.multisafepay.com) and the live account (merchant.multisafepay.com). They have different keys. Test mode uses only the test key, live mode only the live key.

Test mode: uses the MultiSafepay test environment (no real payments). It switches both the API address and the API key. Payments already made keep using the environment they were made in for status checks and refunds. Default: on. While it is on, customers see Test mode: no real payment will be made. at the Confirm Order step.

Test API key: the API key of your MultiSafepay test account.

Live API key: the API key of your MultiSafepay live account.

Saved keys are never shown again. The field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it. To remove a saved key, tick Clear the saved key on save under the field and click Save.

Notifications

Nothing to configure. The Notification URL field shows the address that is sent to MultiSafepay with every payment. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_multisafepay_gateway/webhook, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_multisafepay_gateway/payment/wcp_multisafepay_gateway.webhook. It is built from the storefront address of your OpenCart installation. A notification only tells the extension which payment changed: the status, amount and currency are always read from the MultiSafepay API with the API key of the payment's environment before the order is changed. Notifications for payments that were not started in your store are ignored. The notification also works while the store is in maintenance mode, because OpenCart 3 lets payment extension requests through and on OpenCart 4 the extension adds a startup action for it, which also lets the customer return from MultiSafepay.

Orders

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after MultiSafepay has reported the payment. Each field below lists your OpenCart order statuses.

Order status after payment: the status of a paid order. Default: Processing. Choose Complete to complete paid orders at once.

MultiSafepay payment on hold status: the payment needs attention (see Order statuses). Default: Pending, because OpenCart has no On hold status. You can create your own status in System > Localisation > Order Statuses and select it here.

Payment error status: an uncleared or reserved payment was declined, expired or cancelled afterwards. Default: Failed.

Refunded status: set after the payment is fully refunded from the order page. Default: Refunded.

Advanced

Debug log: logs API calls and notifications to mspg_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web. Errors and warnings are always logged. API keys and customer data are never logged. Default: off.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Delete data on uninstall: when on, uninstalling the extension removes the gateway settings and the log. The MultiSafepay payment data of orders is always kept, so refunds of old orders stay possible. Disabling the extension never deletes anything. Default: off.

Import / Export

Export: Download JSON saves the settings as a JSON file. API keys are not exported.

Import: paste previously exported JSON and click Import to restore the settings. Saved API keys are kept.

Checkout

At the Payment Method step the customer chooses the payment method (by default MultiSafepay). At the Confirm Order step the customer sees your description and the note You will be redirected to MultiSafepay to choose a payment method and pay. OpenCart creates the order at this step, still without a status. When the customer clicks Confirm Order, the extension creates a MultiSafepay payment for the order total in the order currency and sends the customer to the MultiSafepay payment page. There the customer chooses any payment method enabled in your MultiSafepay account and pays. On OpenCart 4 the customer picks the payment method with the Choose button of the payment method block, in the window Payment method options, and clicks Confirm Order at the bottom of the checkout page. The billing address, e-mail, phone and language of the customer are passed to MultiSafepay, and the payment shows as Order #, the order number and your store name.

After paying, the customer returns to your store. The order is marked paid only after MultiSafepay confirms it: by the notification or by a check with the MultiSafepay API when the customer comes back. The order then gets its status the standard OpenCart way, with the usual order e-mails and stock update, and the customer sees the OpenCart order success page with Your payment with MultiSafepay has been received. For an order on hold the page shows We are confirming your payment with MultiSafepay. The order will be updated automatically — please do not pay again. If the payment later fails, the page shows Your MultiSafepay payment was not completed. Please contact us about this order. If MultiSafepay has not confirmed the payment yet when the customer comes back (for example a bank transfer is awaited), a Payment confirmation page shows the same "we are confirming" text and a Check again button; the notification sets the order status as soon as MultiSafepay reports the payment.

If the customer cancels on the MultiSafepay page, or the payment is declined or expires, the customer is back at checkout with the cart kept and one of these messages: The MultiSafepay payment was cancelled. You can try again or choose another payment method., The payment was declined. Please try again or choose another payment method. or The payment session has expired. Please try again. On OpenCart 4 these messages are shown above the checkout page.

OpenCart 3 creates a new order every time the Confirm Order step is shown, OpenCart 4 keeps one order for the checkout and pays the same order again. Before creating a new payment, the extension checks the previous payments of the same cart at MultiSafepay. If one is already paid or being processed, that payment is confirmed and the customer goes to the success page instead of paying again. If the payment of this order is still open with the same environment, amount and currency, the same payment page is reused. Otherwise the old payment is cancelled at MultiSafepay so it can no longer be paid.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was closed without a payment meanwhile (for example its payment was declined or expired after it was on hold, or you cancelled it), the customer is sent back to the checkout with Your previous order was cancelled without a payment. Please confirm the order again to pay with a new order., and the next Confirm Order pays a new order. If the order was paid and then closed by the store (for example refunded), the message is Your previous order #(number) was closed by the store. Please confirm the order again to pay with a new order. If the order of the checkout is already placed and the cart has changed since, the message is Your previous order #(number) has already been placed. Your cart has changed: please confirm the new order to pay for it. A change of the cart, including a new quantity, counts as a new cart that needs its own payment. An order of the cart that was paid and then cancelled or refunded no longer holds the cart.

If MultiSafepay cannot start the payment, the customer stays at the Confirm Order step with a short message above the button, for example Could not connect to MultiSafepay. Please try again in a moment. or MultiSafepay cannot accept this order amount or currency. Please choose another payment method. The technical reason is written to the log.

The extension offers one payment method that leads to the MultiSafepay page. It has no separate OpenCart payment methods per MultiSafepay payment method, no embedded card fields, no Apple Pay or Google Pay express buttons, no subscriptions, recurring payments or saved cards, and no capture or void from OpenCart. No shopping cart data is sent, so pay-later methods that require it (for example Klarna, in3 or Riverty) are not offered by MultiSafepay for these orders.

Orders and refunds

Order statuses

No status (missing order): the customer was sent to MultiSafepay and has not paid, MultiSafepay has not confirmed the payment yet, or the payment was cancelled, declined or expired. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders.

Order status after payment (default Processing): MultiSafepay confirmed the payment (completed or shipped) with the exact order amount and currency. A note shows the payment, the payment method and the environment.

MultiSafepay payment on hold status (default Pending), before payment: the payment is uncleared (being reviewed by MultiSafepay) or reserved (authorised). Capture a reserved payment in MultiSafepay Control to receive the money. The order moves to Order status after payment automatically when MultiSafepay reports it as completed, or to Payment error status when it is declined, cancelled, expired or voided.

MultiSafepay payment on hold status, after payment: MultiSafepay confirmed a different amount or currency than the order total, a test payment was completed while the extension is in live mode (no real money was received), or the payment was completed after the order had been given another status, for example cancelled. The note explains it. Check the transaction in MultiSafepay Control and fulfil or refund the order.

MultiSafepay payment on hold status, after a chargeback: MultiSafepay reported a chargeback for the payment of a paid order: the money was taken back from your account.

Payment error status (default Failed): an uncleared or reserved payment was later declined, cancelled, expired or voided.

Refunded status (default Refunded): the payment was fully refunded through the extension.

A paid or refunded order is never reopened by a late notification. If a second payment is completed for a cart that is already paid, the paid order is not changed. A note asks you to refund the duplicate in MultiSafepay Control.

Notes are entries in the order History that the customer does not see.

VibeFox MultiSafepay Gateway tab

In Sales > Orders open an order paid with MultiSafepay. At the bottom of the order page, next to History and Additional, the VibeFox MultiSafepay Gateway tab shows the MultiSafepay order (with a Test environment label for test payments), the Method, the Status, the amounts Paid / refunded, the refund form, the refund history and the MultiSafepay notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox MultiSafepay Gateway tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via MultiSafepay. Confirm the question Refund this amount through MultiSafepay? This cannot be undone. Full and partial refunds are supported. You need the right to modify the extension (set in System > Users > User Groups). Refunds are made in the amount and currency MultiSafepay charged, so after an amount mismatch you can refund up to what the customer actually paid, not the order total. The refund is sent to the environment the payment was made in (test or live), so that environment's API key must be set. If MultiSafepay does not accept the refund, the tab shows MultiSafepay refund failed: with the MultiSafepay error, and no refund is recorded. A successful refund is added to the refund history and the notes with the MultiSafepay refund ID. A full refund sets the order to Refunded status without notifying the customer and without returning products to stock, like a manual status change. A partial refund does not change the status. Refunds are available once MultiSafepay has reported the payment.

Product returns in Sales > Returns do not send money back through MultiSafepay.

Refunds made in MultiSafepay Control are added to the notes when MultiSafepay reports them. The order status is not changed automatically. Update it manually if needed.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox MultiSafepay Gateway is the first block on Extensions > Extensions > Payments > VibeFox MultiSafepay Gateway > Edit, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this store. Below them are the line Product: opencart-payment-multisafepay and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only admin users with the Modify permission for the extension can change the key. The texts of the block follow the admin language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the store address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the extension keeps working on the last known status.

One key works on one domain. Removing the key from the store does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, MultiSafepay is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. An admin user who is logged in to the admin in the same browser still sees the payment method in the store, marked (unlicensed — visible to admins only), so you can set up and test the extension before you buy a key. On OpenCart 4 this preview is not available: the store does not see the admin login, so without an active key the payment method is hidden for everybody. After you have opened the Edit page once, a reminder appears on the admin Dashboard. Close it with × to hide it for 7 days. Existing orders are not affected: payments already started are still confirmed, and refunds work.

When a license expires, the extension keeps working, but updates and support need a renewal. The status is checked again automatically when you open the admin Dashboard or the Edit page: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling the extension always removes the license key and license status.

Troubleshooting

MultiSafepay does not appear at checkout: check that the license is active, Enable/Disable is on and the current mode has an API key: Test API key in test mode, Live API key in live mode. The settings page shows a warning when the key is missing. The customer must pay in a currency MultiSafepay accepts (the currency selected in the store). Also check that the payment address is in the selected Geo Zone and that the order reaches the Total set in the settings.

The payment went through, but the order stays without a status: the notification did not reach your store. Check that the store is reachable from the internet and that the API key of the payment's environment is set, because the extension reads the status from the MultiSafepay API. If the API cannot be reached or the key is missing, the notification answers ERROR and MultiSafepay retries it. The order also gets its status when the customer returns to the store and when the customer tries to pay the same cart again.

Notification answers Invalid request: the request had no valid transaction ID. Notifications from MultiSafepay always have one.

The customer sees an error after Confirm Order: turn on Debug log and look at the Log field on the extension page. This payment method is not available. means the checkout session no longer matches the order, or the payment method was turned off meanwhile: the customer reloads the checkout. This payment method is temporarily unavailable. Please choose another payment method. usually means a wrong or missing API key. MultiSafepay cannot accept this order amount or currency. Please choose another payment method. means MultiSafepay refused the amount or currency.

The customer comes back and sees Payment verification failed.: the return address did not match a payment of this store, for example an old or edited link. The customer can pay again from the checkout.

Order is in the on hold status: read the notes in the VibeFox MultiSafepay Gateway tab. The payment may be uncleared or reserved, the paid amount or currency differed from the order, a test payment arrived in live mode, the payment came after the order was cancelled, or there was a chargeback. Check the transaction in MultiSafepay Control.

Test payments do not confirm a live order: a test payment never pays an order while the extension is in live mode; the order is put on hold instead. Earlier test payments are still checked and refunded with the test key after you switch to live.

No refund form in the tab: the tab says why: the payment is not reported yet, it is fully refunded, or your user group has no right to modify the extension.

Refund fails with a message about the environment: the payment was made in the test or live environment, and the API key of that environment is not set. Enter it and try again.

For developers: the extension triggers the OpenCart events mspg_supported_currencies and mspg_order_request to change the supported currencies and the payment data sent to MultiSafepay.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox MultiSafepay Gateway. The license key and license status of this extension are always removed. OpenCart always removes its own settings of the extension: Enable/Disable, Sort Order, Geo Zone, Total and the order statuses of the Orders section, which return to their defaults on a re-install. The OpenCart event of the extension is removed too (on OpenCart 4 its events and its startup action, which lets the notifications through in maintenance mode). If Delete data on uninstall is on, the other gateway settings (title, description, test mode, API keys, debug log) and the log are removed. If it is off, they are kept for a later re-install. The MultiSafepay payment and refund records are always kept, so orders paid before can still be refunded after a re-install. Existing orders keep their payment notes.

On OpenCart 4, to remove the files of the extension as well, go to Extensions > Installer after the uninstall and click Uninstall (the orange − button) next to VibeFox MultiSafepay Gateway in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

MultiSafepay is a trademark of its respective owner. This extension is not affiliated with or endorsed by MultiSafepay.