Opayo PI Integration

What is the Context of the article?

Opayo is now trading under the name Elavon. This means their website, telephone, email addresses, and communications will reference Elavon. Elavon will continue to use the Opayo name to describe their eCommerce and face-to-face products, for example, the Opayo gateway or the Opayo POS solutions. Meddbase will still use the term Opayo.

Elavon is a leading payment service provider (PSP) and is one of the most trusted payment brands. Elavon makes the process of accepting payments online, over the phone, or in person simpler, faster, safer and more profitable for businesses.

Previously, Meddbase only integrated with Opayo Server. We have now added an integration to Opayo PI, which brings new features and improvements. This new integration currently mostly contains feature parity with the old Opayo Server integration, but allows us to utilise any new features that Opayo offers only through their PI integration. 

To utilise Opayo PI, you will need to speak to your account manager who can enable this feature for you.

To know more about the differences between Opayo Server and OpayoPI, please see https://www.elavon.co.uk/resource-center/help-with-your-solutions/opayo/integrations/types-of-integrations.html. 

What is the purpose of the article?

This article will walk you through the process of integrating with the new OpayoPI in your Meddbase application.

Note: This article assumes that you already have an Opayo account and have completed the core configuration steps for enabling online payments, previously done when using Opayo Server.

If you haven’t yet set up your Opayo credentials or account, please refer to the Opayo setup guide before continuing.

Prerequisites

Before configuring the new setting, please ensure you have the following:

PCI Compliance

Each client looking to utilise Opayo PI should ensure they are meeting the PCI compliance requirements to use Opayo PI. Whilst Meddbase is not able to provide any guidelines directly to clients on this, it's assumed that each client has completed all relevant compliance steps before turning this feature on.  The compliance requirements for Opayo PI are different to Opayo Server. If you are unsure about the compliance requirements for Opayo PI, please contact Elavon.

Opayo API Credentials

To integrate with OpayoPI, you’ll need to generate API credentials from your Main Administrator's MyOpayo account. If you don't already have these to hand, or have not generated them before, please follow the steps below:

1. Log in to your MyOpayo account using the main administrator account.
2. Go to Settings > Administrator.
3. Click Create API Credentials.
4. Make a note of the Integration Key * and Integration Password * as you will need these when setting up OpayoPI Online Payment types later in this article.

⚠️ Important: Once generated, the keys and passwords cannot be viewed again. If you need to create new credentials, you must first delete the existing ones.  It is your responsibility to ensure that active keys are not deleted accidentally.

Please see https://www.elavon.co.uk/content/dam/elavon/en-gb/v2/documents/resource-center/opayo/getting-started/my-sagepay-guide-k.pdf for more guidance.

The previous Opayo Server Integration does not utilise API credentials. If you utilise Opayo API elsewhere in other systems, please consider the effect of generating new credentials as they will need to be updated.

Configuring OpayoPI in Meddbase

Once OpayoPI has been enabled in your chamber, you will need to create new Online Payment Types in Common Catalogues. 

1. From the Start Page, navigate to Admin > Common Catalogues.

2. Expand the Online Payment Types catalogue.

3. Click New Payment Type.

A group of configuration options needs to be set up for each payment type, for it to function correctly with Meddbase:

The ID and External ID are read-only fields that are set automatically upon saving the payment type.

• *Integration: The type of Opayo integration you want to utilise for this payment type.
  • Opayo Server: Opayo's old integration. See Opayo/Elavon Integration Guide for set up.
  • Opayo PI: Opayo's new integration.
    • This setting will only show if Opayo PI has been enabled in your chamber
• Name: The name of the payment method. This will be visible in the list of payment methods while making a payment.
• Account Code: The vendor name used to register the Opayo account. Please note: Account Code should not contain any capital letters or spaces.
• Integration Key *
• Integration Password *

• Description: A brief description of the payment type.
• Portal Default: This option is to be selected in order for OpayoPI to be set as the default payment method for the Patient Portals.
• Account Type: This is where you can choose E-Commerce or Mail Order payment types.
  • You will likely want to set up both:
  • E-Commerce should be used by the patient if paying by the portal.
  • Mail Order should be used if processing the payment within Meddbase.
    • *If portal default is enabled, you will not be able to select Mail Order.
• Allow Gift Aid: In the UK, the government runs a scheme called Gift Aid that enables charities to claim the basic rate of tax on every pound. Only registered charities can use Gift Aid through the Opayo platform. If you are not a charity, you will not be able to use this through Opayo.
• Company: The Meddbase chamber that this payment type will be added to.

Once the online pay type has been saved successfully, it may be used for online payments in the same way as the existing Opayo Server integration.

Switching from Opayo Server to Opayo PI.

If you previously had Opayo Server and want to switch fully to OpayoPI, please follow the steps above to set up a payment type for 'Opayo PI' and set this as the default Portal Default. 

We advise retaining the Opayo Server configuration until you have successfully tested and validated the Opayo PI integration, and understand the changes. Both integration types can exist and run in parallel.

Please note: Previously stored card details will not be retained on Opayo PI, as they were originally set up and stored on the Server payment method. If the Server payment method is removed, any associated card details will also be removed. New card details will need to be captured with the new Opayo PI payment type.

If you wish to remove Opayo Server completely , please see the steps to Delete old Opayo Server Payment Types:

1. Go to Admin > Common Catalogues.
2. Select Online Payment Types.
3. Ensure the new E-Commerce OpayoPI Payment type has "Portal Default" Enabled.
4. Find the old payment type with "Opayo Server" listed in the Integration field.
5. Select and delete this payment type.

Review date

This article was last updated on 6th August 2025.