Skip to main content

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 NameMandatory?Description
checkoutRefYesUnique reference required to continue the transaction on completion of the Amazon Pay Checkout.
checkoutNameYes

Unique name of the required Amazon Pay Checkout.

Currently the only supported value is ‘amazonpay’.

checkoutURLYesURL required to load the Amazon Pay JavaScript Widgets.
checkoutRequestNo

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

checkoutOptionsNoRecord containing any checkoutOptions passed in the request or added by the Gateway.
acquirerResponseDetailsYesRecord 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 NameMandatory?Description
checkoutRefYesProvided if checkoutOnly was used in the continuation response to indicate that a further request will be sent to finalise the transaction.
checkoutDetailsYesRecord 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_NoBuyer 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
acquirerResponseDetailsYesRecord 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 NameMandatory?Description
referenceIDNoAmazon Pay reference id. Either the orderReferenceID or the billingReferenceID where appropriate.
accessTokenNoAmazon Pay order reference id as sent in the continuation request checkoutResponse data.
bilingAgreementIDNoAmazon Pay order reference id as sent in the continuation request checkoutResponse data.
orderReferenceIDNoAmazon Pay order reference id as sent in the continuation request checkoutResponse data.

Footnotes

  1. The response will include Customer/billing address and delivery address details if provided by the Amazon Pay Checkout.