VibeFox SimplePay 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.

Store currency: HUF, EUR or USD. SimplePay does not accept other currencies, and the payment method is not offered while the customer has another currency selected.

SimplePay merchant accounts: SimplePay gives a separate merchant account for each currency, and separate accounts for live and sandbox. For each account you need its MERCHANT and SECRET KEY from the SimplePay merchant admin (admin.simplepay.hu for live, sandbox.simplepay.hu for sandbox), account > Technical data. If you sell only in HUF, the HUF account is enough. No other keys are needed.

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_simplepay_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_simplepay_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_simplepay_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 SimplePay 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. Enter the MERCHANT and SECRET KEY of your SimplePay accounts for every currency you sell in: sandbox accounts for testing and live accounts for real payments (see Configuration).

5. Copy the IPN URL shown on the settings page into every merchant account (live and sandbox) in the SimplePay merchant admin.

6. Turn on Enable/Disable and click Save. Test a payment with Sandbox mode on, then turn off Sandbox mode to take real payments.

OpenCart 4

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

4. Enter the license key, the merchant accounts and the IPN URL as in steps 3 to 6 for OpenCart 3. The settings page and its fields are the same in both versions. Only the IPN URL is different (see IPN URL).

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

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox SimplePay 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 default currency of the store is not supported by SimplePay, or when it has no merchant account in the current mode. In both cases the payment method is not offered for orders in that currency. While sandbox mode is on, the page shows Sandbox mode is on: payments go to the SimplePay sandbox, no real money is charged. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must not be empty (up to 128 characters), Sort Order must be a whole number (negative values 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.

SimplePay (OTP)

Enable/Disable: Enable SimplePay Gateway 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: SimplePay (Card Payment). Required.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay securely with your credit or debit card via SimplePay. Hungarian merchants can put the SimplePay data transfer declaration here.

Sandbox mode: uses the SimplePay sandbox for test payments with the sandbox accounts. It switches both the API address and the merchant accounts. No real money is charged. Default: on. Turn it off to take real payments with the live accounts. While it is on, customers see Sandbox mode: no real payment is taken. at the Confirm Order step. Orders started in the sandbox are always refunded in the sandbox.

Sort Order: the position of SimplePay among the payment methods at checkout. Leave it empty or enter a whole number (negative values are allowed).

Geo Zone: offer SimplePay 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 SimplePay is offered. Leave it empty to offer SimplePay for any total.

Live merchant accounts

The accounts used when Sandbox mode is off. Fill in the accounts of the currencies your store sells in. The MERCHANT and SECRET KEY values are in the SimplePay merchant admin (admin.simplepay.hu, the section links there), account > Technical data. An account is used only when both fields are filled in.

HUF account — Merchant ID: the MERCHANT of your live HUF account.

HUF account — Secret key: the SECRET KEY of your live HUF account.

EUR account — Merchant ID and EUR account — Secret key: the same for your live EUR account.

USD account — Merchant ID and USD account — Secret key: the same for your live USD account.

Sandbox merchant accounts

The accounts used when Sandbox mode is on. The fields are the same as for the live accounts: HUF account — Merchant ID, HUF account — Secret key and the same pairs for EUR and USD. Take the values from the SimplePay sandbox merchant admin (sandbox.simplepay.hu), account > Technical data.

Saved secret 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 secret key under the field and click Save.

IPN URL

The IPN is the message SimplePay sends to your store when the payment status changes. It is the regular way an order gets its status. The section shows the IPN URL of your store. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_simplepay_gateway/ipn, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_simplepay_gateway/payment/wcp_simplepay_gateway.ipn. It is built from the storefront address of your OpenCart installation. Set this URL for every merchant account, live and sandbox, in the SimplePay merchant admin. Copy the URL exactly as the settings show it, because a redirected IPN is lost.

The IPN must be signed with the SECRET KEY of the merchant account it names, in the mode (sandbox or live) the payment was started in. IPNs without a valid signature are rejected. The extension confirms each valid IPN to SimplePay in the signed form SimplePay requires. These IPN statuses are used:

Rejected, cancelled and timed-out statuses are recorded only for the latest payment attempt of a cart that has nothing paid yet. Other statuses change nothing. Without the IPN, an order gets its status only when the customer comes back to the store after a successful payment.

Orders

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after SimplePay has confirmed the payment. The status fields list your OpenCart order statuses.

Order Status After Payment: which status a paid order gets.

Paid Order Status: the status of a paid order when Order Status After Payment is Processing. Default: Processing.

Complete Order Status: the status of a paid order when Order Status After Payment is Completed. Default: Complete.

On Hold (Review) Status: the payment was made for another amount or currency than the order (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

Logging: writes API calls, IPNs and returns to simplepay_op_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web, and at 5 MB it is rotated. Keys 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 and the log. Order data (SimplePay transactions and refunds) is always kept. Default: off.

Import / Export

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

Import: paste previously exported JSON and click Import to restore the settings. The saved secret keys are kept.

Checkout

At the Payment Method step the customer chooses the payment method (by default SimplePay (Card Payment)). At the Confirm Order step the customer sees your description and the note You will be redirected to the SimplePay payment page to pay by card. OpenCart creates the order at this step, still without a status. When the customer clicks Confirm Order, the extension starts a SimplePay card payment for the order total in the order currency, with the merchant account of that currency in the current mode, and sends the customer to the SimplePay payment page. The customer's e-mail and, when it is complete, the payment address are passed to SimplePay. The payment page uses the language of the order when SimplePay supports it, otherwise English. A started payment can be paid within 30 minutes. 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 a successful payment the customer returns to your store. The return alone never pays an order: the extension asks SimplePay for the status of the transaction with a signed request, so the order gets its status even if the IPN is late. The order is marked paid only after SimplePay confirms it. 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 Successful transaction. SimplePay transaction ID: and the ID. If SimplePay has not confirmed the payment yet, a Payment confirmation page shows Your payment is being confirmed by SimplePay. SimplePay transaction ID: with the ID, Your order will be confirmed as soon as SimplePay confirms the payment — please do not pay again. and the buttons Check again and Back to checkout; the IPN sets the order status as soon as it arrives.

If the payment fails, is cancelled or times out, the customer is sent back to the checkout with SimplePay's message and the transaction ID, for example Cancelled payment. You cancelled the payment or Timeout. The time allowed to complete the payment has expired. A failed payment asks the customer to check the entered data and contact the card-issuing bank. The order stays without a status, the cart is kept and the customer can try again. 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 the next attempt pays the same order. Each attempt gets its own SimplePay reference: OC, the order number and the attempt number, for example OC123-1 and then OC123-2. If another order of the same cart is already paid or in review, the customer goes straight to the success page instead of paying again.

If SimplePay cannot start the payment, the customer stays at the Confirm Order step with The SimplePay payment could not be started. Please try again or choose another payment method. If the order currency has no merchant account, the message is SimplePay is not available for the currency of this order. Please choose another payment method. The technical reason is written to the log. A return that cannot be matched to a payment attempt shows We could not match this payment to an order. If you were charged, please contact us.

On OpenCart 4 the messages that lead back to the checkout are shown above the checkout page. If the order of the checkout was closed meanwhile, 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. or, when it had a SimplePay payment, Your previous order was cancelled or refunded by the store. Please confirm the order again to pay with a new order. The next Confirm Order pays a new order. If the order of the checkout is already paid but the cart has changed since, including a new quantity, the customer is sent back to the checkout and the new cart is paid with a new order.

The IPN and the return of the customer also 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 card payments only, captured on the SimplePay page. It has no saved cards or one-click payments, no subscriptions or recurring payments, and no separate authorize and capture.

Orders and refunds

Order statuses

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

Paid Order Status or Complete Order Status: the payment was confirmed. The status follows Order Status After Payment. A note shows the SimplePay transaction ID and whether the IPN or the status query confirmed it.

On Hold (Review) Status (default Pending): the order total or currency was changed after the payment was started, so the paid amount differs from the order. The note shows both amounts. Check the order and fulfil it or refund the payment in the SimplePay merchant admin. If another attempt of the same cart is then paid for the right amount, that payment's order gets the paid status.

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

A paid, refunded or completed order is never re-opened by a late IPN. If a second payment succeeds 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 check it in the SimplePay admin and refund it if it is a duplicate.

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

VibeFox SimplePay Gateway tab

In Sales > Orders open an order paid with SimplePay. At the bottom of the order page, next to History and Additional, the VibeFox SimplePay Gateway tab shows the Transaction ID with a Sandbox label for sandbox payments, the Order reference (orderRef), the Merchant account and mode, the SimplePay Status, the amounts Paid / refunded, the refund form, the refund history, the Payment attempts of the cart (when there was more than one) and the SimplePay notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox SimplePay Gateway tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional, order note only), and click Refund via SimplePay (OTP). Confirm the question Refund this amount via SimplePay? This cannot be undone. Full and partial refunds are supported. You need the right to modify the extension (set in System > Users > User Groups). HUF refunds must be whole forints. The refund is sent for the SimplePay transaction that paid the order, with the merchant account and in the mode (sandbox or live) of that payment, even if the store has been switched to the other mode since; that account must still be in the settings. If SimplePay does not accept the refund, the tab shows the error and no refund is recorded. A successful refund is added to the history and the notes with the SimplePay refund transaction and the reason, if you entered one. 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. An order in review after an amount mismatch cannot be refunded from the tab: refund it in the SimplePay merchant admin.

Product returns in Sales > Returns do not send money back through SimplePay. Refunds made in the SimplePay merchant admin are not synced to OpenCart. Record them manually.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox SimplePay Gateway is the first block on Extensions > Extensions > Payments > VibeFox SimplePay 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-simplepay 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, SimplePay 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 by the IPN, 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

SimplePay does not appear at checkout: check that the license is active, Enable/Disable is on, the customer's currency is HUF, EUR or USD, and that currency has both Merchant ID and Secret key in the current mode: the sandbox accounts while Sandbox mode is on, the live accounts while it is off. 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 IPN did not reach the store. In the SimplePay merchant admin check the IPN URL of the merchant account you use (live or sandbox, the currency of the order). It must be exactly the URL shown in the settings, and your server must be reachable from the internet. The order also gets its status when the customer returns to the store after paying.

IPN answers Invalid signature.: the IPN names a merchant account that is not in the settings, its Secret key is wrong, or it is signed by the account of the other mode than the payment. Enter the MERCHANT and SECRET KEY exactly as the SimplePay merchant admin shows them. SimplePay repeats unconfirmed IPNs.

IPN answers Order not found. or Unknown transaction.: the IPN is for a payment that this store did not start. Nothing is changed.

IPN answers Busy, retry.: the cart was being processed by another request at the same moment, or the order status could not be set. SimplePay retries the IPN. The reason is written to the log.

The customer sees The SimplePay payment could not be started: look at the Log field on the extension page. A wrong secret key gives Invalid response signature from SimplePay. Check the secret key of the merchant account. SimplePay errors are logged with their error codes.

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.

After switching between sandbox and live: new payments use the accounts of the new mode. Payments started before keep the merchant account and mode they were started with: their IPNs, status requests and refunds use that account. Keep the accounts of the old mode in the settings while such payments are open or may be refunded.

Order is in the review status after payment: read the notes in the VibeFox SimplePay Gateway tab. The order total or currency was changed after the payment was started. Fulfil the order or refund the payment in the SimplePay merchant admin.

No refund form in the tab: the tab says why: the order is not paid by a SimplePay transaction (for example, after an amount mismatch), it is fully refunded, your user group has no right to modify the extension, or the merchant account of the payment is not in the settings.

Refund fails: read the message in the tab. SimplePay refunds in HUF must be whole amounts. means the HUF amount had decimals. If the message says the merchant account of this payment is not configured, enter the account (currency and mode) the payment was made with again. If SimplePay refunded a different amount, the message asks you to check the refund in the SimplePay admin.

For developers: before the payment is started, the extension triggers the OpenCart event simplepay_op_payment_data with the payment data and the order. The merchant, order reference, currency, total and return URL cannot be changed there.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox SimplePay 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 IPN and the return of the customer through in maintenance mode). If Delete Data on Uninstall is on, the other gateway settings (title, description, sandbox mode, merchant accounts, logging) and the log are removed. If it is off, they are kept for a later re-install. The SimplePay transactions and refunds 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 SimplePay Gateway in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

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