OpenCart

Introduction

Our OpenCart plug-in comes with regular updates and full integration support, offering a versatile out-of-the-box solution to accept online payments easily:

• Supports Hosted Checkout Page integration method

• Offers the following payment methods on our platform:
  Alipay+
  American Express
  Bancontact
  Bizum
  Cartes Bancaires
  Diners Club
  iDEAL
  Intersolve
  JCB
  Klarna
  Google Pay
  Maestro
  MasterCard
  Oney 3x-4x
  PayPal
  Visa
  WeChatPay

Keep an eye on our Release Notes to stay informed about updates and new features (i.e. payment methods, features, integration methods) we have added to this plugin!

Check out our documentation to learn how to link your store with our platform to profit from all these features!

Download from GitHub repository Download from Marketplace repository

Account Creation

To process transactions with this plugin, you need an account on our platform.

This plugin works with both our test and live environment. A test account is a great way to get familiar with both the plugin and our platform. Once you want to go live, create a production account or contact us!

Installation

The first step to use the plugin is the installation process. Before you proceed, make sure your infrastructure meets these system requirements:

Item	Description
Plugin package	Download the plugin
Direct credentials	Active test/live account on our platform API key/secret Webhooks
OpenCart	See "Compatibility" on the Marketplace repository
PCI compliancy	SAQ A The plugin’s in-built features ensure this security level, but you still need to get the certificate from your acquirer

Once done, follow these steps:

1. Login to the OpenCart Back Office. Go to Extensions > Installer.
2. Click on the “Upload” button to add the file.
3. In the "Payments" table, look for "Worldline" and click on the "Install" button in the column "Action".

Configuration

After the installation, you need to configure the plugin to link your store to our platform.

Configure basic settings

1. Login to the OpenCart Back Office. Go to Extensions > Extensions. Select "Payments" from the dropdown list "Choose the extension type".
2. The plugin will load a list matching the "Payments" extension type. In the "Payments" table, look for "Worldline" and click on the "Edit" button in the "Action" column.
3. Go to the "Account settings" tab to configure the following settings:

   Property	Description
   Status	Enable/Disable the plugin.
   Environment	Select "Test"/"Live" to link your shop to the respective environment and to configure the respective test/live credentials. Depending on your selection, the shop module will send the transaction requests to the test or production environment.
   (Test) Merchant ID (PSPID)	Enter your test/live PSPID from our platform that you want to use for transaction processing
   (Test) API Key	Enter the API Key of your test/live PSPID. Read our dedicated guide to learn how to generate one.
   (Test) API Secret	Enter the API Secret of your test/live PSPID. Read our dedicated guide to learn how to generate one.
   (Test) API Endpoint	Prefilled by default, but can be changed at will.
   (Test) Webhooks Key	Enter the webhooks Key of your test/live PSPID from the Merchant Portal as described in our dedicated guide.
   (Test) Webhooks Secret	Enter the webhooks Secret of your test/live PSPID from the Merchant Portal as described in our dedicated guide.
   Webhooks URL	Copy this URL to the Merchant Portal as described in our dedicated guide. Beware that the plugin provides only one value for both the test/live environment.
   Cron URL	Set up a cron job to make sure the plugin synchronises the transaction status with our platform. This is a fallback mechanism if the plugin does not retrieve the status correctly once a transaction is finalised. Beware that the plugin provides only one value for both the test/live environment.

4. Click on "Save" to confirm your settings and validate your settings by establishing a test connection between the plugin and our platform. Check that the screen displays "Success: You have modified Worldline!". If the text does not appear, contact your system administrator for troubleshooting to check: 
   a. You are using the correct credentials.
   b. Whether your PSPID is active.
   c. You send the request to the correct PSPID/environment (Test vs Production)

Configure advanced settings

1. Login to the OpenCart Back Office. Go to Extensions > Extensions. Select "Payments" from the dropdown list "Choose the extension type".
2. The plugin will load a list matching the "Payments" extension type. In the "Payments" table, look for "Worldline" and click on the "Edit" button in the "Action" column.
3. Go to the "Advances settings" tab to configure the following settings:

   Property	Description
   Payment Title	Customise the radio button text on your webshop checkout page in the "Payment Method" step for the payment methods processed via the Hosted Checkout Page
   Payment Button Title	Customise the radio button text button in the "Payment Method" step on your webshop checkout page.
   Authorization Mode	Define whether to process the transactions in authorisation mode or as direct sale. Select one of the following options: Pre Authorization: The amount is only blocked (=authorised) on your customer's card for 30 days. Within this time frame, you can reverse the authorisation. Successful transactions will have status="PENDING_CAPTURE" / statusOutput.statusCategory="PENDING_MERCHANT" / statusOutput.statusCode=5. Use this mode when you wish to capture a transaction only after shipping the order. In the OpenCart module, the status will be "pending_capture". Final Authorization: The amount is only blocked (=authorised) on your customer's card for 7 days. You cannot reverse this authorisation. Successful transactions will have status="PENDING_CAPTURE" / statusOutput.statusCategory="PENDING_MERCHANT" / statusOutput.statusCode=5. Use this mode when you wish to capture a transaction only after shipping the order. In the OpenCart module, the status will be "pending_capture". Sale: The amount is blocked and paid out (=captured) in one go. Successful transactions will have status="CAPTURED" / statusOutput.statusCategory="PENDING_MERCHANT" / statusOutput.statusCode=9. In the OpenCart module, the status will be "captured". Make sure that you capture authorised transaction later. Only then will the transaction have statusOutput.statusCode=9/status "captured" in the module.
   Group Cards	Group all cards payment methods under one single button on the Hosted Checkout Page.
   Forced Tokenization	Define whether to store your customers' card data for future recurring payments: "Enabled": Create a token for every successful card transaction. "Disabled": Do not store the card data. We strongly recommend selecting "Disabled" for raising the chance of higher conversion rates.
   3DS Status	(De)activate the 3-D Secure check. We strongly recommend selecting "Enabled" as 3-D Secure is mandatory in some markets. This will also ensure liability shift for transactions with successful 3-D Secure authentication. If you select "Disabled" and choose to process non 3-D Secure transactions, you may not benefit from liability shift and may be held liable.
   3DS Challenge Indicator	Define whether to conceal or skip 3-D Secure authentication whenever possible by default: No Preference: No preference for the frictionless/challenge flow. No Challenge Requested: Preference for the frictionless flow. Challenge Requested: Preference for the challenge flow. Challenge Required: You insist on the challenge flow.
   3DS Exemption Request	Some markets allow you to potentially exempt your customers from a 3-D Secure check: No exemption flagging: You pass on any possible exemption. Transaction is of low risk: You can request an exemption for transactions you consider low risk. As the acquirer is liable, it decides to grant/reject an exemptions based on the overall portfolio of the transaction (transaction value, fraud rate). The value of the transaction is below 30 EUR: For purchases lower than €30. However, SCA will be necessary if a customer makes five transactions in a row or reaches a value of more than €100. Whitelisted by the customer: Your customers can request an exemption to their issuer to white-list you as a "trusted beneficiaries".
   Template File Name	Enter the file name of your template to adapt our payment page to the look and feel of your shop. To learn how to create templates, see our dedicated chapter in the Hosted Checkout Page guide.
   Debug Logging	Enable/disable event logging.
   Total	Define a minimum amount of the basket to make payments for this extension possible.
   Geo Zone	Choose a specific geographical zone to make this extension available on your webshop checkout page
   Sort Order	Specify the order in which the available payment methods are displayed in the "Payment Method" step on your webshop checkout page.

4. Click on "Save" to confirm your settings.

Manage payments

We have designed the plugin to follow-up on your orders easily, freeing you from the administration involved. Learn here how to use our plugin effectively which could help your business to thrive!

Perform maintenance operations

Captures, refunds and cancellations of authorisations are standard processes (maintenance operations) in your everyday business logic. Learn here how to perform these operations directly in the OpenCart Back Office:

1. Login to the OpenCart Back Office. Go to Extensions > Extensions. Select "Payments" from the dropdown list "Choose the extension type".
2. The plugin will load a list matching the "Payments" extension type. In the "Payments" table, look for "Worldline" and click on the "Edit" button in the "Action" column.
3. Go to the "Transactions" tab. In the overview, depending on the order’s status (column "Transaction Status"), the following buttons are available in column "Action":

   Worldline/ OpenCart order status	Available buttons
   statusOutput.statusCode=5 / "pending_capture"	"Capture": Capture the authorised amount to receive the funds for the order. "Cancel": Cancel the authorised amount.
   statusOutput.statusCode=9 /  "captured"	"Refund": Reimburse the funds for the order.
   statusOutput.statusCode=2 /  "rejected"	"Cancel": Cancel the authorised amount.