Transaction Registration POST Response

This is the plain text response part of the POST originated by your servers. The POST is encoded as Name=Value fields separated by carriage return and linefeeds (CRLF) as described in the following table.

Transaction Registration POST Response

Name

Description

Mandatory

Format

Max Length

Allowed Values

VPSProtocol

Protocol version used by the system supplied in the Transaction Registration POST.

Yes

Digits and periods
 

4.00

Status

When the Status is not OK, then the StatusDetail contains the reason why.

  • OK = The process executed without an error.

  • OKREPEATED = When the VendorTxCode passed here has been used before, and that transaction is still active, then details of that transaction are passed back in this POST and the suffix REPEATED is appended to the OK Status.  

  • MALFORMED = The input POST is missing fields or is badly formatted. These errors normally only occur during development.

  • INVALID = The transaction was not registered. Although the POST format is valid, some data supplied was invalid.  For example, an incorrect vendor name or currency was included.

  • ERROR = A problem occurred at Opayo which prevented transaction registration. Please notify us when a Status of ERROR is returned together with the message Vendor, VendorTxCode and the StatusDetail contents.

 

Important: Your system must handle REPEATED messages from Opayo.

Yes

Uppercase letters

15 

  • OK

  • OKREPEATED

  • MALFORMED

  • INVALID

  • ERROR

StatusDetail

This text adds detail to the Status value. Always check StatusDetail when the Status is not OK or OKREPEATED.

Yes

Letters, digits, commas, periods, colons, spaces, and parentheses
      

255

 

VPSTxId

The VPSTxId returned to you when the transaction was registered. Only present if the Status is OK or OKREPEATED.

Yes

Letters, digits, hyphens, and curly brackets
   

38 

 

SecurityKey

Opayo uses this security key to generate an MD5 hash to sign the Notification message. The signature is called VPSSignature.

This value is used to enable the detection of tampering with notifications from the Opayo gateway.  It must be kept secret from the customer and held in your database.

Only present if Status is OK or OKREPEATED.

Yes

Letters and digits
 

10 

 

NextURL

This is the URL that the Vendor must redirect the customer to and continue the transaction.

Only present if Status is OK or OKREPEATED.

Note. The full URL must be used for the redirect including any appended parameters.

Yes

RFC1738

255