VibeFox Culqi 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: Peruvian Sol (PEN) or US Dollar (USD) must be an enabled currency of your store. Culqi accepts no other currencies, and the payment method is shown only when the customer pays in PEN or USD.

Culqi account: you need the public key and the secret key of your Culqi account. Integration (test) keys come from integ-panel.culqi.com, production (live) keys from mipanel.culqi.com, in CulqiPanel > Desarrollo > API Keys. The public key is used by the Culqi popup in the browser. The secret key is used only on your server and is never sent to the browser. No webhook is 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_culqi_payment-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_culqi_payment.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_culqi_payment-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 Culqi Payment 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 integration keys and, for real payments, the production keys (see Configuration).

5. Turn on Enable/Disable and click Save. Keep Test Mode on while you test, then turn it off to take real payments.

OpenCart 4

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

4. Enter the license key and the Culqi keys as in steps 3 to 5 for OpenCart 3. The settings page and its fields are the same in both versions.

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 Culqi Payment > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Above the settings the page shows Test mode is active: the integration keys are used and no real money is charged. while test mode is on. It warns you when the gateway is enabled but the keys of the current mode are missing, and when no enabled store currency is supported by Culqi. In both cases the payment method is hidden at checkout. If your default currency is not PEN or USD, the page notes that Culqi is offered only when the customer pays in a supported currency. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, a wrong value is not saved and keeps its previous value, while the other fields are saved. The page shows an error for each such field: a key with the wrong prefix (for example Live Secret Key must start with sk_live_ — the previous value was kept.), an empty Title or one longer than 128 characters, a Sort Order that is not a whole number, a Total that is not a number of 0 or more, a geo zone or order status that does not exist.

Culqi

Enable/Disable: Enable Culqi 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: Credit/Debit Card or Yape (Culqi). Required, up to 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay securely with your credit/debit card or Yape via Culqi.

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

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

API keys

Copy the keys from CulqiPanel > Desarrollo > API Keys: integration (test) keys in integ-panel.culqi.com, production keys in mipanel.culqi.com (the page links there). Test mode uses only the test keys, live mode only the live keys. Each key must start with the prefix of its field.

Test Mode: when on, the test keys (pk_test_ / sk_test_) are used and no real money is charged. Default: on. Turn it off to take real payments with the live keys. While it is on, customers see TEST MODE: No real charges will be made. at the Confirm Order step.

Test Public Key: the public key of the integration environment. It starts with pk_test_.

Test Secret Key: the secret key of the integration environment. It starts with sk_test_ and is never shared with the browser.

Live Public Key: the public key of the production environment. It starts with pk_live_.

Live Secret Key: the secret key of the production environment. It starts with sk_live_ and is never shared with the browser.

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

Payment methods

Cards are always offered. Bank transfer, agents, wallets and Cuotéalo need the Culqi Orders API and are not offered by this extension.

Yape: Offer Yape in the Culqi popup shows Yape next to cards in the Culqi window. Default: on.

Orders

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

Order Status After Payment: Culqi confirmed the charge and its amount and currency match the order. Default: Processing.

On Hold (Review) Status: Culqi charged an amount or currency that does not match the order, or did not capture the payment. A note explains what to check in CulqiPanel. 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: the payment was fully refunded from the order page. Partial refunds only add a note. Default: Refunded.

Advanced

Debug log: logs API requests and payment steps to culqi_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 culqi_p_debug.old.log.php. Errors, including card declines with their code, are always logged. 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 on uninstall: when on, uninstalling the extension removes the gateway settings and the log. Culqi charges and refunds always stay, so orders paid before can still be refunded after a re-install. Default: off.

Import / Export

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

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

Checkout

At the Payment Method step the customer chooses the payment method (by default Credit/Debit Card or Yape (Culqi)). At the Confirm Order step the customer sees your description, and OpenCart creates the order, still without a status. When the customer clicks Confirm Order, the Culqi Checkout popup opens on the same page with your store name, the order total and the currency. There the customer enters the card details or pays with Yape. The Culqi scripts are always loaded from Culqi. 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 in the confirm block at the bottom of the checkout page. If the store does not ask for a payment address (the OpenCart 4 default), the customer details sent with the charge are taken from the delivery address and the customer's name.

Culqi turns the payment data into a single-use token, and only the token is sent to your store. Your server creates the charge with the Culqi Charges API for the order total in the order currency, captured immediately. The charge shows in CulqiPanel as Order and the order number, with the customer's e-mail. The order is marked paid only after Culqi 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.

If the bank requires 3-D Secure, the customer sees Your bank requires additional verification (3-D Secure). Please complete it in the window that opens. After the authentication the charge is sent again automatically. If the verification is not completed, the customer sees The 3-D Secure verification was not completed. Please try again or use another card.

If the card is declined, the customer sees the message from Culqi after Payment failed: and can try again with another card on the same step. If Culqi does not answer, the customer sees We could not confirm your payment with Culqi. Please check your email or contact us before trying again. In these cases the order stays without a status and a note on the order records the attempt. If the customer closes the Culqi window, nothing is charged and the Confirm Order button can be clicked again. The cart is kept in all these cases.

An order is never charged twice. If the customer submits again while a payment of the same order is running, the customer sees This order is already being paid. Please wait a moment and check your email before trying again. If Culqi took the money but the order status could not be set, the customer sees Your payment was received, but the order could not be completed automatically. Please contact us — do not pay again. The charge is kept, and the next attempt with the same cart sets the order status from it without a new charge. A cart is paid only once: if another order of the same cart (OpenCart 3 creates a new order every time the Confirm Order step is shown) is already paid, the customer goes to the success page and is not charged again. OpenCart 4 keeps one order for the checkout and updates it, so after a declined card the customer pays the same order.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was closed by the store meanwhile (for example cancelled or refunded), or it is already paid and the cart has changed since (other products or quantities), Confirm Order sends the customer back to the checkout, which makes a new order of the cart with its own payment. An order that was paid and then closed no longer holds the cart.

The extension takes one-time card and Yape payments only, captured immediately. It has no bank app, agents, wallets or Cuotéalo, no saved cards, subscriptions or installments, no Culqi webhooks and no separate authorize and capture.

Orders and refunds

Order statuses

No status (missing order): the customer has not paid yet, the card was declined, or Culqi did not answer. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders. Notes in the order history explain failed attempts.

Order Status After Payment (default Processing): the charge was confirmed and matches the order. A note shows Culqi payment successful with the mode (test or live), 3-D Secure if used, and the Culqi charge ID (chr_...).

On Hold (Review) Status (default Pending): Culqi reported a charge whose amount or currency does not match the order, or a payment that was authorized but not captured. The note explains it and shows the charge ID. Check the charge in CulqiPanel, then fulfil the order or refund the payment.

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

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

VibeFox Culqi Payment tab

In Sales > Orders open an order paid with Culqi. At the bottom of the order page, next to History and Additional, the VibeFox Culqi Payment tab shows the Charge ID with a Test label for test payments, the charged Amount (with 3-D Secure if used), a Review hint for orders on hold, the amounts Paid / refunded, the refund form, the refund history and the Culqi notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox Culqi Payment tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Culqi. Confirm the question Refund this amount through Culqi? 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 made in the amount and currency Culqi charged, so after an amount mismatch you can refund up to what the customer actually paid, not the order total. The refund is sent with the keys of the mode the payment was made in (test or live), even if you have switched mode since, so that mode's secret key must be set. If Culqi 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 Culqi refund ID, the amount and your 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.

Product returns in Sales > Returns do not send money back through Culqi. Refunds made in CulqiPanel are not synced back to 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 Culqi Payment is the first block on Extensions > Extensions > Payments > VibeFox Culqi Payment > 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-culqi 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, Culqi 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

Culqi does not appear at checkout: check that the license is active, Enable/Disable is on, both keys of the current mode are set (Test Public Key and Test Secret Key in test mode, Live Public Key and Live Secret Key in live mode) and the customer pays in PEN or USD. The settings page shows a warning when the keys are missing. 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 extension does not use webhooks. The charge is confirmed only by the answer of Culqi to your server. If Culqi did not answer in time, the order has the note Culqi did not confirm the charge. Find the charge of this order in CulqiPanel. If the customer saw the message that the order could not be completed, the next payment attempt in the same customer session sets the status without charging again.

Order is in the review status after payment: read the notes in the VibeFox Culqi Payment tab. The charged amount or currency differed from the order, or the payment was not captured. Check the charge in CulqiPanel, then fulfil the order or refund the payment.

The key is not saved: the error says that the field must start with a prefix, for example sk_live_. Each field accepts only keys of its own type and mode: pk_test_, sk_test_, pk_live_ or sk_live_.

The customer sees Payment gateway misconfiguration. Please contact the store owner.: the keys of the current mode are missing, or Culqi rejected the secret key. Check the keys in the settings.

The customer sees Payment token is invalid. Please try again.: the token from the Culqi window belongs to the other mode, for example after switching Test Mode while the checkout page was open. The customer should reload the page and pay again.

The Culqi window does not open: the customer sees The Culqi payment window could not be loaded. Please reload the page and try again. Check that scripts from js.culqi.com and 3ds.culqi.com are not blocked on your checkout page, for example by a cache or optimization extension.

The customer sees Security check failed. Please reload the page and try again.: the checkout page was open in another session. Reloading the page fixes it.

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

A card was declined and you want the reason: read the note on the order or the Log field on the extension page. Declines are logged with the Culqi decline code even when Debug log is off.

No refund form in the tab: the tab says why: the payment is fully refunded, your user group has no right to modify the extension, or the secret key of the payment mode is missing.

Refund fails with a message about the keys: the payment was made in test or live mode, and the secret key of that mode is not set. Enter it and try again.

Uninstall

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

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