Aero Commerce
Introduction
Our Aero Commerce plug-in comes with regular updates and full integration support, offering a versatile out-of-the-box solution to accept online payments easily:
- Supports both Hosted Checkout Page and Hosted Tokenization Page integration methods.
- Offers the following payment methods on our platform:
Apple Pay
Google Pay
iDEAL
MasterCard
Visa
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 plugin
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
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 |
|
Aero Commerce | No specific requirements, compatible with every store |
PCI compliancy |
SAQ A |
Once done, follow these steps:
```shell
composer require aerocommerce/worldline
```
Configuration
After the installation, you need to configure the plugin to link your store to our platform.
Configure Basic settings
- Login to the Aero Commerce Back Office. Go to Configuration > System > Manage Settings.
- Click on Worldline in column "Name" in the table.
- Configure the following settings in the "Sandbox Credentials"/"Live Credentials" tab:
Property Description/Actions Merchant ID Enter your test/live PSPID from our platform that you want to use for transaction processing. API Key Enter the API Key of your test/live PSPID. Read our dedicated guide to learn how to generate one. API Secret Enter the API Secret of your test/live PSPID. Read our dedicated guide to learn how to generate one. Endpoint The preconfigured test/live endpoint of our Direct API.
We strongly advise not to change this value
Webhooks Key Enter the webhooks Key of your test/live PSPID from the Merchant Portal as described in our dedicated guide. Webhooks Secret Enter the webhooks Secret of your test/live PSPID from the Merchant Portal as described in our dedicated guide. Template Filename Enter the file name of your template to adapt the "Hosted Tokenization (iframe)" or "Hosted Checkout (redirect)" for property "Payment page Mode" to the look and feel of your shop. To learn how to create templates, see our dedicated chapters in the Hosted Checkout Page and Hosted Tokenization Page guides. - Configure the following settings in the lower tab:
Property Description/Actions Webhook Processing Delay (Seconds) Defines the minimum time span (in seconds) before processing webhooks. If customers have issues returning to your webshop after finalising a transaction, the webhook is a backup to ensure you can display the correct transaction result. Enable Hybrid Checkout if Worldline is the only available payment method Select one of the options to define the checkout process:
- Enabled: Your customers select the payment method on your web shop checkout page. Upon confirming the order, the plugin then redirects your customers either:
> To a version of our Hosted Checkout Page that is branded according to the selected payment method.
> The third party provider offering the selected payment method.
If you select "Hosted Tokenization (iframe)" for property "Payment page Mode", the webshop will display the Hosted Tokenization Page iframe for card payments on your web shop checkout page. Your customers can still select any available non-card payment method on the checkout page. - Disabled: Your customers confirm the order on your web shop checkout page. The plugin then redirects your customers to our Hosted Checkout Page to allow them selecting their preferred payment method.
If you select "Hosted Tokenization (iframe)" for property "Payment page Mode", the webshop will display only the Hosted Tokenization Page iframe for card payments on your web shop checkout page. However, your customers cannot select any other potentially available non-card payment method.
Capture funds immediately on order completion Define whether to process the transactions in authorisation mode or as direct sale. Select one of the following options:
- Enabled: The amount has been ordered to be paid out in one go. Successful transactions will have status "CAPTURED" in the module.
- Disabled: The amount is only blocked on your customer's card. Use this mode when you wish to capture a transaction only after shipping the order. Successful transactions will have status "AUTHORIZED" in the module.
If you disable this option, beware of the following: Make sure that you capture authorised transaction later. Only then will the transaction have status "CAPTURED" in the module.
Operate in Test Mode (Uncheck when going live) (Un)Flag to link your shop to the respective environment. Depending on your selection, the shop module will send the transaction requests to the test or production environment. Payment page Mode Select one of the options for processing payments:
- "Hosted Checkout (redirect)": The module processes both card and non-card payment methods via Hosted Checkout Page integration method.
- "Hosted Tokenization (iframe)": The module processes only card payments via Hosted Tokenization Page integration method.
Group cards as single payment method Define how card payment methods are displayed on the web shop checkout page (Enabled Hybrid Checkout) or the Hosted Checkout Page (Disabled Hybrid Checkout):
- Enabled: Group all cards payment methods under one category.
- Disabled: List all available card payment methods individually.
Allow customers to save card information Define whether to store your customers’ card data for future Card On File payments
- Enabled: Create a token for every successful card transaction.
- Disabled: Do not store the card data.
Payment method Icons Displays the payment methods you offer in your webshop.
This setting does not have an impact on the actually available payment methods. Use either "Enable Hybrid Checkout if Worldline is the only available payment method" / "Payment page Mode" properties to control that.
- Enabled: Your customers select the payment method on your web shop checkout page. Upon confirming the order, the plugin then redirects your customers either:
- Click on "Save" to confirm your settings.
- Go to Modules. Click on Worldline API Check in column "Name" in the table to confirm and validate your settings by establishing a test connection between the plugin and our platform. Check that in the table "Test Result" states "Success". If it does not appear, contact your system administrator for troubleshooting to check:
a. You are using the correct credentials
b. Whether your PSPID is active
Configure payment methods
- Login to the Aero Commerce Back Office. Go to Configuration > Payment methods
- Click on "+ New Payment Method" and configure the following settings
Property Description/Actions Name Add a name to refer to this module in the plugin. Driver Select "worldline" from the drop down menu. Available Set the flag to make this module available in the checkout process.
By setting this property, any of your active (card and non-card) payment methods in your Worldline account are available in the checkout process.
Sort Define the position of the module in the list of available payment methods on the web shop checkout page.
- 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 refunds
Refunding is a standard process in your everyday business logic. Learn here how to do these directly in the Aero Commerce Back Office:
- Login to the Aero Commerce Back Office. Go to Order Management > Orders.
- In the order overview, click on the order in the table.
- Click on "+ New Return / Refund" and fill in "Quantity" and "Refund %" for a (partial) refund
Mind that you can only refund transactions in status "CAPTURED". If you try to refund a transaction in status "AUTHORIZED", the order overview shows the message "There are uncaptured payments against this order. Refunds can only be made on captured payments." - Click on "Save" to confirm the operation.
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 chapter "Configure plugin".
Make sure to switch to the LIVE environment as soon as you have finalised your tests.