Support online payments using Opayo

Steps to integrate with Opayo:

1 About Opayo
2 Integrating your Opayo account into your accessplanit platform
3 FAQ’s

Related Help Guide Pages

Learn how to set up an integration with the payment gateway Opayo, to take payments through your platform, Checkout Basket or Shopping Basket.

About Opayo

Opayo is our recommended payment gateway supplier, and from experience, we have found that our customers find them the best to work with – so much so that we have now chosen to be a partner of Opayo.

Our integration with Opayo uses:

The remote implementation in the Shopping Basket
An Opayo component embedded into the payment step of the Checkout Basket, this means that although it appears as a ‘remote’ integration, all card details are captured and hosted by Opayo. This provides the security benefits of redirect and the user experience benefits of remote!

More information:

Opayo website: Elavon: Card Payment Solutions & Merchant Services
New accounts can take up to 10 days to be set up (as of November 2024)

Integrating your Opayo account into your accessplanit platform

Integrating your Opayo Account with your accessplanit platform is quick and easy, you need to gather a few details from Opayo to allow payments to be taken in accessplanit. Follow these steps to create and gather your Stripe account details.

You will need to ensure that you have the following information set up with Opayo

You will need to ensure that you have both M (MOTO) and E (e-commerce) transaction types enabled on your Opayo account. This will allow you to take online bookings (e-commerce) and process bookings yourself without a 3D security stage (MOTO).
You will also need to provide the IP address of the system to Opayo so that payments are authorised, please contact the accessplanit Helpdesk Team to find out your IP Address.

Opayo has a test mode available.

If you are using Opayo within accessplanit’s Checkout Basket, please note that you need to have the Opayo Pi integration enabled, this can be enabled in addition to Opayo Direct.

Opayo Pi requires two additional pieces of information; these are

Integration Key
Integration Password

Please note, Opayo requires a billing address from booking users. Please speak to your Customer Success Manager to ensure your system has been configured to require a billing address in your Shopping Basket.

Once you have set your Opayo account up, and gathered up the data needed, you are ready to add these to your accessplanit platform

Open the ‘Administration’ menu from the Profile options at the top-right of your platform
Open the ‘Account Finance Options’ menu option to access the page where you can manage your Invoicing and Payment Method settings

Please note

This page is only available to Super Admins, if you cannot access this page, please get in touch with a Super Admin in your team to set up your Stripe integration.

Scroll down to the ‘Payment Methods’ section, here you should see a list of available payment methods for your system including Invoice, Cash, BACS and Card
You should additionally see ‘Opayo’ as an option, if Opayo is not listed here please contact the accessplanit support team and they will enable this for you
Check to enable Opayo as an available payment method
Once you have enabled Opayo, scroll down to the dedicated Opayo Details section of this page
Enter your details
Please ensure that the MOTO and E-Commerce boxes contain M and E.
Vendor Data (MOTO) = M
Vendor Data (E-Commerce) = E
Click the ‘Update’ button at the bottom of the page to save your changes

FAQ’s

Do I need an Opayo account to use the integration?

Yes, an Opayo account is required for this integration.
Elavon: Card Payment Solutions & Merchant Services

Can I process refunds through Opayo?

Yes, any Opayo transactions in your accessplanit platform can be refunded, please see our dedicated guides:

How do I track payments made via Opayo?

Each Opayo payment (and refund) is recorded in your platform as a ‘Transaction’.

There are several ways that you can view Transactions on your platform:

For each Invoice, you can open its ‘Transactions’ page to see all of the transactions made on this Invoice only
You can view all Transactions in a certain date range by adding a DataGrid gadget to your Dashboard and using the ‘Transactions’ module
You can build a report to show you a summary of Transaction data using the ‘Transactions’ module within the Report Engine

I am switching to Checkout, will I need to generate new Opayo details?

Yes! The Checkout integration uses Opayo Pi, while the Shopping Basket integration uses Opayo Direct. These are different integration methods, and each requires its own set of Opayo API credentials.

So when you switch to Checkout, you’ll need to generate and enter the new Opayo Pi credentials in your settings.

We recommend making this update outside of peak hours to avoid any disruption for your users.

What is the character limit for each field when paying using Opayo?

Each field within Opayo has it’s own character limit. Please see the table below:

Field	Mandatory	Character Limit

Field	Mandatory	Character Limit
BillingSurname	Yes	20
BillingFirstnames	Yes	20
BillingAddress1	Yes	100
BillingAddress2	No	100
BillingCity	Yes	40
BillingPostCode	Yes	10
BillingCountry	Yes	2
BillingState	No	2
BillingPhone	No	20

What does the error “4020 : Information received from an Invalid IP Address” mean when trying to take a payment?

The Opayo error code 4020 "Information received from an Invalid IP Address" means that the IP address of the server making the transaction request is not registered as a "Valid IP" in your Opayo account.

Please reach out to our Support Team to obtain the correct IP address which you will then need to whitelist within Opayo.

For more information on IP addresses for Opayo, visit Settings - Opayo - Elavon UK and read through ‘Adding your IP address & entering the IP address’ sections

Knowledge Base

💡Knowledge Base Home | 🚀What's New | 📅Upcoming Training Events