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

Quickpay account: you need two values from the Quickpay manager: the API key of an API user (to create payments, capture and refund) and the private key of the account (to check the signature of Quickpay callbacks). Nothing else has to be set up in Quickpay. Your store must be reachable from the internet, not behind password protection, so that Quickpay callbacks can arrive.

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_quickpay_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_quickpay_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_quickpay_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 Quickpay 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 API key and the private key from the Quickpay manager and click Test API key (see Configuration).

5. Choose the capture mode and the order status after payment, turn on Enable/Disable and click Save. While your Quickpay account is in test mode, turn on Test payments and make a payment with a Quickpay test card.

OpenCart 4

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

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

A new install starts with the payment method turned off.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox Quickpay Gateway > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Until both the API key and the private key are saved, the page shows Quickpay needs setup: enter the API key and the private key. Until both are saved the payment method is hidden at checkout. While Test payments is on, the page reminds you to turn it off when your Quickpay account goes live. 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 every order status must exist. Otherwise nothing is saved and the page names the field.

Quickpay

Enable/Disable: Enable Quickpay 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: Quickpay. Required, up to 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay securely by card or MobilePay on the Quickpay payment page.

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

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

Quickpay API credentials

In the Quickpay manager (manage.quickpay.net, the page links there) open Settings > Integration. Copy the API key of an API user (Settings > Users) and the private key of the account.

Callback URL: shows the callback URL of your store. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_quickpay_gateway/callback, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_quickpay_gateway/payment/wcp_quickpay_gateway.callback. It is built from the storefront address of your OpenCart installation. Quickpay calls it after every payment operation (authorize, capture, refund, cancel). It is sent with every payment, capture and refund automatically, so nothing has to be configured in Quickpay.

API key: the API key of a Quickpay API user. It is used to create payments, capture and refund.

Private key: the private key of the account. It is used to check the signature (HMAC-SHA256) of Quickpay callbacks. Without it no payment can be confirmed, and callbacks are rejected.

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 value, tick Clear the saved value on save under the field and click Save.

Test API key: this button checks the key typed in the API key field (or the saved one, if the field is empty) with an authenticated request to Quickpay, without saving it. It answers Connection successful — the API key is valid., Quickpay rejected the API key., API key is not configured. or Connection failed: followed by the reason.

Test payments: accept payments made with Quickpay test cards. Quickpay has no separate sandbox: while your Quickpay account is in test mode, payments are made with test cards and flagged as test. Turn this on only while testing. When it is off, a test payment never marks an order as paid. While it is on, customers see Test mode: Quickpay test cards are accepted. at the Confirm Order step. Default: off.

Payment

Capture: when the money is taken from the card.

Order status after payment: which status a paid order gets once Quickpay has confirmed the captured payment.

Order statuses

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after the signed Quickpay callback. Each field below lists your OpenCart order statuses.

"Payment accepted" status: the captured payment was confirmed and the amount and currency match. Default: Processing.

"Delivered (completed)" status: used instead when Order status after payment is Delivered (completed). Default: Complete.

"Quickpay payment on hold" status: the payment is authorized only and waits for the capture, the amount or currency does not match, or the capture failed. Default: Pending, because OpenCart has no On hold status; a note on the order explains why. You can create your own status in System > Localisation > Order Statuses and select it here.

Cancelled status: set when the payment of an order on hold is cancelled in Quickpay. When you set an order of this extension to this status, its unpaid payment link is deleted in Quickpay (see Orders and refunds). Default: Canceled.

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

Advanced

Debug log: writes to qpg_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 qpg_debug.old.log.php. Errors and warnings, such as rejected callbacks and Quickpay API errors, are always logged. Turn this on to log the details of every request and callback too. API keys, card data and customer details are never logged. Default: off.

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

Delete data: when on, uninstalling the extension removes the gateway settings and the log. Order data (Quickpay payments, refunds, notes) is always kept. Default: off.

Import / Export

Export: Download JSON saves the settings as a JSON file. The API key and the private key are not exported.

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

Checkout

At the Payment Method step the customer chooses the payment method (by default Quickpay). At the Confirm Order step the customer sees your description and the note You will be redirected to the Quickpay payment window to complete the payment. OpenCart creates the order at this step, still without a status. When the customer clicks Confirm Order, the extension creates a Quickpay payment in the order currency and a payment link for the order total, and sends the customer to the Quickpay payment window. The customer pays there with one of the methods enabled on your Quickpay payment window. The customer's e-mail is passed to Quickpay. The payment window opens in the customer's language when Quickpay offers it (Danish, German, English, Spanish, Finnish, French, Italian, Dutch, Norwegian, Polish, Swedish), otherwise in English. 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 paying, the customer returns to your store. The return itself does not mark anything as paid. The order is marked paid only after Quickpay confirms it: the signed callback sets the order status once the captured amount and currency match the order. 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 Authorize only, the order gets the "Quickpay payment on hold" status instead, and you capture the payment later. If the callback has not arrived yet when the customer comes back, a Payment confirmation page shows Your payment is being confirmed by Quickpay. You will receive an e-mail as soon as the order is confirmed. with the buttons Check again and Back to checkout. When the Quickpay callback later moves an order from "Quickpay payment on hold" status to the paid status or to Cancelled status, the customer is notified by e-mail.

If the customer cancels on the payment window, the payment link is deleted in Quickpay and the customer is back at checkout with The payment was cancelled. You can try again or choose another payment method. If the card was declined, the message is The payment was not completed. You can try again or choose another payment method. The cart is kept. A new attempt of the same order gets a fresh link of the same Quickpay payment. OpenCart 3 creates a new order every time the Confirm Order step is shown; the payment links of the earlier orders of the same cart are then deleted, so an old link can never be paid in parallel. While a payment of the cart is authorized and waits for its capture, no second payment is started; the customer sees the Payment confirmation page.

On OpenCart 4 the cancel and decline messages are shown above the checkout page. OpenCart 4 keeps one order for the checkout and updates it each time the Confirm Order step is shown, so after a cancel or a decline the same order is paid with a fresh link of the same Quickpay payment. If that order was closed without a payment 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., and the next Confirm Order pays a new order. If the order of the checkout already has a status 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.

If the payment cannot be started, the customer stays at the Confirm Order step with The Quickpay payment could not be started. Please try again or choose another payment method. above the button. The technical reason is written to the log. If the keys are missing, the message is Quickpay is not available at the moment. Please choose another payment method.

The callback 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 payments only. It has no subscriptions or recurring payments, no saved cards, no partial capture, sends no basket or invoice lines to Quickpay and has no separate MobilePay, Apple Pay or Klarna methods: the customer chooses among the methods of your Quickpay payment window.

Orders and refunds

Order statuses

No status (missing order): the customer was sent to Quickpay and has not paid, the card was declined, or the payment is authorized and waits for the automatic capture. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders.

"Payment accepted" or "Delivered (completed)" status: Quickpay confirmed the captured payment with the right amount and currency. The status follows Order status after payment. A note shows the Quickpay payment ID (marked TEST for test payments).

"Quickpay payment on hold" status (default Pending): the payment is authorized only and waits for Capture Quickpay payment; or Quickpay reported a different amount or currency than the order total (for example, a different amount was captured in the Quickpay manager); or the capture failed and the amount is still only reserved. The note explains it. When money was captured with a different amount, the extension records the amount Quickpay captured, and refunds go up to that amount.

Cancelled status: the payment of an order on hold was cancelled in the Quickpay manager.

Refunded status: the payment was fully refunded through the extension.

A payment that arrives for an order that is already paid, cancelled or refunded does not change the order. A note asks you to check the payment in the Quickpay manager, for example to refund a double payment. If another order of the same cart has already been paid, the new order stays without a status and the paid order gets the note.

When you set an unpaid order of this extension to the Cancelled status in the order History, its payment link is deleted in Quickpay. Cancelling an authorized order does not release the reserved amount automatically: a note reminds you to cancel the payment in the Quickpay manager; otherwise the reservation ends when the authorization expires.

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

VibeFox Quickpay Gateway tab

In Sales > Orders open an order paid with Quickpay. At the bottom of the order page, next to History and Additional, the VibeFox Quickpay Gateway tab shows the Payment ID with a Test payment label for test payments, the payment Status, Amount / refunded, the list of all Quickpay payments of the order (when there is more than one), the capture button, the refund form, the refund history and the Quickpay notes of the order. The tab is shown to users who have access to the extension. Capture and refunds need the right to modify the extension (set in System > Users > User Groups).

Capture

With Authorize only, click Capture Quickpay payment in the tab and confirm Capture the order total through Quickpay? The order total is captured; partial capture is not available. If Quickpay confirms at once, the order is set to the paid status of Order status after payment, without notifying the customer and without changing stock, like a manual status change. Otherwise a note says the capture was requested, and the order is marked paid when the Quickpay callback confirms it. A rejected capture is shown in the tab and noted on the order.

Refunds

In the tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Quickpay. Confirm the question Refund this amount through Quickpay? This cannot be undone. Full and partial refunds are supported for captured payments. Refunds are made in the amount and currency Quickpay captured, not the order total. Quickpay processes refunds asynchronously: the refund history shows requested, and the callback sets it to confirmed or failed and adds the result to the notes. A failed refund does not count as refunded. If Quickpay rejects the refund at once, 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; a partial refund does not change the status. An authorized payment that was never captured cannot be refunded; cancel it in the Quickpay manager.

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

Refunds made directly in the Quickpay manager are only added to the notes. 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 Quickpay Gateway is the first block on Extensions > Extensions > Payments > VibeFox Quickpay 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-quickpay 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, Quickpay 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 capture 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

Quickpay does not appear at checkout: check that the license is active, Enable/Disable is on and both API key and Private key are saved. Without both keys the method is hidden, and the settings page shows a warning. 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 Quickpay callback did not reach your store or was rejected. Check that your store is reachable from the internet (no password protection) and that Private key is the private key of the same Quickpay account. Rejected callbacks are always written to the log on the extension page. Turn on Debug log to see every callback.

Log shows Callback rejected: invalid checksum.: the private key in the settings does not belong to the account that sent the callback. Copy it again from Settings > Integration in the Quickpay manager.

Log shows Callback rejected: the private key is not configured.: enter the private key. Callbacks are never accepted without it.

Log shows Callback: no order found for payment …: the callback belongs to a Quickpay payment that this store did not create, for example a payment made outside OpenCart.

Log shows that the cart is locked by another request: another callback of the same cart was being applied at that moment. The callback is answered with an error, so Quickpay sends it again.

A test payment did not mark the order paid: Test payments is off. The log and a note on the order say the test payment was not accepted. Turn the setting on while testing, and off when your account goes live.

Order is in the on-hold status after payment: read the notes in the VibeFox Quickpay Gateway tab. The payment may be authorized only and waiting for Capture Quickpay payment, the paid amount or currency may differ from the order, or the capture failed. Capture, fulfil the order or refund the payment.

Test API key says Quickpay rejected the API key.: the key is wrong or belongs to a user without API access. Copy the API key of an API user from the Quickpay manager.

The customer sees The Quickpay payment could not be started.: look at the Log field on the extension page. It shows the Quickpay error, for example a currency your Quickpay account does not accept.

Refund fails: the order must have a captured Quickpay payment. The message The Quickpay payment of this order has not been captured — there is nothing to refund. means the payment is only authorized; capture it or cancel it in the Quickpay manager. Invalid refund amount: at most … means the amount is above what is left of the captured payment.

For developers: before the payment link is created, the extension triggers the OpenCart event qpg_quickpay_link_data with the link parameters and the order.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox Quickpay 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 statuses of the Order statuses 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 callback and the return of the customer through in maintenance mode). If Delete data is on, the other gateway settings (title, description, keys, test payments, capture, logging) and the log are removed. If it is off, they are kept for a later re-install. The Quickpay payments 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 Quickpay Gateway in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

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