Response Fields
Initial Response (Direct Integration)
These fields will be returned in addition to the Amazon Pay Initial Response Fields and the Basic Response Fields minus any card details.
| Field Name | Mandatory? | Description |
|---|---|---|
| checkoutRef | Yes | Unique reference required to continue the transaction on completion of the Amazon Pay Checkout. |
| checkoutName | Yes | Unique name of the required Amazon Pay Checkout. Currently the only supported value is ‘amazonpay’. |
| checkoutURL | Yes | URL required to load the Amazon Pay JavaScript Widgets. |
| checkoutRequest | No | Record containing data required for the Amazon Pay Widgets such as: · merchantID – Amazon Pay merchant id · clientID – Amazon Pay client id · sandbox – true if Amazon Pay sandbox · region – Amazon Pay API region code · scope – Login Widget scope parameter |
| checkoutOptions | No | Record containing any checkoutOptions passed in the request or added by the Gateway. |
| acquirerResponseDetails | Yes | Record containing details about the Amazon Pay response containing any error messages and codes. This can be used together with the normal responseCode and responseMessage response fields to further determine the reason for any failure. |
Continuation Response (Direct Integration)
These fields will be returned in addition to the Amazon Pay Continuation Request Fields, the Amazon Pay Initial Response Fields the Basic Response Fields minus any card details.
| Field Name | Mandatory? | Description |
|---|---|---|
| checkoutRef | Yes | Provided if checkoutOnly was used in the continuation response to indicate that a further request will be sent to finalise the transaction. |
| checkoutDetails | Yes | Record containing values made available by the Amazon Pay Checkout. Refer here. |
| customer_XXXX_ | No[1] | Customer details if provided by the Amazon Pay Checkout as detailed here. |
| delivery_XXXX_ | No[1] | Delivery details if provided by the Amazon Pay Checkout as detailed here |
| receiver_XXXX_ | No | Buyer details if provided by Amazon Pay as detailed here. Amazon Pay will usually provide the buyer’s name, postcode and email only, which are returned in the receiverName, receiverPostcode and receiverEmail fields accordingly |
| acquirerResponseDetails | Yes | Record containing details about the Amazon Pay response containing any error messages and codes. This can be used together with the normal responseCode and responseMessage response fields to further determine the reason for any failure. |
Checkout Details (Hosted and Direct Integration)
The checkoutDetails field included in the response above will contain the following values and any further values received from Amazon Pay allowing the Merchant to see the full Amazon Pay order information. The details will be returned using the record format.
| Sub-Field Name | Mandatory? | Description |
|---|---|---|
| referenceID | No | Amazon Pay reference id. Either the orderReferenceID or the billingReferenceID where appropriate. |
| accessToken | No | Amazon Pay order reference id as sent in the continuation request checkoutResponse data. |
| bilingAgreementID | No | Amazon Pay order reference id as sent in the continuation request checkoutResponse data. |
| orderReferenceID | No | Amazon Pay order reference id as sent in the continuation request checkoutResponse data. |