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 Name | Mandatory? | Description |
|---|---|---|
| checkoutRef | No | Unique checkout session reference. |
| checkoutName | Yes | Unique name of the PPRO APM Checkout. Currently uses the value of |
| checkoutURL | Yes | URL required to load the PPRO APM Checkout. |
| checkoutRequest | No | Record 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. |
| checkoutOptions | No | Record containing any checkoutOptions passed in the request or added by the Gateway. |
| checkoutDetails | No | Record containing additional information provided by the PPRO APM Checkout. |
| acquirerResponseDetails | Yes | Record 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 Name | Mandatory? | Description |
|---|---|---|
| checkoutResponse | Yes | Containing 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 |
| checkoutStatus | Yes | A string containing the result of the PPRO APM Checkout process. This is not used to identify the transaction’s payment status. |