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

Internet access: your store must be reachable from the internet, without a maintenance page, firewall or password protection in front of the notification URL, so that Comgate can deliver the background notification.

Currency: CZK, EUR, PLN, HUF, USD, GBP, RON, HRK, NOK or SEK. For other currencies and for totals below the Comgate minimum (for example 1 CZK, 0.10 EUR or 100 HUF) the payment method is hidden. HUF payments are rounded to whole forints, as Comgate requires.

Comgate account: you need the Merchant ID and the secret (password for background communication) of your store connection in the Comgate client portal, and the notification URL set there (see Configuration). Comgate uses the same Merchant ID and secret for test and live payments.

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_comgate_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_comgate_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_comgate_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 Comgate 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 ID and Secret from the Comgate client portal and set the notification URL there (see Configuration).

5. Turn on Enable / Disable and click Save. Keep Test Mode on for a trial payment, then turn it off.

OpenCart 4

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

4. Enter the license key, the Comgate credentials and the notification URL as in steps 3 to 5 for OpenCart 3. The settings page and its fields are the same in both versions. Only the notification and return URLs are different (see Configuration).

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 Comgate 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 Comgate is enabled but the Merchant ID or the secret is missing (the payment method is then hidden at checkout until both are filled in) and when the default currency of the store is not supported by Comgate. While test mode is on it shows Test mode is on: payments are created as Comgate test payments and no money is charged. Turn it off before going live. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must not be empty (at most 128 characters), Sort Order must be a whole number, Total a number that is not negative, and the selected geo zone and order statuses must exist. If any check fails, nothing is saved and the page lists the errors.

Comgate

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

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay securely via Comgate — cards, bank transfers, wallets and more. In test mode TEST MODE: no real money is charged. is added to it, or shown alone when the description is empty.

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

Geo Zone: offer Comgate 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 Comgate is offered. Leave it empty to offer Comgate for any total. The Comgate minimum of the currency always applies.

Comgate connection

Take the shop identifier (Merchant ID) and the password (secret) from the Comgate client portal, Integration > shop connection settings (the page links to the portal). In the same place set the URL for passing the payment result (background notification) to the URL shown in Notification URL in this section. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_comgate_gateway/notify, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_comgate_gateway/payment/wcp_comgate_gateway.notify. It is built from the storefront address of your OpenCart installation. Copy the URL exactly as the settings show it. Comgate calls it after every payment; the extension then re-checks the payment with the Comgate status API before it changes the order. Return URLs for the customer are sent with every payment. If the portal asks for return URLs (paid, cancelled, pending) too, use the second URL shown in this section, which ends with back&id=${id}&refId=${refId} (on OpenCart 4 with wcp_comgate_gateway.back&id=${id}&refId=${refId}).

Merchant ID: the Comgate e-shop identifier (merchant).

Secret: the password for background communication (secret) of this store connection. A saved secret is 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 the saved secret, tick Clear the saved secret under the field and click Save.

Test Mode: creates test payments (no money is charged). Comgate uses the same Merchant ID and secret for test and live payments; test payments are marked with test=true. Refunds are always sent in the mode of the original payment. Default: on.

Payment page

Payment Methods: which Comgate payment methods the customer can choose from. Only methods enabled for your store in Comgate are shown.

Language: the language of the Comgate payment page. Automatic (store language, English as fallback) (default) or one of 26 languages.

Orders

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after Comgate has confirmed the payment, by the background notification or when the customer returns; the state is always read from the Comgate status API. Each field below lists your OpenCart order statuses.

Order Status After Payment: the status set when Comgate confirms the payment. Default: Processing.

Comgate Payment On Hold Status: payments that do not match the order, test payments in live mode and pre-authorized payments. A note explains why. 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 Canceled Status: a pre-authorized order whose Comgate payment was cancelled or has expired. Default: Canceled.

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

Advanced

Debug Log: writes API requests and notifications to comgate_p_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web. The secret and personal data are never logged. Errors are always logged, even while it 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. Orders and their Comgate transaction IDs are always kept. Default: off.

Import / Export

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

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

Checkout

At the Payment Method step the customer chooses the payment method (by default Comgate). At the Confirm Order step the customer sees your description and the note You will be redirected to the secure Comgate payment page. OpenCart creates the order at this step, still without a status. When the customer clicks Confirm Order, the extension creates the payment at Comgate for the order total in the order currency and sends the customer to the Comgate payment page. The customer's e-mail and name are passed to Comgate, and the payment is labelled Order and the order number. A valid e-mail address is required. On the Comgate page the customer pays with one of the methods you allowed. 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. If the store does not ask for a payment address (the OpenCart 4 default), the country of the delivery address is passed to Comgate.

After paying, the customer returns to your store. The order is marked paid only after Comgate confirms it: the extension reads the payment from the Comgate status API, both when the background notification arrives and 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. If the order was put on hold, the page adds Your payment is being reviewed. We will contact you if anything else is needed. On OpenCart 4 the browser does not send the store session when Comgate sends the customer back, so the extension first shows a short page that opens the same return address again from your store: the customer keeps the cart and the login.

If the payment is not confirmed yet when the customer comes back, for example a bank transfer on its way, a Payment confirmation page shows Comgate has not confirmed your payment yet. Your order will be confirmed automatically as soon as the payment is confirmed — please do not pay again. with a Check again button and a Back to checkout button.

If the payment is cancelled or expires, the customer is back at checkout with The Comgate payment was cancelled or has expired. You can try again or choose another payment method. On OpenCart 4 the checkout messages are shown above the checkout page. The cart is kept. Each new attempt (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) first checks the earlier attempts of the cart at Comgate. If one of them is already paid, its order is confirmed and the customer goes to the success page without a second charge; open attempts are cancelled at Comgate. A late payment of an older attempt is still recognised and confirms its order. A cart that is already paid by another order is not charged again: the customer goes to the success page.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was cancelled without a payment meanwhile, Confirm Order sends the customer back to the checkout with the message about the cancelled payment. If it was closed in another way (for example refunded or cancelled after the payment), the message is Your previous order is closed (cancelled or refunded). Please confirm the order again: the cart will be paid with a new order. In both cases the next Confirm Order pays a new order of the cart. If the order is already paid and the cart has changed since (other products or quantities), the customer is sent back to the checkout, and the changed cart gets a new order and its own payment.

If Comgate cannot start the payment, the customer stays at the Confirm Order step with a short message above the button, for example The Comgate payment could not be started. Please try again or choose another payment method., that Comgate cannot accept this amount or currency, or that the selected Comgate payment method is not available. The technical reason is written to the log.

The notification also works while the store is in maintenance mode: OpenCart 3 lets payment extension requests through, and on OpenCart 4 the extension adds a startup action that lets the notification and the customer's return through.

The extension takes one-time payments on the Comgate page only. It has no recurring payments, subscriptions or saved cards, no embedded Comgate checkout, no Apple Pay or Google Pay buttons on your site (they are available on the Comgate page) and no capture or cancellation of pre-authorizations from OpenCart. Without the notification the payment status is not polled automatically; it is checked only when the customer returns.

Orders and refunds

Order statuses

No status (missing order): the customer was sent to Comgate and has not paid, the payment was cancelled, or Comgate reports it as pending. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders.

Order Status After Payment (default Processing): Comgate reported the payment as PAID with the same amount and currency. A note shows the Comgate transaction and the amount. Test payments get the note Comgate test payment — no money was charged.

Comgate Payment On Hold Status (default Pending): the paid amount or currency differs from the order, a test payment was confirmed while the store is in live mode (no money was received), or the payment is only authorized (pre-authorization on your Comgate account). An authorized payment becomes paid automatically when you capture it in the Comgate portal. The note explains the reason.

Payment Canceled Status (default Canceled): an authorized payment was cancelled or has expired at Comgate. If Comgate confirms the payment after that, the order is reopened as paid with a note to check stock before shipping.

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

If Comgate reports another PAID payment for an order that is already paid, the order is not changed. A note asks you to check it in the Comgate portal and refund the duplicate. The same applies when the same cart is paid once more with another order (for example in two browser tabs at once): that order keeps no status, and the paid order gets the note. If a payment arrives for an order whose status you have changed meanwhile, the status is not touched and a note asks you to check the order. A replayed confirmation never reopens a refunded order.

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

VibeFox Comgate Gateway tab

In Sales > Orders open an order paid with Comgate. At the bottom of the order page, next to History and Additional, the VibeFox Comgate Gateway tab shows the Comgate transaction (transId) with a Test mode label for test payments, the Status, the Payment amount, the Order total / refunded, the reason for a review, the refund form, the refund history and the Comgate notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox Comgate Gateway tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Comgate. Confirm the question Refund this amount through Comgate? This cannot be undone. Full and partial refunds are supported. You need the right to modify the extension (set in System > Users > User Groups), and the Merchant ID and secret must be set. The refund goes to the paid Comgate transaction and is sent in the mode (test or live) of the original payment. Comgate refunds only PAID payments and at most the paid amount; HUF refunds must be whole forints. If Comgate does not accept the refund, the tab shows the error and no refund is recorded. A successful refund is added to the refund history and the notes with the amount, the Comgate transaction and the reason. 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 for paid orders only. An order on hold after an amount or currency mismatch cannot be refunded from OpenCart; refund it in the Comgate portal. Product returns in Sales > Returns do not send money back through Comgate. Refunds made in the Comgate portal are not reported back to the store.

License key

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

Comgate does not appear at checkout: check that the license is active, Enable / Disable is on, Merchant ID and Secret are filled in, the checkout currency is supported and the order total is not below the Comgate minimum (for example 1 CZK, 0.10 EUR or 100 HUF). 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: Comgate has not delivered the background notification. Check the URL for passing the payment result in the Comgate portal (exactly the Notification URL of the settings), that your store is reachable from the internet, and the log (turn on Debug Log). Comgate repeats undelivered notifications; the extension answers with an error whenever it did not process one, so it will be retried. The order also gets its status when the customer returns to the store.

Notification answers Invalid merchant or secret: the Merchant ID or secret in the settings does not match the store connection in the Comgate portal.

Notification answers Gateway not configured: the Merchant ID or secret is empty in the settings. Comgate retries once they are filled in.

Notification answers Unknown transaction, Order not found or Reference mismatch: the notification belongs to a payment that was not created by this store for that order. Nothing is changed.

Notification answers Status verification failed, Status verification rejected or Busy, retry later: the Comgate status API could not be reached, rejected the request, or the order was being processed by another request at the same moment. Busy is also the answer when the order status could not be set; the reason is in the log. Comgate retries the notification.

The notification URL shows code=1&message=POST%20required in the browser: this is normal. The URL accepts only requests from Comgate.

The customer sees We could not verify the Comgate payment: the return link did not match the order. If money was charged, the notification still confirms the order. Check the payment in the Comgate portal before the customer pays again.

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

The customer sees The order total is below the minimum amount accepted by Comgate or A valid billing e-mail address is required for Comgate payments: the order cannot be paid with Comgate as it is.

Order is in the on-hold status after payment: read the notes in the VibeFox Comgate Gateway tab. The paid amount or currency differed, a test payment arrived in live mode, or the payment is only authorized. Check the payment in the Comgate portal and complete or refund the order manually.

No refund form in the tab: the tab says why: the order has no confirmed Comgate payment, it is fully refunded, your user group has no right to modify the extension, or the Merchant ID and secret are not set.

Refund fails: read the message in the tab. Comgate rejected the refund: the amount exceeds the refundable amount. means the amount is higher than what is left to refund; a payment in another status than PAID cannot be refunded. Comgate could not be reached. The refund was not made — please try again later. means a connection problem.

For developers: the OpenCart events comgate_p_currencies (supported currencies and their minimums) and comgate_p_create_params (parameters of the Comgate payment and the order) let other extensions change them.

Uninstall

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

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