VibeFox Windcave for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

PHP: 8.0 or later. The module refuses to install on older PHP versions.

Windcave account: you need a Windcave merchant account with REST API credentials: an API username and an API key. Windcave issues them separately for the UAT test environment (uat.windcave.com) and for production (sec.windcave.com). Ask Windcave support or your account manager for them. PxPay keys do not work with this module. The payment methods you want to offer (cards, wallets and others) must be enabled on your Windcave account.

Notification: your shop must be reachable from the internet, so that Windcave can send its payment notification. Nothing has to be set up at Windcave for it.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In the back office go to Modules > Module Manager and click Upload a module. Choose the module ZIP file.

2. When the upload finishes, click Configure, or find VibeFox Windcave Payment Gateway in the module list later and click Configure.

3. Paste your VibeFox license key into License key in the license block at the top of the Configure page and click Activate (see License key).

4. Enter your REST API username and key: the UAT credentials for test mode, the production credentials for live payments (see Configuration).

5. Choose the transaction type and the payment methods, turn on Enable/Disable and click Save. Make a test payment with Test mode on, then turn Test mode off to take real payments.

On install the module creates the order status Windcave payment on hold. PrestaShop offers a new payment module for all currencies, countries and customer groups. You can limit them in Payment > Preferences.

Configuration

All settings are on the module page: Modules > Module Manager > VibeFox Windcave Payment Gateway > Configure. Each section has its own Save button, which saves the whole page. While test mode is on, the page shows Test mode is on: payments go to the Windcave UAT environment and no real money is taken. If the module is enabled but the current mode has no API username or key, the page warns that the payment method is hidden at checkout, for example Windcave is enabled but the UAT API username / key are empty — the payment method is hidden at checkout. The Title cannot be empty: the page then shows Enter a title for the payment method. and nothing is saved.

Windcave

Enable/Disable: Enable Windcave 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: Credit/Debit Card (Windcave). Required.

Description: the text shown under the payment method at checkout. Default: You will be redirected to the secure Windcave payment page to complete your payment.

Windcave REST API

Enter the REST API credentials issued by Windcave (username and API key, not the PxPay keys). Production and UAT credentials can be saved side by side. Test mode uses only the UAT credentials, live mode only the production credentials. The section links to the Windcave REST API documentation.

Test mode: uses the Windcave UAT test environment (uat.windcave.com). No real money is taken. New payments use the UAT credentials. Refunds and captures always go to the environment in which the order was paid. Default: off.

Production API username: the REST API username for sec.windcave.com.

Production API key: the REST API key for sec.windcave.com.

UAT API username: the REST API username for uat.windcave.com (test mode).

UAT API key: the REST API key for uat.windcave.com (test mode).

Saved API 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.

Clear saved keys: tick Production API key or UAT API key and click Save to remove it. An empty field keeps the saved value.

Notification URL: shows the address to which Windcave sends its payment notification (Fail-Proof Result Notification). With friendly URLs it looks like https://your-shop/module/wcp_windcave_payment_gateway/notification. There is nothing to configure at Windcave: the module sends its return addresses and this notification address with every payment session. The address must be reachable from the internet, otherwise orders are confirmed only when the customer returns from Windcave. Neither the customer's return nor the notification is signed by Windcave, so the module never trusts them on their own: it always reads the result of the session from the Windcave REST API with the credentials of the environment the session was created in.

Payment

Transaction type: how the payment is taken. Default: Purchase.

Purchase (capture immediately): the money is taken when the customer pays.

Auth (authorise now, capture later): the money is only reserved. The order is put in Windcave payment on hold, and you take the money with Capture Windcave payment in the Windcave block of the order, or release it by refunding the full amount. Uncaptured authorisations expire after a few days.

Payment methods: the methods shown on the Windcave payment page: Cards, Account2Account (NZ bank transfer), Apple Pay, Google Pay, PayPal, Alipay, WeChat Pay, UnionPay, Interac, humm. Use Ctrl or Cmd and click to select several. The methods must be enabled on your Windcave account. Leave the field empty to show every method enabled on the account. Default: Cards.

Advanced

Debug log: logs API requests and payment events to logs/windcave_p_debug.log.php in the module folder. The file cannot be opened from the web. While this is off, only errors and warnings are logged. API keys, card data and customer personal data are never logged. Default: off.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Clean uninstall: deletes the module settings and logs when the module is uninstalled. Payment data saved with orders (Windcave transaction IDs needed for refunds) is always kept. Default: off.

The module version is shown at the bottom of the page.

Checkout

At the payment step the customer chooses the payment method (by default Credit/Debit Card (Windcave)) with its description. In test mode the customer also sees Test mode: payments go to the Windcave UAT environment, no real money is taken. After confirming, the module creates a Windcave payment session for the cart total in the cart currency and sends the customer to the Windcave Hosted Payment Page. The cart number is sent as the merchant reference, together with the shop language and the customer's name, e-mail, phone and billing address (and the delivery address when the cart needs shipping). No order exists yet at this point.

After paying, the customer returns to your shop. The order is marked paid only after Windcave confirms it: the module asks the Windcave REST API for the result of the session, both when the customer returns and when the Windcave notification arrives. A per-cart lock makes sure the payment is applied only once. The order is then created and the customer sees the standard order confirmation page with Your Windcave payment has been received. For an order on hold (an authorisation or a payment that does not match the cart) the page shows Your payment was received by Windcave. The shop will check it before processing your order — please do not pay again.

If the customer comes back from the approved payment but the result is not known yet, a Payment confirmation page shows We are waiting for Windcave to confirm your payment. You will receive an e-mail as soon as it is confirmed — please do not pay again. and a Check again button. The notification creates the order as soon as Windcave confirms the payment.

If the customer comes back without a completed payment, the checkout page shows one of these messages. The cart is kept.

Declined: Your payment was declined. Please try again or choose another payment method.

Cancelled or expired: The payment was not completed on the Windcave page. Your cart is saved — you can try again or choose another payment method.

Not confirmed yet: We could not confirm your payment yet. If you completed the payment, please do not pay again — you will receive a confirmation e-mail as soon as Windcave confirms it.

Return could not be processed: We could not process your return from the payment page. If you were charged, please contact us before paying again.

The customer can try again with the same cart. A new attempt first checks the previous session: if it is already paid, the order is created and no second payment is started; if the customer never used the payment page and the cart did not change, the customer is sent back to the same page. If the previous payment is being confirmed at that moment, the customer sees Your previous payment for this order is being confirmed right now. Please wait a minute and check your e-mail before trying again.

If Windcave cannot start the payment, the customer stays at checkout with a short message: that Windcave could not start the payment with the details of this order, or that the payment service is temporarily unavailable. The reason is written to the log. If the current mode has no credentials, the customer sees This payment method is not available at the moment. Please choose another payment method or contact us.

The notification works while the shop is in maintenance mode and is not blocked by the country restriction of your shop.

The module has no subscriptions or recurring payments, no saved cards, no embedded card form on your site (the customer always pays on the Windcave page), no support for the PxPay 2.0 API, and it does not add surcharges. If Windcave adds a surcharge, the order is matched against the main transaction.

Orders and refunds

Order statuses

No order yet: the customer was sent to Windcave and has not paid, Windcave has not confirmed the payment yet, or the payment was declined, cancelled or expired. Only the cart exists.

Payment accepted: a Purchase payment was confirmed and matches the cart. The payment is recorded with the Windcave transaction ID, and a note shows the amount, the transaction ID, the auth code, the card type with the masked card number and the environment (UAT or production).

Windcave payment on hold (authorised): an Auth payment was approved but not captured yet. No payment is recorded on the order until it is captured. The note explains how to capture or release it.

Windcave payment on hold (does not match): Windcave reported a different amount, currency, merchant reference or transaction type than the cart (for example, the cart was changed in another tab after the payment started). The note lists the differences. For a Purchase in the cart currency the payment is recorded with the amount Windcave actually charged. Check the payment in Windcave Payline before shipping, and refund it if necessary.

Refunded: the payment was fully refunded or the authorisation was released through the module.

If an approved payment arrives for a cancelled order, or a second approved payment arrives for an order that already exists, the order is not changed. A note with the transaction ID asks you to refund it in Windcave Payline (or restore the cancelled order manually).

Windcave payment block

The order page shows a Windcave payment block with the transaction ID, the session ID, the transaction type and status with the environment, the amount paid, the auth code and card, the capture or void transaction, the payment total and the amount refunded, a Test mode (UAT) badge for test payments, the refund history, all Windcave sessions of the cart and the Windcave notes of the order.

Capture (Auth mode)

For an order in Windcave payment on hold with an authorisation that has not been captured or released yet, the block shows Capture Windcave payment with the amount. Click it and confirm Capture the authorised amount through Windcave now? The authorised amount is captured (the order total, unless the payment did not match the order), the order moves to Payment accepted and the payment is recorded with the capture transaction ID. If Windcave does not accept the capture, the block shows Windcave capture failed: with the reason, the reason is added to the notes and the order stays on hold.

Refunds

In the Windcave payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via Windcave. Confirm the question Refund this amount through Windcave? This cannot be undone. Full and partial refunds are supported. You need the right to edit orders; access to the Modules pages is not needed. Refunds are counted against the amount and currency Windcave approved, so after a mismatch you can refund up to what the customer actually paid, not the order total. A refund after a capture goes to the capture transaction. The refund is sent to the environment (UAT or production) and the account in which the payment was made, so the credentials of that environment must be saved. A successful refund is added to the refund history and the notes with the Windcave transaction ID. A full refund sets the order to Refunded. A partial refund does not change the status.

For an Auth payment that has not been captured, the button is Release authorisation (void) and only the full amount can be released. A partial amount gives an error asking you to refund the full amount or capture the payment first.

If Windcave declines the refund, the block shows Windcave declined the refund: with the reason and no refund is recorded. If Windcave is still processing the refund, the block shows Windcave has not confirmed the refund yet. See the order notes. and the refund is not recorded. Check the transaction in Windcave Payline: if it was approved, record the refund manually; otherwise try again. A repeated attempt of the same refund is not sent to Windcave twice.

The module does not create credit slips. The standard PrestaShop refund buttons of the order page do not send money back through Windcave. Refunds made in Windcave Payline are not reported to the shop.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Windcave Payment Gateway is the first block on Modules > Module Manager > VibeFox Windcave Payment Gateway > Configure, 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 shop. Below them are the line Product: presta-payment-windcave and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only employees with the Configure permission for the module can change the key. The texts of the block follow the back office 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 shop address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the module keeps working on the last known status.

One key works on one domain: the domain of the main shop, also in a multistore setup. Removing the key from the shop does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Windcave 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. The PrestaShop storefront does not know that you are logged in to the back office, so the payment method is hidden for you too: you can set up the module before you buy a key, but not test it at checkout. A reminder appears in Modules > Module Manager on the Alerts tab. Existing orders are not affected: payments already started are still confirmed by the notification or when the customer returns, and captures and refunds work.

When a license expires, the module keeps working, but updates and support need a renewal. The status is checked again automatically while you work in the back office: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling or resetting the module always removes the license key and license status.

Troubleshooting

Windcave does not appear at checkout: check that the license is active, Enable/Disable is on and the current mode has both credentials: UAT API username and UAT API key in test mode, Production API username and Production API key in live mode. The settings page shows a warning when they are missing. In Payment > Preferences check that the module is allowed for the cart currency, the customer's country and the customer's group.

The payment went through, but no order was created: the module could not get the result from Windcave yet. Look at the Log field on the module page: errors are always logged, for example when the session could not be verified. Check that the credentials of the environment of the payment are saved and correct. The check is repeated when Windcave re-sends the notification (the module answers payment could not be verified yet, retry later with an error code, so Windcave retries), when the customer clicks Check again and when the customer starts a new payment for the same cart. Your server must accept requests from Windcave to the Notification URL shown in the settings.

The notification answers order not found: the session was not created by this shop, for example a session of another shop that uses the same Windcave account. It is ignored.

Authentication failed in the log: the REST API username or key is wrong, or it belongs to the other environment. UAT credentials work only in test mode, production credentials only in live mode. PxPay keys do not work.

The customer sees that Windcave could not start the payment with the details of this order: Windcave rejected the session request, for example because of the currency or a payment method that is not enabled on your account. The exact reason is in the log.

Order is Windcave payment on hold after payment: read the notes in the Windcave payment block. Either the payment is an Auth that waits for capture, or the paid amount, currency or merchant reference differed from the cart. Capture, fulfil or refund the payment.

Test payments and live payments: UAT and production are kept apart. Each session is checked in the environment it was created in, and refunds and captures go to the environment of the payment, even if you switch Test mode later.

Refund fails with a message about the environment: the payment was made in UAT or production, and no credentials for that environment are saved. Enter them and try again.

Capture Windcave payment is missing in the order block: the button is shown only for orders in Windcave payment on hold paid with Auth that have not been captured or released yet, and only to employees who may edit orders.

Where to find details: errors and warnings are always written to the log; turn on Debug log to log the API requests and payment events as well.

Uninstall

Go to Modules > Module Manager, open the menu next to VibeFox Windcave Payment Gateway and choose Uninstall. The license key and license status of this module are always removed. If Clean uninstall is on, the module settings and the log are removed. If it is off, all settings are kept for a later re-install. The Windcave sessions, transactions and refunds and the order status Windcave payment on hold are always kept, so orders paid before can still be refunded and captured after a re-install. Existing orders keep their payment notes and transaction IDs.

Windcave is a trademark of its respective owner. This module is not affiliated with or endorsed by Windcave.