Configuration

This page details the configuration of Worldline's Magento extension. If you need any further support, please contact us, we're happy to help.

Step 1 In the Magento root directory execute php bin/magento module:enable Worldline_Connect

Step 2 In the Magento root directory execute php bin/magento setup:upgrade

Step 3 Open Magento Admin → Stores → Configuration → Sales → Payment Methods → Other Payment Methods → Worldline

Step 4 Configuration

Step 5 Save Config

Step 6 In the Magento root directory execute php bin/magento cache:clean

General Settings

Field	Setting details	Mandatory / Optional / Recommended	Comments
Magento webhook endpoint	Configure the Webhooks URL in the Worldline Configuration Center.	Recommended to use Webhooks for timely status updates	Enable all checkboxes for "payment" and "refund".
Email for manual review		Recommended for transactions that require review/approval
Limit API field length	Yes	Recommended to switch this setting on
Log client side API communication	Yes	Recommended to switch this setting on	If you enable logging, you should clear or rotate the log files regularly.
Log all server side webhooks and API communication	Yes	Recommended to switch this setting on	If you enable logging, you should clear or rotate the log files regularly.
Soft descriptor	Your preferred descriptor per store	Optional	Please note that this service needs to be enabled on Worldline side as well.
Active environment	The environment you’re using for testing/processing	Mandatory

Sandbox/Pre-Production/Production settings

You can find this information in the applicable Worldline environment's Configuration Center (Sandbox, Pre-Production, Production). After adding the fields you can test the connection to verify the setup is correct.

Field	Setting details	Mandatory / Optional / Recommended
Merchant ID (MID)	Your Worldline merchant ID from the Configuration Center “Merchant IDs”	Mandatory
API key ID	Your Worldline API key ID from the Configuration Center “API keys”	Mandatory
API secret	Your Worldline Secret API Key from the Configuration Center “API keys”	Mandatory
Webhooks key ID	Your Worldline Webhooks Key ID from the Configuration Center “Webhooks keys”	Recommended to use Webhooks for timely status updates
Webhooks secret key	Your Worldline Webhooks secret key from the Configuration Center “Webhooks keys”	Recommended to use Webhooks for timely status updates

Payments Product settings

Field	Setting details	Mandatory / Optional / Recommended	Comments
Enabled	Yes	Mandatory
Sort Order	Priority of the product	Optional	Priority of the product. If not changed, the default setup will apply.
Allowed Countries	Select which countries are allowed for this payment product	Optional	If not changed, the default setup will apply.
Minimum Order Total		Optional	If not changed, no limitation will apply.
Maximum Order Total		Optional	If not changed, no limitation will apply.
Payment Action	Direct Capture: payments are automatically captured and reported as paid as soon as the capture is complete on the gateway. An invoice is created automatically. Delayed Settlement: you have to manually capture payments by accepting the payment on the order details page.	Mandatory	Only applicable for cards. In case of delayed capture, manual approval is needed. See more information below.
Payment flow type	Hosted: redirect customers to Worldline’s payment pages Inline: use your payment pages	Mandatory	See more information below.

Payment action

To configure what to do when a new payment is created. Here you have two options:

On setting Direct Capture, payments will automatically be captured and will be reported as paid as soon as the capture is complete on the gateway. An invoice is created automatically
With Delayed Settlement you will have to manually capture new payments by creating an invoice from the order details page.

Payment flow type

The payment flow type is used to configure how payment information is going to be captured by the customer.

If you choose inline payments the payment data (e.g. credit card information) is requested directly in your checkout and encrypted via the Connect JavaScript SDK. The encrypted data is then sent to your shop and forwarded to the Connect platform through the Connect Server SDK. Not all payment methods support payment data capture through this way - for those who don't the MyCheckout hosted payment pages are being used.

Should you choose hosted payments, the customer will be redirected to the MyCheckout hosted payment pages for all available payment products after completing the Magento® checkout.

Hosted Payment Pages

Select this option if you would like to process all payment products via Worldline’s MyCheckout hosted payment pages . This allows you to process additional Worldline payment products not yet integrated in the module. You can rename the product in Title.

Vault

Please note that tokenization needs to be enabled on your Worldline account in order to make it work. You will see the Webhooks messages coming in under Sales → Events

The capture mode of Vault follows the setup of the underlying card, but we suggest to have the same setup for Cards and Vault.