Documentation

Setup

Welcome to the setup guide.

To get this plugin setup will only take around 30 mins; this guide will be broken down into steps. You must first do a test transaction using the test WorldLine account.

It is always best practice when setting up a payment gateway to do this in test mode first and run several orders before switching to live mode. You can check out our guide from this link regarding how you can proceed in creating a test account for WorldLine.

Step 1 – Plugin settings.

Install the plugin & activate the license key; once this is done, you want to navigate to the plugin settings page; this can be found in the WooCommerce settings:

Note
WooCommerce > Settings > Payments > AG Worldline Hosted Checkout for WooCommerce

The key items here for the setup are PSPID/ Merchant ID, API Key, and API Secret.

These settings will need to be matched with what you generated from the WorldLine back office.

Step 2 – Login to the test WorldLine back office.

The next set of items are done in the WorldLine back office; you can log in to the test account here. Once logged in, you need to navigate to the technical settings area. It is important to note that whatever changes to make in the test account, you must match in the live account.

From this area, we have access to all the sections we need to change/edit.

Note
As mentioned in the welcome section above, it’s important to make sure you use the plugin in test mode and use the WorldLine test account; linking the plugin in test mode to the live WorldLine account will not work.

How to know if you are using the WorldLine test account? When you have logged in, look to the WorldLine logo. To the right of it, you will see TEST in red like this:

Step 3 – Global transaction parameters.

In this section, you need to decide which operation mode you want to run the payment gateway.

Based on these two steps, you can choose between two default operation codes:

  1. Authorization: our system will only ask for authorization to have the authorization and data capture (payment request) steps performed separately at different times (the money remains in the customer’s account until a data capture (payment request) has been performed).
  2. Sale: our system automatically requests the payment (transfer of the amount) immediately after a successful authorization. This procedure is often used for goods/services delivered online.
Note
If you are unsure what to enable, ask your client what they have been using, most users enable the sale method, but it is down to how the business operates.

Step 3 – Generating API Key and Secret

You will have to generate your API key and secret from the WorldLine back office. Particularly, in Configuration > Technical Information > Ingenico Direct Settings. These will be used in the plugin’s settings.

Once the API key and secret are generated, copy the information and proceed in your WooCommerce > Settings > Payments > Hosted Checkout for WooCommerce to paste them, save your settings and proceed to the next step.

Step 4 – Test, Test & test.

Well done, you have now finished the setup of the plugin! Now the important thing to do is test the payment gateway a few times before going live.

If you have any errors/issues, you first want to check the WorldLine error log section.

In the description field, you will most likely find an error code, something like unknown order/1/r. If you do, you can have a look here at the troubleshooting error codes. There you will find out what the issue is and what is needed to fix it.

If you are still having issues, then enable the plugins debug log in the settings.

Run some test transactions, and if the plugin finds something wrong with the plugin setup, it will log this and tell you how to fix this; you can find the log by going here:

Note
WooCommerce > Status > Logs

Here we can see the log saying that transaction is confirmed, no issues found.

We also added a button that could let you test the API details with one click. This button is located in WooCommerce > Settings > Payments > AG Worldline Hosted Checkout for WooCommerce and labeled as “Test Connection”.

We still recommend proceeding with the test payments but this button should be very useful for a quick test as well.

Note
The plugins debug log is coded to log most errors and give you a tip on how to fix the issue. It’s important to check these logs if you are having issues.

If you still face issues, then send a support ticket, and we will have a look for you.

Please be ready to send screenshots of the plugin & WorldLine settings and the debug log.

Was this helpful?

Worldline Hosted Checkout

Don't already have the plugin? Get access now.

Still need help?

Our team are on hand to provide fast, helpful and professional support.

Support request