Configuring Opayo by Elavon Module for osCommerce 2.3

This manual explains how to configure the Opayo by Elavon payment module for osCommerce 2.3 after installation.

Start with the video for a quick introduction to the configuration process.

The guide below will walk you through the process of setting up the module to accept Opayo payments and manage your transactions efficiently.

1) Prerequisites

Ensure that the Opayo by Elavon module is already installed.

Refer to the manuals:

for detailed installation instructions.

2) Initial Setup

If you installed the module via Zip File, click on the Opayo by Elavon module and then click Install Module.
If you installed the module via Installer, this step is done automatically.

If you have not yet obtained your vendor login name:

1. Click the Visit Opayo Website link.

2. Fill in the required fields and submit your request.

3. After submission, an Elavon payment specialist will contact you to confirm your request and create your account.

4. You will receive an email containing your vendor login name.

Once you have your vendor login name, click on the Edit button to proceed with configuration.

3) Configuring Module Settings

In the module settings, fill in the following fields:

1. Accept Opayo PI payments – Enable to activate payment processing via Opayo.

2. Vendor login name – Enter the vendor name provided by Elavon to connect to the payment gateway.

3. Opayo API key and password – Enter your API credentials.

4. Processing method – Choose the method for handling transactions:

Authenticate – Verifies the credit card.
Deferred – Temporarily blocks a small amount on the card.
Payment – Processes the full amount immediately.

The corresponding order status is updated automatically depending on the transaction type. In turn, when the order status is switched to the required one and if only the small amount of money was previously blocked, the system will process the whole payment.

5. Server selection – Choose whether to perform transactions on the Production or Testing server.

6, Payment zone – Restrict this payment method to a specific zone if required.

7. Order status – Define the status for orders placed via this module.

8. 3D Secure setting – Skip 3D Secure verification for tokenized payments below a specified amount.

9. Sort order – Define the display order of this payment method in the checkout (lower numbers appear first).

4) Generating API Credentials

To generate the Opayo Payment Integration API Key and Password, follow these steps:

1. Log in to MyOpayo in either the TEST or LIVE environment using your Administrator credentials.

2. Navigate to the Administrator → Password details section.

3. Select the option to Create API credentials.

4. Confirm by ticking the box:

“I understand that this will create new credentials and may break any existing Opayo API implementations.”

5. Click Create API credentials.

You will then receive the following information:

Environment – Specifies whether the credentials apply to the Test or Live environment.
Vendor Name – Your account vendor name.
Integration Key – The API username.
Integration Password – The API password.

Important:

If you create new credentials, all previously generated credentials become invalid immediately.

If your integration already uses the REST API, it will stop working until you update your system with the new credentials.

Store your credentials securely. If they are lost, you must repeat the generation process to obtain new ones.

Once configuration is complete, your Opayo by Elavon module is fully integrated with osCommerce 2.3, allowing you to start accepting payments seamlessly and securely.