Opayo Form Integration Overview

This guide provides an overview of the technical detail you need to integrate your website with Opayo's systems

The final Pay Now button on your website is your link to the Opayo gateway. Once the customer has selected their purchases, entered billing, and delivery details on your site, you present them with an order summary and the option to ‘Pay Now.’

While generating the order summary, a simple piece of server-side scripting builds an encrypted hidden field that is placed on the form. This field contains all the transaction information in a format that the Opayo gateway can understand. When the customer clicks Pay Now, the encrypted contents of that field are POSTed to the Opayo gateway and the customer is redirected to the hosted Opayo payment pages.

The Opayo payment pages present the customer with available payment methods, allowing them to enter their payment details. The hosted payment pages can carry your logo and a description of the goods that the customer is paying for, so they can remain confident they are buying from you. You can also customise the payment pages to carry the look and feel of your own website or brand at no additional cost. Payment page templates can be downloaded from here. Please note however, that the most recent responsive designs are not yet customisable but you can continue to customise and use our older design.

Once the customer has selected a payment method and supplied the payment details, they are shown a full summary of the order, including the basket contents (provided this was included in your POST) and asked to confirm that they wish to process. If applicable, Opayo will request authentication from the 3D directory (Verified by Visa, MasterCard SecureCode, and Amex SafeKey), provided the result passes the rules you have set in MyOpayo, then we request authorisation from your acquiring bank. Once the bank has authorised the payment (and assuming the address and card security code results pass the rules you have set) the customer is redirected back to a ‘success’ page on your site. If authorisation fails, the customer is redirected back to a ‘failure’ page on your site. Both pages are sent encrypted information which you can decrypt to obtain and extract detailed information about the transaction.

If you provide an email address for you and the customer in your post, you have the additional flexibility to request that confirmation emails are sent in the event of a successful transaction. If the order fails, only you are emailed with a failure notification.

Form Integration Workflow Steps 

  1. The customer orders from your site
  2. Your server builds a confirmation page
  3. The customer enters payment details on Opayo's server
  4. Opayo checks for 3D-Secure enrolment
  5. Opayo redirects the customer to their issuer
  6. The issuing bank returns the customer to Opayo
  7. Opayo servers request card authorisation
  8. Opayo redirects the customer to your website
  9. Opayo sends settlement batch files


The customer orders from your site ❯