Commercetools
Introduction
Our Commercetools plug-in comes with regular updates and full integration support, guaranteeing a versatile out-of-the-box solution to accept online payments easily.
Supported integration & payment methods
Offers the following integration methods on our platform:
Hosted Checkout Page
Redirect your customers from your checkout page to our platform for entering sensitive payment data.
Hosted tokenization page
Include an iFrame payment form hosted on our save environment in your checkout page for entering sensitive payment data.
- Offers the following payment methods on our platform:
Alipay+
American Express
Apple Pay
Bancontact
Bizum
Carte Bancaire
Cpay
Diners Club
iDEAL
Illicado
Intersolve
JCB
Multibanco
OneyBrandedGiftCard
PayPal
SEPA Direct Debit
Maestro
MasterCard
Visa
WeChatPay - Manages multiple stores
- Accepts payment operations (Refunds, authorisations, captures etc.) directly from the plugin
Keep an eye on our Release Notes to stay informed about updates and new features (i.e. payment methods, features, integration modes) 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!
- Entrust a system integrator or a technical consultant with the installation and the configuration of the plugin
- Accordingly, the target audience of this documentation are system administrators with a profound knowledge of Commercetools platform.
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 |
|
Direct credentials |
|
Commercetools Frontend |
Compatible with all Frontend versions. |
PCI compliancy |
SAQ A (14) |
Detailed installation process can be found out in README document available with the package or on Github.
Basic configuration
- Navigate to “My Account” section in Commercetools merchant center.
- Select Test or Live mode as necessary.
Enter the following information:
Property |
Description/Actions |
Merchant ID |
Enter your PSP ID or merchant ID that you used to sign up with Worldline |
API Key |
Enter the API key of your test or live PSPID. Read our dedicated guide to learn how to generate one |
API Secret |
Enter the API secret of your test or live PSPID. Read our dedicated guide to learn how to generate one |
API Endpoints |
The test or live endpoint on our platform. Copy them from our dedicated guide. |
Webhook Key |
Enter the Webhooks Secret of your test/live PSPID from the Merchant Portal as described in our dedicated guide. |
Webhook Secret |
Enter the Webhooks Secret of your test/live PSPID from the Merchant Portal as described in our dedicated guide. |
Timeout in Minutes |
Set the interval for API timeout (Set to ‘180’ by default) |
Webhook URL |
Copy this URL into the Endpoint URLs fields in the Merchant Portal as described in our dedicated guide. |
SMTP Server credentials |
Setup your mailbox to be notified about failed payments. Also, send emails to Worldline and request new features. Available for both test and live modes.
|
Click Save/Update to ensure all information is reflected as expected. The system will automatically test the API connection using the provided API credentials.
- If a valid response is received from Worldline, the configuration will be saved.
- If the connection test fails, an error message will be displayed, allowing you to review and edit the settings.
Read our dedicated guides about API endpoints and authentication to get a thorough understanding about the test/live environment and API key/API secret.
We strongly recommend configuring a separate name for both our test and live environment. This will allow you to manually switch from one environment to the other easily. Make sure not to mix up credentials from test with live and vice versa.
Advanced configuration
We categorise payment methods in two different clusters
- Card payments
- Alternative payment methods
You can process card payments either via Hosted Tokenization Page or Hosted Checkout Page, whereas the alternative payment methods are available only via Hosted Checkout Page
Follow these steps to make your choice:
- Go to Worldline > Payment Methods in the merchant center.
- Multiple payment modes are available. Please make sure to activate using the toggle as per your reference.
Here is a quick summary of each payment mode:
ID value |
Description/Actions |
On Site Mode: Card payments only |
Covers all card-based payment methods
Configuration options:
*If both of the options are set to Yes, 3DS Challenge takes precedence and no transactions will be exempt. |
Redirect Mode A: Payment method selection before redirection |
Covers all cards and alternative payment methods.
*If both of the options are set to Yes, 3DS Challenge takes precedence and no transactions will be exempt. The payment methods are displayed in grid format and can be enabled or disabled from here. Once enabled, the customer can also use the Settings option to upload images for each payment method activated. |
Redirect Mode B: Payment method selection after redirection |
Covers all alternative payment methods (digital wallets, mobile payment methods, gift cards etc.) in full redirect mode.
*If both of the options are set to Yes, 3DS Challenge takes precedence and no transactions will be exempt. |
Please note that the configuration will be stored based on the Store and Country basis. Whenever you select the locale in the Frontend the data for that Store and Country will be rendered.
- Have a look at all available payment methods our platform has to offer
- The plugin uses a specific API call in real-time to ensure your customers can choose any active payment method in your account. If you want to add more payment methods to your account, contact us
There are some additional configurations which are applicable across different payment modes. Please see the table below for that configuration.
Property |
Description/Actions |
Merchant reference ID |
Use this identifier to customize your order reference and match with Worldline Merchant Portal. |
Transaction Type |
Define whether to process the transactions in authorisation mode or as direct sale. Select one of the following options:
If you authorise payments only, make sure that you capture them later. Only then will the transaction reach StatusCode=9, for which you receive funds. |
Capture configuration |
This allows you to set automatic capture procedure using and Automatic Capture Job. This job allows you to set the capture delay of X days in the given field. At the end of this duration, a cron job will capture the transaction automatically. |
Enable Debugging Logging |
Allows logging for transactions for debugging in case of issues. You can also download them to share further. |
Manage payments
We have designed the plugin to follow-up on your orders automatically and autonomously, 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 (also known as maintenance operations) in your everyday business logic. Learn here how to perform these operations directly from the Commercetools merchant center:
- Go to Worldline > Orders. The Order details page segregates the orders based on the combinations of Stores and Countries. The Sample Orders page looks like-
Depending upon the payment status, the following buttons are available in the "Actions":
Maintenance operations |
Description/Actions |
Capture |
Capture authorised transactions ((StatusCode=5 / Status=PENDING_CAPTURE / AUTHORIZED/ PARTIALLY CAPTURED / PARTIALLY CANCELLED) to effectively receive funds for the order-
If you want our plugin to capture transactions automatically, please make sure to setup capture configuration in payment methods setup. |
Cancel |
Cancel authorised transactions (StatusCode=5 / Status=PENDING_CAPTURE / AUTHORIZED / PARTIALLY CAPTURED / PARTIALLY CANCELLED)
Please note that currently, partial cancellation is not supported by Worldline. Hence, irrespective of the amount mentioned, the order will be cancelled fully. |
Refund |
Reimburse your customers for captured transactions (StatusCode=9 / Status=COMPLETED / CAPTURED / PARTIALLY CAPTURED / PARTIALLY REFUNDED)
|
Perform test transactions
Use our platform's test environment to make sure your plugin works as intended. We offer test data sets on our dedicated Test cases page. Target our test environment as described in the Configure Plugin section.
Make sure to switch to the LIVE environment as soon as you have finalised your tests.