Configuring Opayo by Elavon Module for osCommerce 2.2

From osCommerce Wiki
Jump to navigation Jump to search

This manual provides step-by-step instructions for configuring the Opayo by Elavon payment module in osCommerce 2.2.

For a quick overview of this functionality, watch the video first.


Important:

Before proceeding, make sure you have reviewed one of the installation guides:

"Installing Opayo by Elavon Module for osCommerce 2.2 via Installer" and "Zip File"

1) Module Installation Check

  1. Log in to the admin area of your website.
  2. Go to ModulesPayment.
  3. If you installed the module via Zip File, click Opayo by Elavon and then click Install Module. If installed via Installer, this step is already completed automatically.
1 Paym mod screen.png


2) Obtaining Vendor Login Name

  1. If you do not have a Vendor Login Name, click Visit Opayo Website (the link in module settings).
2 Paym mod screen 2.png


2. Fill in the required form fields and click Submit Your Request.

3 Request form.png


3. You will see the success page.

4. Wait for a call from an Elavon payment specialist to confirm your request.

5. After your merchant account is created, you will receive an email containing your Vendor Login Name.

4 Success page.png


3) Editing Module Settings

  1. Return to the Opayo by Elavon module in your admin panel.
  2. Click Edit to configure the available settings.
5 Edit.png


Using the configuration options, you can:

  • Enable Opayo PI payments
  • Enter your Vendor Login Name
  • Enter the Opayo API Key and Integration Password
  • Select Transaction Processing Method:
    • Authenticate – verifies the card only
    • Deferred – reserves funds but does not capture full payment
    • Payment – processes the full amount immediately
    • Depending on the transaction method the corresponding order status is set. 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.
  • Choose Production or Testing server mode
  • Restrict the payment method to a specific Payment Zone (optional)
  • Set Order Status after payment
  • Skip 3D Secure verification for token-based payments below a specified amount
  • Define Sort Order (controls display position at checkout)
6 Settings.png


4) Generating API Key and Password

To generate your Opayo payment integration credentials:

  1. Log in to MyOpayo (TEST or LIVE environment) using Administration login.
7 Test envir.png


2. Open the Administrator tab and locate Password details.

3. Select Create API credentials.

4. Confirm by checking the box stating you understand new credentials will replace existing ones.

5. Click Create API credentials.

8 Create credentials.png


You will receive:

  • Environment - the environment for which the credentials apply (Test or Live)
  • Vendor Name - the vendor name for the account
  • Integration Key - the value for the Integration key (Username)
  • Integration Password - the value for the Integration password
9 API credent.png


Note:

Creating new credentials immediately invalidates any previously used credentials.

If you already integrated Opayo elsewhere, update those systems as well.

Store your credentials securely.

If they are lost, you must repeat this process to generate new ones.


By following these instructions, you can effectively configure the Opayo by Elavon module for osCommerce 2.2.