This document provides a brief overview of the basics involved in migrating from version 2.22 to 3.00. If you require more technical information then please refer to our Upgrade Guide 2.22
When upgrading your website to Opayo version (protocol) 3.00 you will need to make changes to the payments information that is sent from your website to Opayo.
This information is sent via ‘fields’, and, as part of the upgrade process, it is these fields that need to be amended, removed or added.
You will need to increase the number of mandatory fields from 6 to 16. These are listed out in the diagram below. The fields to be added are highlighted in green.
From the optional fields, four will need to be removed and up to 14 new fields can be added. Please note that these fields are optional as this information does not need to be sent to Opayo.
In addition to the above changes, there are four further fields that will remain
In the Field ‘VPSProtocol’ – you must change the value from 2.22 to 3.00.
You also need to update the fields that are used to build the crypt. The crypt includes all of the payment data that is sent with each transaction.
Below is a list of all fields that are included in the crypt string. Those highlighted in red will need to be removed from your website, and those in green added and included in the crypt that is sent to Opayo with your transactions.
Important – if your business is classed as Financial Institution (Merchant code – 6012) there are 4 additional fields that will need to be included with the transaction post from your system.
Once the changes to the fields have been made, check that you are using AES encryption to build your crypt string.
You must also ensure that you decode the crypt string using the same method.
Any other encryption method will not allow you to send the payment data to us and will generate errors.
Once all the changes have been implemented, you will be able to take payments as normal without any disruption.
More detailed information on the changes required can be found in our technical guides.
We’ve also developed integration kits for Java, PHP and .NET which your developer can use to complete the migration to version 3.00.