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

Flutterwave account: you need the secret keys of your Flutterwave account, from the Flutterwave dashboard under Settings, API keys: FLWSECK_TEST-… for test mode and FLWSECK-… for live mode. Only the secret keys are used. The public and encryption keys are not needed. You also set up a webhook with a secret hash of your choice (see Configuration).

Currencies: the order is always charged in the order currency. The extension does not restrict countries or currencies itself; Flutterwave shows an error if your account does not support the currency. You can limit where Flutterwave is offered with Geo Zone and Total.

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_flutterwave_payment-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_flutterwave_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_flutterwave_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 Flutterwave 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. Enter your secret keys, set up the webhook in the Flutterwave dashboard and enter the same secret hash in the extension (see Configuration).

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

OpenCart 4

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

4. Enter the license key, the secret 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 in test mode.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox Flutterwave 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 Live mode: real payments are accepted. or Test mode: no real money is charged. It warns you when the secret key of the current mode is empty, when the live key field contains a test key (FLWSECK_TEST-…) in live mode, or when the test key field contains a live key (FLWSECK-…) in test mode; the payment method is then hidden at checkout until this is fixed. It also warns you when no webhook secret hash is set: webhooks are then rejected and payments are confirmed only when the customer returns to your store. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must have 1 to 128 characters, Sort Order must be empty or a whole number, Total must be empty or a number of 0 or more, and the selected geo zone and order statuses must exist. Otherwise nothing is saved and the page shows what to correct. Key problems do not block saving.

Flutterwave

Enable/Disable: Enable Flutterwave Payment turns the payment method on or off. Default: off.

Title: the payment method title customers see during checkout. It is also the payment method name stored in the order. Default: Flutterwave. Required, up to 128 characters.

Description: the payment method description shown on the Confirm Order step, above the confirm button. Default: Pay securely via Card, Bank Transfer, USSD, Mobile Money via Flutterwave.

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

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

API keys

Copy the secret keys from the Flutterwave dashboard under Settings, API keys (the section has a link). Test mode and live mode have different keys.

Live mode: accept real payments. Turn it off for test mode. Test mode uses the test secret key and no real money is charged. Live mode uses the live secret key. Default: off (test mode). While test mode is on, customers see TEST MODE - no real payments will be processed. at the Confirm Order step.

Test Secret Key: your Flutterwave test secret key (FLWSECK_TEST-...).

Live Secret Key: your Flutterwave live secret key (FLWSECK-...).

Saved keys and the secret hash 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 value, tick Clear the saved value under the field and click Save.

Webhook

The webhook confirms payments even when the customer does not return to your store. In the Flutterwave dashboard under Settings, Webhooks, enter the URL shown in Webhook URL in this section and a secret hash of your choice, in test mode and in live mode. On OpenCart 3 the URL looks like https://your-store/index.php?route=extension/payment/wcp_flutterwave_payment/webhook, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_flutterwave_payment/payment/wcp_flutterwave_payment.webhook. It is built from the address of your store. It must be reachable from the internet over HTTPS. Copy the URL exactly as the settings show it. The extension reacts to this event:

Other events are ignored.

Secret Hash: the webhook secret hash. It must match the value in your Flutterwave dashboard webhook settings. Flutterwave sends it with every webhook, and the same value is used for test and live mode. Webhooks without a valid secret hash are rejected. Without the webhook, a payment is confirmed only when the customer comes back to your store.

Payment

Payment Options: comma-separated payment methods to show on the Flutterwave page, for example card, banktransfer, ussd, mobilemoney. Leave empty for all methods enabled on your account. The list is cleaned up when you save (lower case, no duplicates).

Autocomplete Orders: paid orders get the Complete Order Status instead of the Paid Order Status. Default: off.

Orders

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

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

Complete Order Status: the status after a confirmed payment when Autocomplete Orders is on. Default: Complete.

Awaiting Payment Status: the customer came back while the payment is still pending at Flutterwave (bank transfer, USSD, mobile money). The order gets this status until the webhook confirms it. Default: Pending.

On Hold (Review) Status: payments whose amount or currency do not match the order, or that arrive after the order was cancelled, get this status and a note explaining 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.

Failed Status: a pending payment of an awaiting order failed at Flutterwave. Default: Failed.

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

Advanced

Debug log: logs Flutterwave API events for debugging to flwv_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 flwv_debug.old.log.php. Errors and warnings are always logged. Keys, the secret hash and customer data 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: removes the extension settings and logs when the extension is uninstalled. Payment data saved on orders is always kept. Default: off.

Import / Export

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

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

Checkout

At the Payment Method step the customer chooses the payment method (by default Flutterwave). At the Confirm Order step the customer sees your description and the note You will be redirected to the Flutterwave checkout page. OpenCart creates the order at this step, still without a status. 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. When the customer clicks Confirm Order, the extension creates a Flutterwave payment for the order total in the order currency, with the customer's e-mail, the phone and name of the payment address, your store name and logo and Payment for order with the order number, and sends the customer to the Flutterwave checkout page. A valid e-mail address is required. There the customer pays with one of the methods enabled on your account (or listed in Payment Options).

After paying, the customer returns to your store. The order is marked paid only after Flutterwave confirms it: by the webhook or by a server-side check when the customer returns. 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 payment is still pending, for example a bank transfer, USSD or mobile money payment, the order gets Awaiting Payment Status and the page also shows Your payment is being confirmed by Flutterwave. You will receive an e-mail as soon as it is confirmed. When Flutterwave confirms the payment, the order moves to the paid status and the customer is notified by e-mail. If the order was put on hold for review, for example because the paid amount does not match the order, the page shows Your payment was received and your order is being reviewed. We will contact you if anything is needed. If a pending payment later fails and the customer comes back to the order, the page shows Your Flutterwave payment was not completed. Please contact us about this order.

If Flutterwave cannot be reached when the customer comes back, a Payment confirmation page says Your payment is being confirmed by Flutterwave. Your order will be confirmed as soon as Flutterwave confirms it — please do not 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 is declined, the customer is back at checkout with Your payment was declined. You can try again or choose another payment method. If the customer cancels on the Flutterwave page, the message is Payment was cancelled. You can try again or choose another payment method. If the payment was not completed, the message is The payment was not completed. You can try again or choose another payment method. If the payment could not be verified, the message is Payment verification failed. Please contact support. The order stays without a status and the cart is kept, so the customer can pay 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, so a new attempt pays the same order. Every attempt gets its own reference. Before a new payment, the open and pending payments of this order and of other orders of the same cart from the last 24 hours are checked with Flutterwave. If one turns out to be paid, it confirms its order and the customer goes to the success page instead of paying again. If another order of the same cart has already been paid with Flutterwave, no new payment is started either. An older payment link that is paid later is still accepted. If the same cart is still paid twice, for example in two browser tabs, only the first payment gives its order a status: the other order stays without a status, and the paid order gets a note asking you to refund the second payment in the Flutterwave dashboard.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was closed without a payment meanwhile (for example its pending payment failed or you cancelled it), the customer is sent back to the checkout with the message about the declined payment, and the next Confirm Order pays a new order of the cart. If you closed the order after it was paid, the message is This order can no longer be paid (it was closed by the store). Please confirm your order again. If that order is already paid but the cart has changed since, including a new quantity, the message is Your previous order is already paid. Please confirm the order again: the cart will be paid with a new order. A paid order is never shown as paid for a different cart.

If Flutterwave cannot start the payment, the customer stays at the Confirm Order step with a short message, for example Flutterwave is temporarily unavailable. Please try again in a moment or choose another payment method. The technical reason is written to the log.

The webhook and the return URL also work while the store is in maintenance mode, because OpenCart 3 lets payment extension requests through and the extension adds a startup action for them on OpenCart 4.

The extension takes one-time payments only. It has no inline or modal checkout on your site, no saved cards, subscriptions, split payments or payment plans. Hosted payment links cannot be cancelled through the Flutterwave API, so an old link can still be paid.

Orders and refunds

Order statuses

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

Paid Order Status (default Processing) or Complete Order Status (default Complete): the payment was confirmed. Complete Order Status is used when Autocomplete Orders is on. A note shows the amount, the payment method, the Flutterwave reference, the transaction and the mode.

Awaiting Payment Status (default Pending): the customer came back while the payment was still pending at Flutterwave. The order moves to the paid status when Flutterwave confirms the payment.

On Hold (Review) Status (default Pending): the verified amount or currency did not match the order, or the payment arrived after the order had been given a status without payment, for example Canceled. The amount and currency actually paid are recorded, and the note explains it. Fulfil the order or refund the payment. If the order already had another processing status, only a note is added.

Failed Status (default Failed): Flutterwave reported the latest payment attempt of an awaiting order as failed or cancelled. The note shows the reason. Older attempts and paid orders are not changed.

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

If a second payment is received for an order that is already paid, the order is not changed. A note asks you to refund the duplicate in the Flutterwave dashboard.

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

VibeFox Flutterwave Payment tab

In Sales > Orders open an order paid with Flutterwave. At the bottom of the order page, next to History and Additional, the VibeFox Flutterwave Payment tab shows the Transaction reference, the Mode (Test or Live), the payment Status, the Transaction ID, the Flutterwave reference, the Payment type, the amounts Paid / refunded, the refund form, the refund history and the Flutterwave notes of the order. The tab is shown to users who have access to the extension.

Refunds

In the tab enter the Amount (the amount not refunded yet is filled in), optionally a Reason (optional), and click Refund via Flutterwave. Confirm the question Refund this amount through Flutterwave? 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 Flutterwave charged, so after an amount or currency mismatch you can refund up to what the customer actually paid, not the order total. The refund is sent with the secret key of the mode the payment was made in (test or live), so that key must be set. If Flutterwave rejects 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 refund ID and status (completed, or initiated with the status reported by Flutterwave). 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 Flutterwave has confirmed the payment.

Product returns in Sales > Returns do not send money back through Flutterwave. Refunds made in the Flutterwave dashboard are not synced back to OpenCart. Update the order status manually if needed.

License key

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

Flutterwave does not appear at checkout: check that the license is active, Enable/Disable is on and the secret key of the current mode is filled in and matches the mode: a test key (FLWSECK_TEST-…) in test mode, a live key (FLWSECK-…) in live mode. The settings page shows a warning otherwise. 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 Flutterwave dashboard check that the webhook URL is exactly the one shown in Webhook URL, in the mode you use (test or live), and that its secret hash is the same as Secret Hash in the extension. Pending bank transfers, USSD and mobile money stay pending until Flutterwave confirms them. The order also gets its status when the customer returns to the store after paying. Turn on Debug log and look at the Log field on the extension page.

Webhook answers Invalid hash or Secret hash not configured: the secret hash in the Flutterwave dashboard differs from the one in the extension, or the extension has none. Enter the same value in both places.

Webhook answers Verification failed, Busy, retry later or Order could not be updated, retry later: Flutterwave could not be reached to verify the payment, the transaction is not visible yet, the order was being processed by another request, or its status could not be set. Flutterwave retries the webhook. The log shows the reason.

The webhook URL shows Empty body in the browser: this is normal. The URL accepts only webhooks from Flutterwave.

The customer sees Payment gateway is not properly configured: the secret key of the current mode is missing or belongs to the other mode.

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 We could not match this payment to an order: the return link does not belong to a payment of this order. If the customer was charged, find the payment in the Flutterwave dashboard.

Flutterwave shows an error on its page, or the customer sees Flutterwave could not start the payment: your Flutterwave account may not support the order currency or the selected payment options.

Order is in the on hold status after payment: read the notes in the VibeFox Flutterwave Payment tab (see Order statuses), then fulfil the order or refund the payment.

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

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

Refund answers Another operation on this payment is running: another refund of the same order was being sent at that moment. Wait a moment, check the refund history and try again if needed.

For developers, the extension triggers the OpenCart events flwv_payment_request (data sent to Flutterwave) and flwv_currency_decimals (currency precision).

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox Flutterwave 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. The OpenCart event of the extension is removed too (on OpenCart 4 its events and its startup action, which lets the webhook and the return URL through in maintenance mode). If Delete data on uninstall is on, the other settings (title, description, mode, keys, secret hash, payment options, autocomplete, debug log switch) and the log are removed. If it is off, they are kept for a later re-install. The Flutterwave payment and refund records 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 Flutterwave Payment in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

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