Back

VibeFox Comgate for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

PHP: 8.0 or later. The module refuses to install on older PHP versions.

HTTPS: your shop must be reachable over HTTPS from the internet, 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 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 shop 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

1. In the back office go to Modules > Module Manager and click Upload a module. Choose the module ZIP file.

2. When the upload finishes, click Configure, or find VibeFox Comgate Gateway in the module list later and click Configure.

3. Paste your VibeFox license key into License key in the license block at the top of the Configure 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.

On install the module creates the order status Comgate payment on hold. PrestaShop offers a new payment module for all currencies, countries and customer groups. You can limit them in Payment > Preferences.

Configuration

All settings are on the module page: Modules > Module Manager > VibeFox Comgate Gateway > Configure. Each section has its own Save button, which saves the whole page. Above the fields 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 shop 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.

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.

Description: the text shown under the payment method at checkout. 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.

Comgate connection

Take the shop identifier (Merchant ID) and the password (secret) from the Comgate client portal, Integration > shop connection settings. In the same place set the URL for passing the payment result (background notification) to the URL shown in Notification URL in this section. With friendly URLs it looks like https://your-shop/module/wcp_comgate_gateway/webhook, possibly with a language code such as /en/. Copy the URL exactly as the settings show it. Comgate calls it after every payment; the module then re-checks the payment with the Comgate status API before it changes anything. 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 return?id=${id}&refId=${refId}.

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

Secret: the password for background communication (secret) of this shop 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.

Clear the saved secret: tick it and click Save to remove the saved secret. An empty field keeps the saved value.

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 shop in Comgate are shown.

All methods: every method enabled for your shop (default).
Cards only: card payments only.
Bank transfers only: bank payments only.

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

Orders

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

Payment accepted (WooCommerce default "Processing"): the standard PrestaShop status for paid orders (default).
Delivered ("Completed"): every paid order becomes Delivered.

Payments that do not match the order, test payments in live mode and pre-authorized payments always go to Comgate payment on hold.

Advanced

Debug Log: writes API requests and notifications to logs/comgate_p_debug.log.php in the module folder. The file cannot be opened from the web. The secret and personal data are never logged. Errors are always logged. Default: off.

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

Delete Data on Uninstall: when on, uninstalling the module removes the gateway settings and the log. Orders and their Comgate transaction IDs are always kept. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default Comgate) and confirms the order. The module creates the payment at Comgate for the cart total in the cart currency and redirects the customer to the Comgate payment page. The customer's e-mail and name are passed to Comgate, and the payment is labelled Cart and the cart number. A valid e-mail address is required. On the Comgate page the customer pays with one of the methods you allowed. No order exists yet at this point.

After paying, the customer returns to your shop. The order is marked paid only after Comgate confirms it: the module reads the payment from the Comgate status API, both when the background notification arrives and when the customer comes back. The order is then created and the customer sees the standard order confirmation 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. If a pre-authorized order was cancelled later, the page shows Your Comgate payment was not completed. Please contact us about this order.

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 created 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. The cart is kept. Each new attempt checks the previous one first, so a payment that already went through is not charged twice, and the previous one is cancelled at Comgate if it is still open. A late payment of an older attempt still creates the order.

If Comgate cannot start the payment, the customer stays at checkout with a short message, 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 works while the shop is in maintenance mode and is not blocked by the country restriction of your shop.

The module 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 PrestaShop. Without the notification the payment status is not polled automatically; it is checked only when the customer returns.

Orders and refunds

Order statuses

No order yet: the customer was sent to Comgate and has not paid, or Comgate reports the payment as pending. Only the cart exists.

Payment accepted or Delivered: Comgate reported the payment as PAID with the same amount and currency. The status follows Order Status After Payment. The payment is recorded with the Comgate transaction ID. Test payments get the note Comgate test payment — no money was charged.

Comgate payment on hold: the paid amount or currency differs from the order, a test payment was confirmed while the shop 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.

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: the payment was fully refunded through the module.

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. A replayed confirmation never reopens a refunded order.

Comgate payment block

The order page shows a Comgate payment block with the transaction ID, the Comgate status, the payment amount, the order total and the amount refunded, a Test mode badge for test payments, the reason for a review, the refund history and the Comgate notes of the order.

Refunds

In the Comgate payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, 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 edit orders; access to the Modules pages is not needed. 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 block 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. 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 PrestaShop; refund it in the Comgate portal. The module does not create credit slips. The standard PrestaShop refund buttons of the order page do not send money back through Comgate. Refunds made in the Comgate portal are not reported back to the shop.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Comgate Gateway is the first block on Modules > Module Manager > VibeFox Comgate Gateway > Configure, 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 shop. Below them are the line Product: presta-payment-comgate and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only employees with the Configure permission for the module can change the key. The texts of the block follow the back office 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 shop address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the module keeps working on the last known status.

One key works on one domain: the domain of the main shop, also in a multistore setup. Removing the key from the shop 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. The PrestaShop storefront does not know that you are logged in to the back office, so the payment method is hidden for you too: you can set up the module before you buy a key, but not test it at checkout. A reminder appears in Modules > Module Manager on the Alerts tab. Existing orders are not affected: payments already started are still confirmed, and refunds work.

When a license expires, the module keeps working, but updates and support need a renewal. The status is checked again automatically while you work in the back office: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling or resetting the module 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 cart currency is supported and the order total is not below the Comgate minimum (for example 1 CZK, 0.10 EUR or 100 HUF). In Payment > Preferences check that the module is allowed for the cart currency, the customer's country and the customer's group.

The payment went through, but no order was created: 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 shop is reachable over HTTPS from the internet and the log (turn on Debug Log). Comgate repeats undelivered notifications; the module answers with an error whenever it did not process one, so it will be retried. The order is also created when the customer returns to the shop.

Notification answers Invalid merchant or secret: the Merchant ID or secret in the settings does not match the shop 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 shop for that cart. 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 cart was being processed by another request at the same moment. Busy is also the answer when the order could not be created; 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 cart. If money was charged, the notification still creates the order. Check the payment in the Comgate portal before the customer pays again.

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 cart cannot be paid with Comgate as it is.

Order is Comgate payment on hold after payment: read the notes in the Comgate payment block. 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.

Refund fails: read the message in the block. 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.

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox Comgate Gateway and choose Uninstall. The license key and license status of this module are always removed. If Delete Data on Uninstall is on, the gateway settings and the log are removed. If it is off, all settings are kept for a later re-install. The Comgate transactions and refunds and the order status Comgate payment on hold are always kept, so orders paid before can still be refunded after a re-install. Existing orders keep their payment notes and transaction IDs.

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