Callback after PayPal Authentication

On this page:

Overview

After redirecting your customer to the PayPalRedirectURL, this message is sent to your PayPalCallbackURL with the customer, when they have completed their PayPal authentication and payment method selection.

It provides all the transaction information needed to decide if you want to proceed with the payment. The information will be in the form of URL encoded Name=Value fields separated by ampersand characters.

Callback

Callback after PayPal Authentication

Name

Description

Mandatory

Valid Characters

Max

Length

Allowed Values

VPSProtocol

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

Yes

Digits and periods
 

4 

4.00

Status

  • PAYPALOK = The customer has selected a payment type and the transaction is ready to be taken

  • MALFORMED = The input message was missing fields or badly formatted. This will normally only occur during development and vendor integration.

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

  • ERROR = A problem occurred at Opayo which prevented transaction completion.

Important: When you receive a Status of ERROR, please notify us and include your VendorTxCode and the StatusDetail text.

Yes

Uppercase letters

15 

  • PAYPALOK

  • MALFORMED

  • INVALID

  • ERROR

StatusDetail

This text adds detail to the Status value.

Yes

Letters, digits, hyphens, colons, and spaces
   

255 

 

VPSTxId

The Opayo ID to uniquely identify the transaction on our system.

Yes

Letters, digits, hyphens, and curly brackets
   

38 

 

PayerStatus

VERIFIED lets other members know the customer is a confirmed PayPal member with a current, active bank account. It also indicates the transaction may be eligible for PayPal Seller Protection.

Contact PayPal for more information.

Yes

Uppercase letters

 

 

 

255 
  • VERIFIED
  • UNVERIFIED

DeliverySurname

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

Yes

Letters including accents, digits, ampersand, comma, apostrophes, forward and back slashes, hyphens, periods, and spaces
         

20 

 

DeliveryFirstnames

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

Yes

Letters including accents, digits, ampersand, comma, apostrophes, forward and back slashes, hyphens, periods, and spaces
         

20 

 

DeliveryAddress1

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

Yes

Letters including accents, digits, ampersand, comma, apostrophes, forward and back slashes, hyphens, periods, spaces, colons, parentheses, plus, and CR/LF
             

100 

 

DeliveryAddress2

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

No

Letters including accents, digits, ampersand, comma, apostrophes, forward and back slashes, hyphens, periods, spaces, colons, parentheses, plus, and CR/LF
             

100 

 

DeliveryCity

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

Yes

Letters including accents, digits, ampersand, comma, apostrophes, forward and back slashes, hyphens, periods, spaces, colons, parentheses, plus, and CR/LF
             

40 

 

DeliveryPostCode

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

Yes

Letters, digits, hyphens, and spaces
   

10 

 

DeliveryCountry

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

Yes

ISO3166

2 

 

DeliveryState

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

No

Two letter States

2 

Examples:

  • AL

  • MS

  • NY

DeliveryPhone

When a customer modifies their delivery details on the PayPal site, the updated details are returned to you in the Delivery fields. When unchanged, the delivery details are returned from your Transaction Registration POST.

No

Letters, digits, plus, spaces, and parentheses
    

20 

 

AddressStatus

CONFIRMED = A buyer's Confirmed Address is checked against the credit card billing address maintained by the credit card company or is verified by PayPal. It also indicates the transaction may be eligible for PayPal Seller Protection.

Contact PayPal for more information.

Yes

Uppercase letters

20 

  • NONE

  • CONFIRMED

  • UNCONFIRMED

CustomerEMail

The customer’s email address registered with PayPal.

Yes

RFC532N

255 

Example:

me@mail1.com

PayerID

Unique PayPal User Reference ID

Yes

Letters and digits
 

15