Response Fields
Initial Response (Direct Integration)
The fields below will be returned, in addition to the request fields from Qi Digital Request Fields section and the Basic Response Fields section, minus any card details.
| Field Name | Mandatory? | Description |
|---|---|---|
| checkoutRef | Yes | Unique reference required to continue the transaction on completion of the Qi Digital Checkout |
| checkoutName | No[1]1 | Unique name of the required Qi Digital Checkout. |
| checkoutURL | Yes | URL required to load the Qi Digital Checkout. |
| checkoutRequest | No | Record containing any data that must be sent to the APM Checkout via a HTTP POST. If not provided, then the Checkout can be loaded via a HTTP GET. |
| acquirerResponseDetails | Yes | Record containing useful details about the Qi Digital transaction. |
Completion Response (Hosted and Direct Integration)
These fields will be returned, in addition to the request fields from the Qi Continuation Request Fields, the Qi Initial Response Fields and the Basic Response Fields section, minus any card details.
| Field Name | Mandatory? | Description |
|---|---|---|
| checkoutStatus | No[2]1 | A string containing the result of the Qi Digital Checkout process. |
[2] This field is currently not supported by Qi Digital but is reserved for future use.