Configuring Opayo by Elavon Module for osCommerce 2.2

From osCommerce Wiki
Jump to navigation Jump to search

This user guide provides step-by-step instructions for configuring the Opayo by Elavon module on osCommerce 2.2. Please refer to the manuals "Installing Opayo by Elavon Module for osCommerce 2.2 via Installer" and "Zip File" before proceeding with this guide.

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

1 Paym mod screen.png

If you do not have a vendor login name yet, click on the "Visit Opayo Website" link.

2 Paym mod screen 2.png

Fill in the required fields and click on the "Submit Your Request" button.

3 Request form.png

You will see the success page so wait for the call from an Elavon payment specialist. Once you confirm your request with them and after your account is created, you will receive the email that will include your vendor login name.

4 Success page.png

After you get your vendor login name, click on the Edit button.

5 Edit.png

With the help of the settings for Opayo by Elavon module you can:

  • Accept Opayo PI payments.
  • Fill in the vendor login name to connect to the gateway with.
  • Fill in the Opayo API key and password.
  • Select the processing method to use for each transaction: Authenticate - checks a credit card; Deferred - blocks a small amount of money on a credit card; Payment - processes the whole amount. 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.
  • Perform transactions on the either production or testing server.
  • If a payment zone is selected, it enables this payment method for this zone only.
  • Set the status of orders made with this payment module to this value.
  • Skip 3D secure verification when paid by token on orders below a certain amount.
  • Sort order of display will show this payment method - lowest is displayed first.
6 Settings.png

To generate the Opayo payment integration API Key and password, follow these steps:

1. Go to MyOpayo in either the TEST or LIVE environment and log in using the Administration log-in details.

7 Test envir.png

2. Navigate to the Password details section of the Administrator tab.

3. Select the option to 'Create API credentials' and confirm. You just have to select the tick-box labelled 'I understand that this will create new credentials and may break any existing Opayo API implementations.' and click on the 'Create API credentials' button.

8 Create credentials.png

Once you have opted to create your new credentials you will be presented with the following information:

  • Environment: This specifies 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

If you choose to create new credentials, any previously created credentials will immediately become invalid.

Therefore, if you have already integrated with the REST API, you will not be able to authenticate your calls until you replace your expired credentials with newly generated ones.

Please store these credentials safely. If you lose them, you will need to generate a new set of credentials using the same process.

By following these instructions, you can effectively configure the Opayo by Elavon module for osCommerce 2.2. For a visual demonstration, refer to the video linked here: Configuring Opayo by Elavon Module for osCommerce 2.2 - Comprehensive Guide