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
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 environments. A test account is a great way to get familiar with both the plugin and our platform. Once you want to go live, contact us!
Plugin code modifications void technical support
For security and stability, ANZ Worldline Payment Solutions does not support plugins whose code has been modified by the merchant or a third party. Plugins are provided as-is (official version). Any unauthorised modification voids support and warranty and may cause malfunctions, security gaps, or incompatibilities with PSP updates.
Installation
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 | |
| ANZ Worldline Payment Solutions credentials |
|
| OpenCart | See "Compatibility" on the Marketplace repository |
| PCI compliancy |
SAQ A |
Once done, follow these steps:
- Login to the OpenCart Back Office. Go to Extensions > Installer.
- Click on the “Upload” button to add the file.
- 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.
- Login to the OpenCart Back Office. Go to Extensions > Extensions. Select "Payments" from the dropdown list "Choose the extension type".
- 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. The plugin configuration screen will appear with different tabs.
Account 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. |
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:
- You are using the correct credentials.
- Whether your PSPID is active.
- You send the request to the correct PSPID/environment (Test vs Production)
Advanced settings
| Property | Description |
|---|---|
| Authorization Mode |
Define whether to process the transactions in authorisation mode or as direct sale. Select one of the following options:
If you select"Pre Authorization" or "Final Authorization", make sure you capture authorized transaction later. Only then will the transaction have statusOutput.statusCode=9/status "captured" in the module. |
| Capture Configuration |
Configure the duration for auto capture. You can choose to capture manually or set a duration for auto capture. Mind that you need to setup a cronjob for this purpose on the respective environment as well. |
| Forced Tokenization |
Define whether to store your customers' card data for future Card On File payments:
|
| Surcharging Status |
Confirm choices on whether you want to apply surcharge to your transactions. |
| 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:
|
| 3DS Exemption Request |
Some markets allow you to potentially exempt your customers from a 3-D Secure check:
|
| Debug Logging |
When debug logging is activated, additional details such as purchase amount, customer address, incoming webhook data, and HTTP requests/responses from the API are recorded. |
| 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. |
Click on "Save" to confirm your settings.
Hosted Checkout settings
| Property | Description |
|---|---|
| Status | Enable/Disable non-card payment methods via the Hosted Checkout Page. If you disable this setting, make sure to set Hosted Tokenization Settings > Status to "Enable" to ensure at least card payment methods are possible. |
| Payment Title | Customise the payment button text on your webshop checkout page. |
| Payment Button Title |
Customise the submit button text on your webshop checkout page. Default value: “Place Order”. |
| Grouped cards | |
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:
- Login to the OpenCart Back Office. Go to Extensions > Extensions. Select "Payments" from the dropdown list "Choose the extension type".
- 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.
- 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":
ANZ Worldline Payment Solutions/
OpenCart order statusAvailable 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.
Make sure to switch to the LIVE environment as soon as you have finalised your tests.