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

Order currency: AED, BHD, EGP, EUR, GBP, JOD, KWD, OMR, QAR, SAR or USD. For orders in other currencies the payment method is hidden at checkout.

Internet access to your store: Tap sends the payment result to a webhook on your store, so the site must be reachable from the internet. The webhook URL is sent with every payment; nothing has to be configured in the Tap dashboard.

Tap account: you need the API keys from your Tap dashboard (goSell, API credentials). Test keys start with pk_test_ / sk_test_, live keys with pk_live_ / sk_live_. The secret key is always needed; the publishable key only for the checkout popup. Which payment methods are offered (mada, KNET, Benefit and others) and Apple Pay domain verification are set up in your Tap account.

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_tap_payment_gateway-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_tap_payment_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_tap_payment_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 Tap Payments 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 Tap test and live keys, choose the payment action, the checkout type and the Tap page language (see Configuration).

5. Turn on Enable / Disable and click Save. Test with Tap test cards, then turn off Test mode.

OpenCart 4

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

4. Enter the license key, the Tap keys and the payment options 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 Tap Payments > 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 on: payments use your Tap test keys and no real money is charged. or Live mode: real payments are accepted. It also warns you when the keys of the current mode are missing (the payment method is then not shown at checkout) and when the default currency of the store is not offered with Tap. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must not be empty or longer than 128 characters, Sort Order must be a whole number (negative values are allowed), Total must be a number, 0 or greater, and the order statuses must exist; otherwise nothing is saved. A key with the wrong prefix for its field is not saved: the previous value is kept, the other settings are saved and a message such as Test secret key was not saved: a Tap key for this field starts with "sk_test_". is shown. For example, a live key in a test field is rejected.

Tap Payments

Enable / Disable: Enable Tap Payments 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: Tap Payments. Required, at most 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay with Visa, Mastercard, mada, KNET, Benefit, Apple Pay or Google Pay.

Sort Order: the position of Tap among the payment methods at checkout. Leave it empty or enter a whole number (negative values are allowed).

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

Tap API keys

Find your keys in the Tap dashboard (goSell, API credentials). The section links to the Tap developer documentation.

Test mode: uses the test keys, no real money is charged. Payments, status checks, captures and refunds always use the keys of the mode the payment was made in, so a test payment is still checked and refunded with the test key after you switch to live. Default: on. While it is on, customers see Test mode: no real payment will be made. at the Confirm Order step and on the popup payment page.

Test publishable key: starts with pk_test_. Needed for the popup.

Test secret key: starts with sk_test_.

Live publishable key: starts with pk_live_. Needed for the popup.

Live secret key: starts with sk_live_.

Merchant ID: optional. Your Tap merchant ID, only needed if Tap asked you to route payments to a specific merchant account.

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 key, tick Clear the saved value under the field and click Save. The publishable keys are public and stay visible.

Payment

Payment action: what happens to the money when the customer pays.

Checkout type: where the customer pays.

Tap page language: language of the Tap payment page and of the popup: English (default) or Arabic.

Payment notifications (webhook)

Tap posts the payment result to the URL shown in Webhook URL in this section. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_tap_payment_gateway/webhook, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_tap_payment_gateway/payment/wcp_tap_payment_gateway.webhook. It is built from the storefront address of your OpenCart installation. The URL is sent with every payment, so nothing has to be configured in the Tap dashboard. Just make sure it is reachable from the internet (not blocked by a firewall or HTTP authentication); maintenance mode does not block it (on OpenCart 4 a startup action of the extension lets the webhook and the customer return through). Each notification is checked with the hashstring signature (HMAC-SHA256 with the secret key of the mode the payment was made in). Webhooks without a valid signature are rejected. Even a signed notification is not trusted as such: the extension reads the payment again from the Tap API before it changes the order. Without a working webhook, the order gets its status only when the customer returns to the store after paying.

Orders

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

Paid Order Status: the status after a captured payment. Default: Processing.

Authorized Status: Authorize only: the funds are reserved, not captured yet. Default: Pending.

On Hold (Review) Status: the payment needs your review (see Order statuses). Default: Pending, because OpenCart has no On hold status. You can create your own status in System > Localisation > Order Statuses and select it here.

Voided Status: set after Void Tap authorization released the reserved funds. Default: Canceled.

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

Advanced

Debug log: writes payment events to tap_p_debug.log.php in the OpenCart logs folder (storage/logs, on OpenCart 4 system/storage/logs). The file cannot be read from the web, and at 5 MB it is moved to tap_p_debug.old.log.php. Errors and warnings are always logged; turn this on to log every payment event as well. The log never contains keys, card or customer 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 gateway settings and the log. Payment records of orders are always kept. Default: off.

Import / Export

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

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

Checkout

At the Payment Method step the customer chooses the payment method (by default Tap Payments). At the Confirm Order step the customer sees your description. OpenCart creates the order at this step, still without a status. Then the customer clicks Confirm Order. 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.

Tap payment page: the extension creates a Tap charge (or an authorization in Authorize only mode) for the order total in the order currency, with the description Order # and the order number, and sends the customer to the Tap payment page. The customer's name, e-mail and phone number are passed to Tap. There the customer chooses a card, mada, KNET, Benefit, Apple Pay or Google Pay (as enabled in your Tap account) and pays. If Tap cannot start the payment, the customer stays at the Confirm Order step with The Tap payment could not be started. Please try again or choose another payment method. and the reason goes to the log.

Tap checkout popup: the customer goes to the Tap payment page of the extension, where the Tap payment form opens. The page also shows the link Pay on the Tap payment page instead. If the window is closed, the button Pay now opens it again. If the form cannot be loaded, the customer is asked to use the Tap payment page. Reloading the page reuses the same payment attempt.

After paying, the customer returns to your store. The order is marked paid only after Tap confirms it: the extension reads the payment from the Tap API with the key of the payment's mode, checks that it refers to this order and was started by its checkout, and compares the amount and currency with the order. The Tap ID in the return address alone never changes the order. The webhook does the same check in the background. 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. On OpenCart 4, when the customer comes back from the Tap payment page, a short intermediate page opens the return address again from your store, so the cart and the customer login are kept. For an authorized payment the page also shows Your payment has been authorized. We will process the order as soon as the payment is captured. For a payment on review it shows Your payment is being reviewed. We will contact you if anything else is needed.

If Tap has not confirmed the payment yet when the customer comes back, a Payment confirmation page shows We have not received the payment confirmation from Tap yet. If you completed the payment, the order will be updated automatically in a few minutes — there is no need to pay again. with the buttons Check again and Back to checkout. The webhook sets the order status as soon as it arrives.

If the payment was declined, abandoned or cancelled, the order stays without a status. The customer is back at checkout with Your payment was not completed. Please try again or choose another payment method. (with the reason from Tap when Tap gives one). An unfinished payment shows The payment was not completed. You can try again or choose another payment method. The cart is kept and can be paid again. On OpenCart 4 these messages are shown above the checkout page.

OpenCart 3 creates a new order every time the Confirm Order step is shown, OpenCart 4 updates the order of the checkout. If another order of the same cart has already been paid, the customer goes straight to the success page instead of paying again. Before a new payment is started, the open Tap payment pages of the order and the cart from the last 24 hours are checked with Tap, so a payment made in another tab is confirmed instead of charging twice. A change of the cart, including a new quantity, counts as a new cart that needs its own payment.

OpenCart 4 keeps the order in the checkout until the success page is shown. After a declined or cancelled payment the next Confirm Order starts a new Tap payment for the same order. If that order was closed without a payment meanwhile (for example you cancelled it or its authorization was voided), 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.

Other messages at checkout: Tap does not accept payments in followed by the currency, when the order currency is not supported, and The order total must be greater than zero to pay with Tap.

The extension has no saved cards or tokenization, no subscriptions and no card fields embedded in your checkout page. Capture Tap payment always captures the order total; partial capture is not supported.

Orders and refunds

Order statuses

No status (missing order): the customer was sent to Tap and has not paid, or Tap has not confirmed the payment yet. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders. On OpenCart 4.1 such an order can also have the status Voided, which OpenCart sets when the confirm step is shown again; the extension counts it as an order without a status.

Paid Order Status (default Processing): Tap confirmed a captured payment. A note shows the amount, the Tap charge ID (chg_...), the payment method and (test mode) for test payments.

Authorized Status (default Pending): the payment was authorized only and waits for capture or void.

On Hold (Review) Status (default Pending): the paid amount or currency differed from the order (Tap: amount/currency mismatch — manual review required.), or a payment arrived after the order had been cancelled. The note explains it. Check the order and fulfil it, or refund the payment.

Voided Status (default Canceled): the authorization was voided with Void Tap authorization, so the reserved funds were released.

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

A failed attempt never changes an order that already has a status. If a second successful payment arrives for an order that is already paid, the order is not changed. A note says it is a duplicate payment and asks you to refund it in the Tap dashboard. A payment for another order of a cart that is already paid leaves that order without a status and is noted on the paid order. A payment that refers to the order but was not started by its checkout is only noted.

Notes are entries in the order History that the customer does not see. They start with "Tap".

VibeFox Tap Payments tab

In Sales > Orders open an order paid with Tap. At the bottom of the order page, next to History and Additional, the VibeFox Tap Payments tab shows the Tap ID, the Authorization and the Charge, the Mode (a Test label for test payments), the payment Status and method, Charged / refunded, the refund form, the refund history, the Payment attempts of the order and the Tap notes. The tab is shown to users who have access to the extension; capture, void and refunds need the right to modify the extension (set in System > Users > User Groups).

Capture and void

In Authorize only mode, open the authorized order. Capture Tap payment (with the order total on the button) captures the order total after the question Capture the reserved funds of this order through Tap?; the order then gets the Paid Order Status. Void Tap authorization asks Release the reserved funds? The order will be canceled., releases the funds and sets the Voided Status. A second capture click within 2 minutes is blocked. If Tap rejects the action, an error is shown in the tab and added to the notes. These status changes are made without notifying the customer and without changing the stock, like a manual status change. If an authorization is captured directly in the Tap dashboard, the webhook marks the order paid; refunds for such a payment must be made in the Tap dashboard.

Refunds

In the tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Tap. Confirm the question Refund this amount through Tap? This cannot be undone. Full and partial refunds are supported for captured Tap charges. You can refund up to the amount and currency Tap actually charged, even if the order was edited later. The refund is sent with the secret key of the mode the payment was made in, so that mode's key must be set. A refund accepted by Tap is added to the refund history and the notes with the Tap refund ID and status. If Tap rejects it, the tab shows the error and no refund is recorded. A full refund sets the Refunded Status without notifying the customer and without returning products to stock; a partial refund does not change the status. For an authorized order refunds are available once the authorization is captured. An order on review after an amount or currency mismatch is refunded in the Tap dashboard.

Product returns in Sales > Returns do not send money back through Tap. Refunds made in the Tap dashboard do not appear in OpenCart.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox Tap Payments is the first block on Extensions > Extensions > Payments > VibeFox Tap Payments > 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-tap 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, Tap Payments 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, capture and void 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

Tap Payments does not appear at checkout: check that the license is active, Enable / Disable is on and the current mode has a secret key (and a publishable key when Checkout type is the popup). Check that the order currency is one of AED, BHD, EGP, EUR, GBP, JOD, KWD, OMR, QAR, SAR, USD, that the payment address is in the selected Geo Zone and that the order reaches the Total set in the settings. The settings page shows a warning for missing keys and an unsupported store currency.

The payment went through, but the order stays without a status: the webhook cannot reach your store. Check that the URL shown in Webhook URL is reachable from the internet (no firewall or HTTP authentication) and turn on Debug log to see the answers in the Log field. The order also gets its status when the customer returns from Tap.

Webhook answers invalid signature: the notification was not signed with the secret key of the payment's mode. Check the secret keys in the settings.

Webhook answers gateway not configured: the secret key of the payment's mode (test or live) is empty. Enter it.

Webhook answers verification failed: the Tap API could not be reached to check the payment. Tap retries the webhook later.

Webhook answers order not found: the notification names an order that has no Tap payment attempt in this store.

Webhook answers busy, retry later or order could not be updated, retry later: the order was being confirmed by another request at the same moment, or the order status could not be set. Tap retries the webhook. Look at the Log field for the reason.

A key is not saved: the key must start with the prefix of its field: pk_test_, sk_test_, pk_live_ or sk_live_.

The customer sees The Tap payment could not be started: look at the Log field on the extension page. A wrong key or a rejected request is logged there.

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

The customer sees We could not match this payment to an order: the payment does not belong to this order or was not started by its checkout. If money was taken, check the payment in the Tap dashboard.

The order is in the review status: read the notes in the VibeFox Tap Payments tab. The paid amount or currency did not match the order, or the payment arrived after the order had been cancelled.

Refund fails with a message about the mode: the payment was made in test or live mode, and no secret key is configured for that mode. Enter it and try again. If the tab says no captured Tap charge was found, refund the payment in the Tap dashboard.

For developers: the OpenCart events tap_p_charge_payload, tap_p_supported_currencies and tap_p_currency_decimals let a developer change the payment request, the supported currencies and the currency decimals.

Uninstall

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

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