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

Currency: the checkout currency must be MXN or USD. For other currencies the payment method is hidden.

Conekta account: you need the private API keys of your Conekta account (test and live) and a webhook in the Conekta panel (see Configuration). Only the private keys are used. The public key is not needed, because the payment happens on the Conekta hosted checkout.

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_conekta_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_conekta_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_conekta_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 Conekta 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 your test and live private keys, choose the mode and add the webhook in the Conekta panel (see Configuration).

5. Turn on Enable / Disable and click Save. Test a payment in test mode, then turn off Test mode.

OpenCart 4

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

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

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 Conekta 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 Conekta is enabled but the private key of the current mode is empty (the payment method is then hidden at checkout) and when the default currency of the store is not MXN or USD. While test mode is on it shows Test mode is on: payments are simulated with the test private key. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must not be empty, 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. Two warnings do not stop saving: when no payment method is selected (card payments are then offered) and when the gateway is enabled without the private key of the current mode.

Conekta

Enable / Disable: Enable Conekta payments turns the payment method on or off. Default: off.

Title: the payment method name the customer sees at checkout. It is also the payment method name stored in the order. Default: Conekta. 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 card, OXXO cash or SPEI transfer. You will be redirected to Conekta to complete your payment.

Payment methods: the methods offered on the Conekta payment page. Default: card, cash and bank transfer. Cash, SPEI and BNPL are available for MXN orders only (USD orders get cards only) and must be enabled in your Conekta account. If nothing is selected, card is used.

Credit / debit card: card payment.

Cash (OXXO and other stores): the customer gets a reference and pays in cash at a store.

Bank transfer (SPEI): the customer gets a reference and pays by bank transfer.

Buy now, pay later (BNPL): payment through a BNPL option, if enabled in your Conekta account.

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

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

API keys

Copy your private keys from the Conekta panel under Developers > API keys (the page links to the panel). Test and live keys are different.

Test mode: uses the test private key. No real money is charged, and the customer sees TEST MODE — No real charges will be made. at the Confirm Order step. Refunds always use the key of the mode the payment was made in. Default: on.

Test private key: the private API key from the test mode of your Conekta account.

Live private key: the private API key from the production mode of your Conekta account. Keep it secret.

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

Each Conekta order remembers its mode: notifications and refunds use the matching key. Keep both keys filled in while old test orders are still open.

Webhook

The webhook tells your store about payments, for example OXXO or SPEI payments made after the customer left the Conekta page. In the Conekta panel go to Developers > Webhooks and add the URL shown in Webhook URL in this section, for test and for live mode. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_conekta_gateway/webhook, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_conekta_gateway/payment/wcp_conekta_gateway.webhook. It is built from the storefront address of your OpenCart installation. Copy the URL exactly as the settings show it. It must be reachable from the internet.

Select these events (they are also listed in this section):

order.paid: the order was paid.

order.pending_payment: the order is waiting for payment, for example an OXXO or SPEI reference was issued.

order.declined: the payment was declined.

order.expired: the checkout or payment reference expired.

order.canceled: the Conekta order was cancelled.

order.refunded: the payment was refunded, for example in the Conekta panel.

order.charged_back: the customer disputed the payment (chargeback); the extension adds an order note.

The webhook body only tells the extension which Conekta order changed. Every notification is verified by reading the order back from the Conekta API with the private key of its mode; the webhook Digest signature header is not used. Notifications for Conekta orders that were not created by this store for that order are acknowledged and ignored. Without the webhook, an order is confirmed only when the customer comes back to the store after paying, or on the next payment attempt for the same cart.

Orders

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only after Conekta has reported the payment, by the webhook or when the customer returns; the order is always read back from Conekta. Each field below lists your OpenCart order statuses.

Order Status After Payment: the status set after a verified Conekta payment. Default: Processing.

Awaiting Conekta Payment Status: an OXXO or SPEI reference was issued to the customer, and Conekta has not received the money yet. Default: Pending.

Conekta Payment On Hold Status: paid, but the amount or currency differs from the order, a TEST payment arrived in live mode, the order was already cancelled, or the payment is only pre-authorized. A note explains why. Default: Pending, because OpenCart has no On hold status. You can create your own statuses in System > Localisation > Order Statuses and select them here.

Payment Expired / Canceled Status: an order awaiting payment whose Conekta reference expired or whose Conekta order was cancelled. Default: Canceled.

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

Advanced

Debug log: logs API calls and notifications to wc_ckt_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web. Errors and warnings are always logged, even when this switch is off. Logs never contain API keys or customer contact data. 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 settings and the log. The Conekta transactions and refunds and the orders are always kept, so old orders can still be confirmed and refunded after a re-install. Default: off.

Import / Export

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

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

Checkout

At the Payment Method step the customer chooses the payment method (by default Conekta). At the Confirm Order step the customer sees your description and the note You will be redirected to Conekta to complete your payment. OpenCart creates the order at this step, still without a status. When the customer clicks Confirm Order, the extension creates a Conekta order for the order total in the order currency, with the products, surcharges, discounts, taxes and shipping, and sends the customer to the Conekta hosted checkout. The customer's name, e-mail, phone and shipping address are passed to Conekta, and the payment shows on the Conekta page as Order # and the order number. There the customer pays with one of the allowed methods. 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 billing details are taken from the delivery address and the customer's name.

After paying, the customer returns to your store. The order is marked paid only after Conekta confirms it: the extension reads the order from the Conekta API when the webhook 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. When the customer chose OXXO or SPEI and got a payment reference, the order gets Awaiting Conekta Payment Status and the success page shows Your Conekta payment reference has been issued. The order will be confirmed as soon as the payment is received. For an order on hold the page shows We are confirming your payment with Conekta. The order will be updated automatically — please do not pay again.

If the payment cannot be confirmed yet when the customer comes back, a Payment confirmation page shows the same text and a Check again button. The webhook sets the order status as soon as it arrives. On OpenCart 4 the browser does not send the store session when Conekta 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 declined, the order stays without a status and the customer is back at checkout with The Conekta payment was not completed. Please try again or choose another payment method. If the checkout expired or was cancelled, the message is The Conekta payment has expired or was cancelled. Please try again. On OpenCart 4 these 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 reads the earlier Conekta checkouts of the cart. An open checkout of the same order with the same amount is reused; otherwise the previous one is cancelled in Conekta before a new one is created, so an old link cannot be paid twice. If a previous checkout was already paid, its order is confirmed instead of charging again. A cart is paid only once: when another order of the same cart already holds a Conekta payment or an issued OXXO / SPEI reference, no new payment is started and the customer goes to the success page. If a second payment for the same cart still arrives, its order stays without a status and the paid order gets a note to refund the duplicate in the Conekta panel.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was closed meanwhile (for example its OXXO or SPEI reference expired, or you cancelled it), Confirm Order sends the customer back to the checkout with The Conekta payment has expired or was cancelled. Please try again., and the next Confirm Order pays a new order of the cart. If the order already has a status 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 Conekta cannot start the payment, the customer stays at the Confirm Order step with a short message above the button, for example The payment could not be started. Please try again in a moment or choose another payment method. Validation messages from Conekta, such as a minimum amount, are shown as Conekta sends them. The technical reason is written to the log.

The webhook 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 for the webhook.

The extension takes payments on the Conekta page only. It has no card form on your checkout page, no saved cards, subscriptions, pre-authorization and capture or monthly installments (MSI).

Orders and refunds

Order statuses

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

Order Status After Payment (default Processing): Conekta confirmed the payment with the same amount and currency. A note shows the payment method (for example the card brand and last four digits, OXXO / cash or SPEI transfer), the Conekta order and the charge.

Awaiting Conekta Payment Status (default Pending): the customer got an OXXO or SPEI payment reference. The order moves to Order Status After Payment when Conekta reports the payment.

Conekta Payment On Hold Status (default Pending): the amount or currency received from Conekta does not match the order, a test-mode payment arrived while the store is in live mode (no real money was collected), or the payment arrived for an order that was already cancelled. The note explains it. Check the order, then fulfil it or refund the payment. An order that is only pre-authorized in Conekta is also put on hold with a note to capture or void it in the Conekta panel.

Payment Expired / Canceled Status (default Canceled): the OXXO or SPEI reference of an awaiting order expired, or its Conekta order was cancelled.

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

A paid or refunded order is never downgraded or re-opened. If another Conekta payment arrives for an order that is already paid, a WARNING note asks you to refund it in the Conekta panel.

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

VibeFox Conekta Gateway tab

In Sales > Orders open an order paid with Conekta. At the bottom of the order page, next to History and Additional, the VibeFox Conekta Gateway tab shows the Conekta order with a Test mode label for test payments, the Charge, the payment Status, the amounts Paid / refunded, the refund form, the refund history and the Conekta notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the VibeFox Conekta Gateway tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Conekta. Confirm the question Refund this amount through Conekta? 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 limited to the amount and currency Conekta actually charged, so after an amount mismatch you can refund up to what the customer paid, not the order total. The refund goes to the Conekta order that holds the payment and uses the key of the mode the payment was made in, so that key must be set. If Conekta 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, mode, Conekta order, refund ID and 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 once Conekta has reported the payment.

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

Refunds made in the Conekta panel arrive by the webhook and are added as a note with the amount refunded in Conekta and in OpenCart. They are not recorded automatically. Update the order manually without Refund via Conekta. A chargeback reported by Conekta is also added as a note.

License key

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

Conekta does not appear at checkout: check that the license is active, Enable / Disable is on, the private key of the current mode is filled in (Test private key in test mode, Live private key in live mode) and the checkout currency is MXN or USD. The settings page shows a warning when the key is missing or the store currency is not supported. 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 webhook is not working. In the Conekta panel check that the webhook exists for the mode you use (test or live), that its URL is exactly the one shown in Webhook URL and that the events are selected. Check that the private key of that mode is set, because every notification is verified with it. The order also gets its status when the customer returns to the store, or when the customer tries to pay the same cart again.

Webhook answers Temporarily unavailable: the Conekta API could not be reached, the private key of the order's mode is missing, the order was being processed by another request, or the order status could not be set. Conekta retries the webhook. Look at the Log field for the reason.

Webhook answers Verification failed, Invalid payload or Invalid order id: the Conekta API did not confirm the order, or the notification was not a valid Conekta order event.

Webhook answers Ignored: the notification belongs to a Conekta order that was not created by this store for that order (for example another store or a payment link on the same account), or to another object than an order.

The webhook URL shows Method not allowed in the browser: this is normal. The URL accepts only requests from Conekta.

The customer sees We could not check the status of your previous payment attempt: the previous Conekta checkout of the cart could not be read, so a new one is not created to avoid a double payment. Try again in a moment.

The customer sees Payment gateway is not configured: the private key of the current mode is missing.

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

The customer sees Payment verification failed: the return link from Conekta did not match the order. Check the order in the Conekta panel; the webhook still confirms a real payment.

Order is in the awaiting or on-hold status: read the Conekta notes in the order tab. The customer has not paid the OXXO or SPEI reference yet, the amount or currency did not match, a test-mode payment arrived while the store is in live mode, or the payment is only pre-authorized.

No refund form in the tab: the tab says why: Conekta has not reported the payment yet, it is fully refunded, your user group has no right to modify the extension, or the private key of the payment's mode is not set.

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

For developers: the OpenCart events wc_ckt_supported_currencies, wc_ckt_order_request, wc_ckt_allowed_payment_methods and wc_ckt_refund_reason let other extensions change the supported currencies, the Conekta order request, the payment methods and the refund reason.

Uninstall

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

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