VibeFox Worldline for WooCommerce — Help

Requirements

WordPress: 6.0 or later.

WooCommerce: 7.0 or later, installed and active. The plugin refuses to activate without it.

PHP: 8.0 or later.

Worldline account: a Worldline Direct (formerly Ingenico Direct) merchant account. Test and live accounts are separate and have different credentials. For each account you need the Merchant ID (your PSPID), an API Key ID with its Secret API Key, and a webhook key with its secret. All of them are created in the Worldline Merchant Portal (see Configuration).

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_worldline_gateway folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Payments > Worldline (Ingenico) > 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 test credentials, save the settings and click Test credentials.

6. Add the webhook URL in the Merchant Portal of the test account and enter the webhook key and secret (see Configuration).

7. Turn on Enable/Disable and make a test payment. Then enter the live credentials, repeat the webhook setup in your live account, click Live credentials and untick Test Mode.

Configuration

All settings are on one page: WooCommerce > Settings > Payments > Worldline (Ingenico). In the list of payment methods, Worldline is marked as needing setup until the current mode has a Merchant ID, an API Key ID and a Secret API Key. On the settings page, the credential fields of the mode that is not in use are dimmed.

General

Enable/Disable: Enable Worldline Gateway turns the payment method on or off. Default: off.

Title: the payment method name customers see at checkout. Default: Worldline.

Description: the text shown under the payment method at checkout. Default: Pay securely via Worldline.

Worldline Direct API

Get the credentials in the Worldline Merchant Portal of the test account and of the live account. Your PSPID is the Merchant ID. Developer > Payment API creates the API Key ID and the Secret API Key, Developer > Webhooks the webhook key and secret. The section has links to both portals and to the Worldline documentation.

Test Mode: Enable test mode (pre-production environment, no real money) switches both the API endpoint and the credentials. Test mode uses the pre-production environment and the test credentials, live mode the production environment and the live credentials. Default: on. Untick it to take real payments. While test mode is on, customers see Test mode — no real money is charged. under the payment method.

Test account (pre-production)

Test Merchant ID (PSPID): the PSPID of your test account.

Test API Key ID: the API Key ID created in Developer > Payment API of the test account.

Test Secret API Key: the Secret API Key that belongs to that API Key ID.

Test Webhook Key ID: optional. When set, only webhooks sent with this key are accepted.

Test Webhook Secret: the webhook secret of the test account. It is used to check the signature of every webhook.

Live account (production)

Live Merchant ID (PSPID): the PSPID of your live account.

Live API Key ID: the API Key ID created in Developer > Payment API of the live account.

Live Secret API Key: the Secret API Key that belongs to that API Key ID.

Live Webhook Key ID: optional. When set, only webhooks sent with this key are accepted.

Live Webhook Secret: the webhook secret of the live account.

Check credentials

The buttons Test credentials and Live credentials check the saved credentials of each account with a test call to Worldline. Save your changes first. The answer appears next to the buttons, for example Test credentials: connection successful., API credentials are not configured. or the error returned by Worldline.

Webhooks

The webhook tells your store about payments even when the customer does not come back to the store, for example after closing the browser or when a payment is confirmed later. In the Merchant Portal open Developer > Webhooks of the test account and add the endpoint URL shown in this section of the settings. It looks like https://your-site/wc-api/wlg_worldline_webhook/. Copy the URL exactly as the settings show it: it must answer without redirects, so check language prefixes and forced www or https redirects. Then enter the webhook key ID and secret in Test Webhook Key ID and Test Webhook Secret. Do the same in the live account with the live fields.

The plugin answers the endpoint verification request of Worldline automatically. It handles payment events (payment status changes) and refund events (refund status changes). Other events are accepted and ignored. Webhooks without a valid signature are rejected. A webhook is also ignored when it comes from another Merchant ID than the one of the account whose secret signed it. Without the webhook, an order is confirmed only when the customer comes back to the store after paying.

Payment page and orders

Payment page template: optional name of a hosted checkout template (variant) uploaded in the Merchant Portal, for example SimplifiedCustomPaymentPage. Leave it empty for the default Worldline page.

Order Status After Payment: the order status once Worldline confirms the captured payment. The status is set at once, without a second status change. Payments are always requested as a direct sale (authorization and capture).

Processing: the WooCommerce default (default). Orders with only virtual downloadable products become Completed.

Completed: every paid order becomes Completed.

Logging: Enable debug logging writes all API requests and webhooks to WooCommerce > Status > Logs, source wcp_worldline_gateway. Errors and warnings are always logged, also when this is off. Keys, card data and personal data are masked. Default: off.

Delete Data: Delete the plugin settings and logs when the plugin is deleted. Deactivating the plugin never deletes anything. Payment data stored on orders is kept, because it is needed for refunds. Default: off.

When you update from version 1.0, the old single set of credentials is moved to the test or live fields, depending on the mode the store was using.

Checkout

The customer chooses the payment method (by default Worldline) and places the order. The plugin creates a Worldline hosted checkout for the order total in the order currency and sends the customer to the Worldline payment page. There the customer pays with a card, a wallet or another payment method enabled in your Worldline account. The billing name, address, e-mail and phone are passed to Worldline, and the payment page opens in the language of your store when Worldline supports it. Each payment attempt gets its own reference made of the order ID and a random part.

After paying, the customer returns to your store. The plugin checks the return against the stored attempt and reads the payment status from Worldline on the server. The order is marked paid only after Worldline confirms it: by this status check or by a signed webhook. Then the customer sees the order received page.

If the payment was not completed, the customer is taken to the Pay for order page with a message:

Cancelled or left the payment page: The payment was not completed on the Worldline page. Your order is saved — you can try again or choose another payment method.

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

Status could not be checked: We could not confirm your payment yet. If you completed the payment, please do not pay again — you will receive a confirmation as soon as Worldline confirms it.

A customer can pay an unpaid order again from the Pay for order page. If the previous attempt has been paid in the meantime, the customer goes straight to the order received page and is not charged twice. If the previous payment page is still open for the same amount and mode and was created less than 30 minutes ago, the customer is sent back to it.

If Worldline cannot start the payment, the customer sees Payment error: Could not create checkout session. Please try again. and can choose another payment method. The reason is added to the order notes and the log. If the credentials of the current mode are missing, the customer sees This payment method is not available at the moment. Please choose another payment method.

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 plugin takes one-time payments as a direct sale on the Worldline page. It has no saved cards or tokenization, no subscriptions, no embedded card form, no authorize-only mode with capture or cancel from WooCommerce, no surcharging and no automatic webhook registration.

Orders and refunds

Order statuses

Pending payment: the customer was sent to Worldline and has not paid yet, or Worldline has not confirmed the payment yet. A note shows the hosted checkout ID, the reference and the mode (test or live).

Processing or Completed: the payment was captured. The status follows Order Status After Payment. The order note shows the amount, the Worldline payment ID and how it was confirmed (signed webhook or status check). The transaction ID of the order is the Worldline payment ID.

On hold, waiting for capture: Worldline reports the payment as authorized or the capture as requested, but not yet captured. The order note explains it. The order is marked paid automatically when the webhook confirms the capture. If the note says the payment is not captured, capture it in the Worldline Merchant Portal.

On hold, held for manual review: the payment does not match the order, for example the amount or currency differ (the order was edited after the payment started) or the payment belongs to another attempt. The note shows the paid amount, the order total and the reference. Check the order and fulfil it or refund the payment.

Failed: Worldline rejected or cancelled the payment of the latest attempt, or the customer was not eligible for the selected payment method.

Cancelled: the order was cancelled by you or by the WooCommerce stock hold timeout. If a payment arrives for a cancelled or refunded order, the order is not reopened. A note asks you to refund or cancel the payment in the Worldline Merchant Portal or to restore the order manually. The returning customer sees Your payment was received after this order had been cancelled. Please contact us — we will restore the order or refund the payment.

If a second payment arrives for an order that is already paid, the order is not changed again. A note asks you to refund the second payment in the Worldline Merchant Portal.

Refunds

Open the order, click Refund, enter the amount and click Refund via Worldline (Ingenico). Full and partial refunds are supported. The payment must be captured. The refund is always sent to the environment of the original payment (test or live) with that account's credentials, so they must be set. A refund retried after a timeout is not executed twice. If Worldline refuses the refund, WooCommerce shows the error and no refund is recorded. An accepted refund is added to the order notes with the Worldline refund ID and status.

Refund status changes from Worldline arrive by webhook and are added to the order notes. Refunds made in the Merchant Portal are not recorded as WooCommerce refunds automatically. If needed, create a manual refund in WooCommerce without Refund via Worldline (Ingenico).

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Payments > Worldline (Ingenico). 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, Worldline 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

Worldline does not appear at checkout: check that the license is active, Enable/Disable is on and the current mode has a Merchant ID, an API Key ID and a Secret API Key: the test fields in test mode, the live fields in live mode. The payments list marks the method as needing setup when they are missing.

The payment went through, but the order stays Pending payment: the webhook is not working. In the Merchant Portal of the account you use (test or live) check that the endpoint exists and that its URL is exactly the one shown in the settings, without redirects. Check that the webhook secret of that account is in the matching field (Test Webhook Secret or Live Webhook Secret) and that Webhook Key ID is empty or matches the key. The order is also confirmed when the customer returns to the store after paying.

Webhook answers Webhook secret not configured: neither webhook secret is set. Enter the webhook secret in the settings. Worldline retries the webhook.

Webhook answers Invalid signature: the webhook secret belongs to another account or another key, or the Webhook Key ID does not match the key that sent the webhook.

Webhook answers Missing signature, Empty body or Invalid JSON: the request did not come from Worldline in the expected form, or a proxy or redirect changed it. Check that the URL answers without redirects.

Webhook answers Ignored: the webhook came from another Merchant ID than the one in the settings of that mode. Check Test Merchant ID (PSPID) or Live Merchant ID (PSPID).

Webhook answers Retry later: the order was being updated by another request at the same moment. Worldline retries the webhook.

Test credentials or Live credentials shows an error: save the settings first, then check that the Merchant ID, API Key ID and Secret API Key come from the same account and that the test values are in the test fields and the live values in the live fields.

The customer sees an error when placing the order: open the order notes or WooCommerce > Status > Logs, source wcp_worldline_gateway. Errors are logged even when debug logging is off. For full details of the requests, turn on Logging and try again.

Test payments do not confirm a live order: test and live are kept apart. A webhook signed with the test secret never confirms a live payment attempt and the other way round. Switch Test Mode to the mode you want and use that account's credentials and webhook.

Order is On hold after payment: read the order note. Either Worldline has not confirmed the capture yet (the webhook completes the order), or the paid amount or currency differed from the order.

Refund fails with a message about the environment: the payment was made in the test or live environment, and the credentials of that environment are not set. Enter them and try again.

Developers: the filter wlg_hosted_checkout_data changes the hosted checkout request, for example to limit the payment methods shown, and wlg_gateway_icon changes the payment method icon.

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.

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 was on. Otherwise they stay for a later re-install. The Worldline payment data stored on orders is always kept, because it is needed for refunds. Existing orders keep their payment notes and transaction IDs.

Worldline is a trademark of its respective owner. This plugin is not affiliated with or endorsed by Worldline.