VibeFox Worldline for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

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 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 Worldline 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 the test credentials, click Save and then Test credentials.

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

6. 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 turn off Test Mode.

On install the module creates two order statuses, Awaiting Worldline capture and Worldline payment on hold. PrestaShop enables a new payment module for the countries active at that moment. Check currencies, countries and customer groups in Payment > Preferences, and tick countries you add later there.

Configuration

All settings are on the module page: Modules > Module Manager > VibeFox Worldline Gateway > Configure. Each section has its own Save button, which saves the whole page. Above the fields the page warns you when the credentials of the current mode (Merchant ID, API Key ID, Secret API Key) are incomplete, because the payment method is then hidden at checkout. While test mode is on it shows Test mode is on (pre-production environment): no real money is charged.

Worldline (Ingenico)

Enable/Disable: Enable Worldline Gateway 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: Worldline. Required.

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: 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. Turn it off 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.

Saved secret keys and webhook secrets 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 secrets: tick a secret and click Save to remove it. An empty field keeps the saved value.

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 at the top of the page, for example Test credentials: connection successful., API credentials are not configured. or the error returned by Worldline.

Webhooks

The webhook tells your shop about payments even when the customer does not come back to the shop, 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 URL shown in Endpoint URL in this section. With friendly URLs it looks like https://your-shop/module/wcp_worldline_gateway/webhook, possibly with a language code such as /en/. Copy the URL exactly as the settings show it: it must answer without 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 module 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. An event must be signed with the secret of the account the payment was made in, so a test webhook never confirms a live payment. 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 created only when the customer comes back to the shop 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. Payments are always requested as a direct sale (authorization and capture).

Authorized payments wait in Awaiting Worldline capture. Amount or currency mismatches always go to Worldline payment on hold.

Advanced

Logging: writes all API requests and webhooks to logs/wlg_debug.log.php in the module folder. The file cannot be opened from the web. Errors and warnings are always logged, also when this is off. Keys, card data and personal data are masked. Default: off.

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

Delete Data: when on, uninstalling the module removes the module settings and the log. The Worldline transactions and refunds and the module's order statuses always stay, because existing orders need them for refunds. Default: off.

Checkout

At the payment step the customer chooses the payment method (by default Worldline) and confirms. The module creates a Worldline hosted checkout for the cart total in the cart 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 customer's language when Worldline supports it. Each payment attempt gets its own reference made of the cart ID and a random part. No order exists yet at this point.

After paying, the customer returns to your shop. The module 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. The order is then created and the customer sees the standard order confirmation page with Your payment with Worldline has been received. If the payment is authorized but not captured yet, the page shows Your payment is authorized. The order is confirmed as soon as Worldline confirms the capture. If the payment of such an order later fails, the page shows Your Worldline payment was not completed. Please contact us about this order.

If the payment was not completed, no order is created, the cart is kept and the customer is back at checkout with a message:

If the status could not be checked yet, a Payment confirmation page shows 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. with the buttons Check again and Back to checkout. The webhook creates the order as soon as it arrives.

When the customer pays the same cart again, the module first checks the previous attempt. If it has been paid in the meantime, the customer goes straight to the order confirmation 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 stays at checkout with Payment error: Could not create checkout session. Please try again. The reason is written to 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 webhook works while the shop is in maintenance mode and is not blocked by the country restriction of your shop.

The module 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 PrestaShop, no surcharging and no automatic webhook registration.

Orders and refunds

Order statuses

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

Payment accepted or Delivered: the payment was captured. The status follows Order Status After Payment. The payment is recorded with the Worldline payment ID as the transaction ID, and a note shows the amount, the payment ID and how it was confirmed (signed webhook or status check).

Awaiting Worldline capture: Worldline reports the payment as authorized or the capture as requested, but not yet captured. No payment is recorded yet. The order moves to the paid status when the webhook confirms the capture. If the note says the payment is not captured, capture it in the Worldline Merchant Portal.

Worldline payment on hold: the payment does not match the cart, for example the amount or currency differ (the cart was changed 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.

Payment error: Worldline rejected or cancelled the payment of an order that was waiting for the capture.

Refunded: the payment was fully refunded through the module.

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. A note asks you to refund the second payment in the Worldline Merchant Portal.

Worldline payment block

The order page shows a Worldline payment block with the payment ID, the merchant reference, the hosted checkout, the attempt status, the amount charged and the amount refunded, a Test environment badge for test payments, the refund history and the Payment notes of the order.

Refunds

In the Worldline payment block enter the amount (the amount not refunded yet is filled in), optionally a reason, and click Refund via Worldline. Confirm the question Refund this amount through Worldline? This cannot be undone. Full and partial refunds are supported. The payment must be captured. You need the right to edit orders; access to the Modules pages is not needed. Refunds are made in the amount and currency Worldline 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 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, and only one refund of an order runs at a time. If Worldline refuses the refund, the block shows the error and no refund is recorded. An accepted refund is added to the refund history and the notes with the Worldline refund ID and status. A full refund sets the order to Refunded. A partial refund does not change the status.

The module does not create credit slips. The standard PrestaShop refund buttons of the order page do not send money back through Worldline.

Refund status changes from Worldline arrive by webhook, update the refund history and are added to the notes. Refunds made in the Merchant Portal do not change the order status or create credit slips. Update them manually if needed.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Worldline Gateway is the first block on Modules > Module Manager > VibeFox Worldline 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-worldline 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, 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. 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, 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

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 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 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 Endpoint URL, without redirects. Check that the webhook secret of that account is in the matching field (Test Webhook Secret or Live Webhook Secret) and that the webhook key ID field is empty or matches the key. The order is also created when the customer returns to the shop 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. Check that the test and live secrets are not swapped.

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 confirmed by another request at the same moment, or the order could not be created (for example, the module is disabled). Worldline retries the webhook. Look at the Log field for the reason.

The webhook URL shows Method not allowed in the browser: this is normal. The URL accepts only requests from Worldline.

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 choosing Worldline: look at the Log field on the module page. Errors are logged even when Logging is off. For full details of the requests, turn on Logging and try again.

Test payments do not confirm a live payment: test and live are kept apart. Switch Test Mode to the mode you want and use that account's credentials and webhook.

Order is Worldline payment on hold or Awaiting Worldline capture after payment: read the notes in the Worldline payment block (see Order statuses). Either Worldline has not confirmed the capture yet (the webhook completes the order), or the paid amount or currency differed from the cart.

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 hook actionWlgHostedCheckoutData changes the hosted checkout request before it is sent, for example to limit the payment methods shown.

Uninstall

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

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