VibeFox Satispay 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 with the OpenSSL extension. The extension creates its RSA keys with OpenSSL.

Currency: EUR. Satispay charges euros only. The EUR currency must be enabled in System > Localisation > Currencies, and the payment method is shown only while the customer has EUR selected.

Satispay account: a Satispay Business account. You do not copy any API keys: the extension connects with a one-time activation code that you generate in the Satispay Business Dashboard (see Configuration). For tests you need a Satispay sandbox account, which you request from Satispay for developers.

Public store: your store must be reachable from the internet, so that Satispay can call it when a payment changes. Nothing has to be configured in Satispay for this.

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_satispay_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_satispay_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_satispay_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 Satispay 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. Choose the environment: turn on Sandbox Mode for tests, leave it off for real payments.

5. Paste an activation code of that environment into Activation Code and click Save. The Status field then shows Connected with the Key ID.

6. Turn on Enable/Disable and click Save. Test a payment in the sandbox, then turn off Sandbox Mode and connect the live environment with a live activation code.

OpenCart 4

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_satispay_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 Satispay Gateway, click Install (the green + button), then Edit (the pencil button).

4. Enter the license key, choose the environment and connect it with an activation code as in steps 3 to 6 for OpenCart 3. The settings page and its fields are the same in both versions. Only the callback URL is different (see Payment notifications).

A new install starts with the payment method turned off and the live environment selected.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox Satispay Gateway > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Above the settings the page warns you when the payment method is enabled but the environment in use is not connected (the payment method is then hidden at checkout), and when the default currency of the store is not EUR (the payment method is then shown only while the customer has EUR selected). 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. If a value is wrong, nothing is saved and the activation code is not sent.

Checkout

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

Title: the payment method name customers see at checkout. It is also the payment method name stored in the order. Default: Satispay. Required, up to 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay with the Satispay app: scan the QR code or confirm the payment on your phone.

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

Geo Zone: offer Satispay 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 Satispay is offered: a number, 0 or greater. Leave it empty to offer Satispay for any total.

Satispay connection

Status: the state of both environments, for example Live: Connected with the Key ID or Sandbox: Not connected, and which environment is in use. While the environment in use is not connected, the field says Satispay is hidden at checkout until the environment in use is connected.

Sandbox Mode: uses the Satispay sandbox (staging) environment. Sandbox payments are not charged. Default: off. Sandbox and live have separate keys: connect each environment with an activation code of that environment. While the sandbox is in use, customers see Sandbox mode: no real money is charged. at the Confirm Order step.

Activation Code: to connect the environment selected above, paste a new 6-character activation code and click Save. Live codes are generated in the Satispay Business Dashboard, section Online shop (the field links there). Sandbox codes come with a Satispay sandbox account. The code is used once and is not stored. Leave the field empty to keep the current connection.

When you save with a code, the settings are saved first. Then the extension creates an RSA key pair, sends the public key and the code to Satispay and stores the Key ID and the keys of the environment in use. The private keys are never shown and never exported. On success the page shows, for example, Satispay Live connected. Key ID: followed by the ID. If Satispay rejects the code, the page shows Satispay activation failed: with Satispay's message and asks you to check that the code is for this environment and has not been used yet; the current connection stays. A code that is not 4 to 64 letters and digits is refused before anything is sent. Saving a new code for an environment replaces its previous connection.

Payment notifications

Nothing to configure in Satispay. Every payment carries its own callback URL, which Satispay calls when the payment changes, and the extension re-reads the payment from the Satispay API before an order is changed. The Callback URL field shows an example of this URL. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_satispay_gateway/callback&satispay_p_order={order}&payment_id={uuid}, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_satispay_gateway/payment/wcp_satispay_gateway.callback&satispay_p_order={order}&payment_id={uuid}. It is built from the storefront address of your OpenCart installation. The URL must be reachable from the internet: no firewall or basic authentication in front of it. The OpenCart maintenance mode does not block it. If the callback cannot reach your store, the order is confirmed when the customer returns.

Orders

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

Order Status After Payment: the status set after the payment was accepted. Default: Processing.

Satispay Payment On Hold Status: the money was received, but the order needs review (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.

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

Advanced

Debug log: writes API calls and payment events to satispay_p_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web, and at 5 MB it is moved to satispay_p_debug.old.log.php. Keys, the activation code and customer data are not logged. Errors are always logged, even when this is off. 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, the Satispay keys of both environments and the log. The Satispay payments and refunds saved for orders are always kept. Default: off.

Import / Export

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

Import: paste previously exported JSON and click Import to restore the settings. The Satispay connection is kept.

Checkout

At the Payment Method step the customer chooses the payment method (by default Satispay). At the Confirm Order step the customer sees your description and the note You will be redirected to the Satispay page: scan the QR code with the Satispay app or confirm the payment on your phone. OpenCart creates the order at this step, still without a status. When the customer clicks Confirm Order, the extension creates a Satispay payment for the order total in euros, with the order number as reference, and sends the customer to the Satispay payment page. On a computer the customer scans the QR code with the Satispay app. On a phone the customer confirms the payment in the app. 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.

After the payment the customer returns to your store. The order is marked paid only after Satispay confirms it: the extension reads the payment from the Satispay API, checks that it was created for this order and compares its status, amount (in cents) and currency with the order. This happens both when Satispay calls the callback URL and when the customer returns, whichever comes first. 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. If Satispay has not confirmed the payment yet when the customer comes back, a Payment confirmation page shows Satispay has not confirmed your payment yet. The order will be updated automatically as soon as the confirmation arrives. and a Check again button. The callback sets the order status as soon as it arrives.

If the customer leaves the Satispay page without paying, the extension cancels the payment at Satispay, so the abandoned page can no longer be paid. The customer is back at checkout with the message Your Satispay payment was cancelled and nothing was charged. You can try again or choose another payment method. The same message appears when the customer declines the payment in the app. The cart is kept.

OpenCart 3 creates a new order every time the Confirm Order step is shown. OpenCart 4 keeps one order for the checkout and updates it, so after a cancelled payment the same order is paid with a new Satispay payment. Before a new Satispay payment is created, the previous payments of the cart are checked: a pending payment is cancelled at Satispay, and if one was already paid, it confirms its order, no second payment is made and the customer goes straight to the success page.

On OpenCart 4 the message about the cancelled payment is shown above the checkout page. If the order of the checkout was closed by the store meanwhile (for example cancelled or refunded), or is already paid but the cart has changed since, including a new quantity, the customer is sent back to the checkout with Your previous order is already closed. Please confirm the order again: the cart will be paid with a new order. above the checkout page, and the next Confirm Order pays a new order.

If the payment cannot be started, the customer stays at the Confirm Order step with a short message above the button: Satispay is not available at the moment. Please choose another payment method. when Satispay rejects the keys, Satispay supports EUR currency only. for an order in another currency, or Unable to create the Satispay payment. Please try again or choose another payment method. for other errors. The reason is written to the log.

The callback and the return of the customer work while the store is in maintenance mode: OpenCart 3 lets payment extension requests through, and on OpenCart 4 the extension adds a startup action for them.

The extension takes one-time payments in euros only. It has no subscriptions, saved payment methods, pre-authorisations or meal vouchers. There is no scheduled check of pending payments: if neither the Satispay callback nor the customer's return reaches your store, the order stays without a status, and the payment is visible in the Satispay Dashboard.

Orders and refunds

Order statuses

No status (missing order): the customer was sent to Satispay and has not paid, or Satispay has not confirmed the payment yet. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders. A cancelled Satispay payment leaves the order without a status, and the customer can pay again.

Order Status After Payment (default Processing): the payment was accepted. A note shows the Satispay payment, the amount and how it was verified (callback, redirect or checkout).

Satispay Payment On Hold Status (default Pending): Satispay reported a different amount or currency than the order total, or the payment was accepted after the order had got another status (for example, cancelled). The note explains it. Check the payment in the Satispay Dashboard, then fulfil the order or refund the payment. If another payment of the same cart with the right amount is accepted later, the order moves to Order Status After Payment.

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

If a second payment is accepted for an order that is already paid, or for another order of the same cart, the paid order is not changed. A note asks you to refund the duplicate payment from the Satispay Dashboard.

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

VibeFox Satispay Gateway tab

In Sales > Orders open an order paid with Satispay. At the bottom of the order page, next to History and Additional, the VibeFox Satispay Gateway tab shows the Satispay payment ID with a Sandbox label for sandbox payments, the payment Status, the amounts Paid / refunded, the refund form, the Refunds history, the list Satispay payments of this cart with every payment attempt, its order and its environment, and the Satispay notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox Satispay Gateway tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Satispay. Confirm the question Refund this amount through Satispay? 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 limited to the amount Satispay charged for the payment, 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 (live or sandbox), so that environment must still be connected. A refund counts as done only when Satispay accepts it: a successful refund is added to the history and the notes with the Satispay refund ID and the reason. If Satispay does not accept the refund, the tab shows the error and no refund is recorded. 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 Satispay has accepted the payment.

Product returns in Sales > Returns do not send money back through Satispay. Refunds made in the Satispay Dashboard are not recorded in OpenCart. Update the order manually if needed.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox Satispay Gateway is the first block on Extensions > Extensions > Payments > VibeFox Satispay 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-satispay 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: the store address from the OpenCart configuration. Removing the key from the store does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Satispay 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

Satispay does not appear at checkout: check that the license is active, Enable/Disable is on, the environment in use is connected (the Status field shows Connected for it) and the customer has EUR selected. 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 order gets its status when Satispay calls your store or when the customer returns. Check that your store is reachable from the internet, with no firewall or basic authentication in front of the callback URL, and turn on Debug log to see the callbacks in the Log field. The payment is visible in the Satispay Dashboard.

Callback answers Payment status unavailable, retry later. or Not configured.: the extension could not read the payment from Satispay, or the environment of the payment is not connected. No order is changed. Satispay calls again. Check the connection status and the log.

Callback answers Busy, retry later.: the cart was being confirmed by another request at the same moment, or the order status could not be set. Satispay calls again. The log shows the reason.

Callback answers Unknown payment. or Missing or invalid payment_id.: the payment was not created by this store for this order, or the request is not a Satispay callback. Nothing is changed.

Activation fails: activation codes can be used once. Check that the code belongs to the environment selected in Sandbox Mode (a live code for live, a sandbox code for the sandbox), generate a new code and save again. If the page says that an RSA key pair could not be generated, ask your host to enable the PHP OpenSSL extension. If Satispay could not be reached, check that your server can open outgoing HTTPS connections.

Satispay disappeared from the checkout after switching from sandbox to live: sandbox and live use different keys. Paste a live activation code with Sandbox Mode off and save.

The customer sees This payment method is not available.: the checkout no longer matches the order, or the payment method was turned off meanwhile. The customer reloads the checkout.

Order is in the review status after payment: read the notes in the VibeFox Satispay Gateway tab (see Order statuses), check the payment in the Satispay Dashboard, then fulfil the order or refund the payment.

No refund form in the tab: the tab says why: the order has no accepted Satispay payment, it is fully refunded, your user group has no right to modify the extension, or the environment of the payment is not connected any more.

Refund fails because the environment is not connected any more: the payment was made in live or sandbox, and that environment has no keys now. Connect it again with an activation code, or refund the payment from the Satispay Dashboard.

Refund fails with Satispay did not accept the refund: Satispay returned a status other than accepted. OpenCart did not record the refund, and a note says so. Check it in the Satispay Dashboard.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox Satispay 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. On OpenCart 4 the event of the extension and its startup action, which lets the callback and the return of the customer through in maintenance mode, are removed too. If Delete data on uninstall is on, the other gateway settings (title, description, sandbox mode, logging), the Satispay keys of both environments and the log are removed. If it is off, they are kept for a later re-install, including the Satispay connection. The Satispay payments and refunds saved for orders are always kept, so orders paid before can still be refunded after a re-install once the environment is connected again. 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 Satispay Gateway in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

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