VibeFox Flow for WooCommerce — Help
Requirements
WordPress: 6.0 or later.
WooCommerce: 8.0 or later, installed and active.
PHP: 8.0 or later.
Store currency: Chilean peso (CLP) or US dollar (USD). For other currencies the payment method is hidden at checkout. For CLP stores set WooCommerce > Settings > General > Number of decimals to 0, because Flow charges whole pesos.
Flow account: you need the API Key and Secret Key of your Flow account, in Flow under Mis datos, Datos técnicos. For tests, create a separate sandbox account at sandbox.flow.cl and use its keys. Sandbox and live keys are different. Nothing needs to be configured in the Flow account.
Public website: the confirmation, return and refund URLs of your store must be reachable from the internet, without maintenance mode, password protection or a firewall blocking Flow.
VibeFox license key: bought on vibefox.net. One key works on one domain.
Installation
1. In WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the wcp_flow_gateway folder to /wp-content/plugins/ by FTP.
2. Click Activate.
3. Open the settings: WooCommerce > Settings > Payments > Flow.cl > Manage, or click Settings under the plugin name on the Plugins page.
4. Enter your VibeFox license key in the license block at the top of the page and click Activate.
5. Enter the sandbox API Key and Secret Key, turn on Enable / Disable, save and place a test order.
6. To accept real payments, fill in the live keys and untick Sandbox mode.
Configuration
All settings are on one page: WooCommerce > Settings > Payments > Flow.cl. Above the fields the page warns you when the keys of the current mode are empty (Flow is then hidden at checkout), when the store currency is not supported, and when a CLP store uses decimals (Flow charges whole pesos, so set Number of decimals to 0 for prices, totals and refunds to match exactly). In sandbox mode it shows Sandbox mode — payments go to sandbox.flow.cl, no real money is charged. In the list of payment methods, Flow is marked as needing setup until the current mode has keys, and shows a test mode badge in sandbox mode.
General
Enable / Disable: Enable Flow.cl payments turns the payment method on or off. Default: off.
Title: the payment method name the customer sees at checkout. Default: Flow.
Description: the text shown under the payment method at checkout. Default: Pay with Webpay, credit or debit card, bank transfer and other methods. You will be redirected to Flow to complete the payment.
Flow API credentials
Copy the API Key and Secret Key from your Flow account (Mis datos, Datos técnicos): live keys at www.flow.cl, sandbox keys at sandbox.flow.cl (a separate sandbox account).
Sandbox mode: Use the Flow sandbox (sandbox.flow.cl) and the sandbox keys. No real money is charged in sandbox mode. Default: on. Turn it off and fill in the live keys to accept real payments. Refunds always use the environment the order was paid in.
Sandbox API Key: the API Key of your sandbox.flow.cl account.
Sandbox Secret Key: the Secret Key of your sandbox.flow.cl account. It is used to sign every request.
Live API Key: the API Key of your www.flow.cl account.
Live Secret Key: the Secret Key of your www.flow.cl account. Keep it private.
Notifications
The plugin sends three URLs to Flow with every payment and refund, so nothing has to be configured in the Flow account. The section lists them:
The confirmation carries only a payment token. The plugin then asks Flow for the payment status with a signed request in the environment the payment was created in, and applies only Flow's answer. A payment that this store did not create for the order is rejected. Without the confirmation, the order is updated when the customer returns from Flow.
Advanced
Debug log: Log API calls and notifications to WooCommerce > Status > Logs, source wcp_flow_gateway, without keys or customer data. Errors are always logged. Default: off.
Delete data on uninstall: Remove the settings and logs of this plugin when it is deleted (Flow data saved on orders is kept). Default: off.
Checkout
The customer chooses the payment method (by default Flow) and places the order. In sandbox mode the checkout shows SANDBOX MODE — Payments go to the Flow sandbox. No real charges. A valid billing e-mail is required. The plugin creates a Flow payment for the order total in the order currency, with the subject Order # plus the order number and the site name, and sends the customer to the Flow payment page. There the customer chooses a payment method enabled in your Flow account.
After paying, the customer returns to your store. The order is marked paid only after Flow confirms it: by the confirmation or by a signed status request when the customer returns. A paid order, or a cash coupon that is waiting for payment, leads to the order received page.
If the payment was rejected, the customer goes back to the Pay for order page (or the checkout) with Your Flow payment was rejected. Please try again or choose another payment method. If the customer left the Flow page without paying, the message is The Flow payment was not completed. You can try again or choose another payment method. If the result could not be checked, the message is We could not confirm your Flow payment yet. If you completed it, you will receive a confirmation e-mail shortly; otherwise please try again. Every new attempt creates a new Flow payment bound to the order.
If Flow cannot start the payment, the customer sees a short message, for example Could not connect to Flow. Please try again in a moment. The details are in the log.
The payment method works on the classic checkout, on the Checkout block and on the Pay for order page. It is compatible with WooCommerce High-Performance Order Storage (HPOS). The customer-facing texts are translated into Spanish (Chile and Spain).
The plugin takes one-time payments only. It has no saved cards, subscriptions, recurring charges or payment links and does not preselect a Flow payment method. Flow cannot cancel an already created payment link: if a customer pays an old link after paying a newer one, the order gets a note asking you to refund the duplicate in Flow.
Orders and refunds
Order statuses
Pending payment: the customer was sent to Flow and has not paid yet. The order note shows the amount and the Flow order number of the attempt.
On hold, awaiting coupon payment: the customer generated a Servipag or Multicaja payment coupon. The order changes when Flow confirms the payment.
Processing: Flow reported the payment as paid and the amount and currency match (orders with only virtual downloadable products become Completed, the WooCommerce default). The order note shows the amount and the Flow order number. The transaction ID of the order is the Flow order number.
On hold, amount/currency mismatch: Flow reported a different amount or currency than the order. The order was not marked paid; verify it manually.
On hold, payment for a cancelled order: a payment arrived for an order that had been cancelled without being paid. Check the order and ship it or refund the payment in Flow.
Failed: Flow rejected the latest payment attempt of an unpaid order. The customer can try again.
Cancelled: the latest payment attempt was annulled in Flow.
If another payment arrives for an order that is already paid, the order is not changed. A note asks you to refund the duplicate in your Flow account. A paid-then-cancelled or refunded order is never reopened.
Refunds
Open the order, click Refund, enter the amount and click Refund via Flow. Full and partial refunds are supported. The refund is sent to the environment the order was paid in (sandbox or live), so that environment's keys must be set, and the order needs a billing e-mail. Flow e-mails the customer to complete the refund. If Flow refuses the refund, WooCommerce shows the error and no refund is recorded. A successful request is added to the order notes with the Flow refund number and status.
Later status changes of the refund reported by Flow are added to the order notes. If Flow rejects or cancels a refund afterwards, the note says that the money was not returned to the customer; the WooCommerce refund record is kept, so handle it manually. Refunds created in the Flow dashboard are not imported into WooCommerce.
License key
The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Payments > Flow.cl. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.
One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.
Without an active key, Flow 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. Logged-in store managers still see the payment method, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected: payments already started are still confirmed, and refunds work.
When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.
Troubleshooting
Flow does not appear at checkout: check that the license is active, Enable / Disable is on, the keys of the current mode are filled in (sandbox keys in sandbox mode, live keys in live mode) and the store currency is CLP or USD. On the Pay for order page the order currency is checked.
The payment went through, but the order stays Pending payment: the Flow confirmation does not reach your store and the customer did not return. Check that the confirmation URL shown in the settings opens from the internet and is not blocked by maintenance mode, password protection or a firewall. Turn on Debug log and look at WooCommerce > Status > Logs, source wcp_flow_gateway.
Confirmation answers Payment does not belong to the order or Unknown order: the payment was not created by this store for this order, or in another environment. The order is not changed.
Confirmation answers Gateway not configured: the keys of the environment of the payment are empty. Enter them again.
Confirmation answers Flow API unavailable: the status request to Flow failed. Flow retries the confirmation.
The customer sees Flow payments are not available at the moment: the keys are missing or Flow refused them. Check the API Key and Secret Key of the current mode.
The customer sees A valid billing email is required for Flow payments: Flow needs the customer's e-mail.
The customer paid, but the order is On hold: read the order note. The customer generated a cash coupon that is not paid yet, or the amount or currency reported by Flow does not match the order. CLP totals with decimals are rounded to whole pesos, so set Number of decimals to 0.
Refund fails with a message about the sandbox or live keys: the order was paid in that environment, and its keys are empty. Enter them and try again.
The license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.
For developers, the readme lists the filter wc_flw_supported_currencies (currencies the gateway is offered for).
Uninstall
Deactivating the plugin keeps all data. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin are always removed. The gateway settings and the logs are removed only if Delete data on uninstall was on. Otherwise they stay for a later re-install. Flow data saved on orders is always kept. Existing orders keep their payment notes and transaction IDs.
Flow is a trademark of its respective owner. This plugin is not affiliated with or endorsed by Flow.