Skip to main content

Response Fields

Initial Response (Direct Integration)​

These fields will be returned, in addition to the PPRO initial request fields and the Basic Response Fields minus any card details.

Field NameMandatory?Description
checkoutRefNoUnique checkout session reference.
checkoutNameYes

Unique name of the PPRO APM Checkout.

Currently uses the value of paymentMethod.

checkoutURLYesURL required to load the PPRO APM Checkout.
checkoutRequestNoRecord containing any data that must be sent to the PPRO APM Checkout via a HTTP POST. If not provided, then the Checkout can be loaded via a HTTP GET.
checkoutOptionsNoRecord containing any checkoutOptions passed in the request or added by the Gateway.
checkoutDetailsNoRecord containing additional information provided by the PPRO APM Checkout.
acquirerResponseDetailsYesRecord containing useful details about the PPRO transaction, notably whether the APM offers a payment guarantee.

Completion Response (Hosted and Direct Integration)​

These fields will be returned, in addition to the PPRO initial request fields, the PPRO initial response fields and the basic response fields minus any card details.

Field NameMandatory?Description
checkoutResponseYesContaining additional information provided by the PPRO APM Checkout. Any change in the payment’s status will be given in the state, responseMessage and responseCode fields[1]1
checkoutStatusYesA string containing the result of the PPRO APM Checkout process. This is not used to identify the transaction’s payment status.

Footnotes​

  1. Not all payment methods give an immediate payment status. This will require a further QUERY to the Gateway to see whether this value has changed to a status of ‘tendered’. ↩