Skip to main content

Request Fields

Initial Request (Hosted and Direct Integration)​

These fields should be sent in addition to the Basic Request Fields excluding any card details.

Field NameMandatory?Description
paymentMethodYes[1]Must be the value ‘amazonpay’ in lower case only.
checkoutRedirectURLNo[2]Reserved for future use.
checkoutOptionsNo[3]Record containing options used to customise the Amazon Pay Checkout. Refer here.
amazonPayCheckoutOptionsNo[4]Record containing options used to customise the Amazon Pay Checkout. Refer here.

Continuation Request (Direct Integration)​

These fields may be sent alone[5][5].

Field NameMandatory?Description
checkoutRefYesUnique reference return in the initial response.
checkoutResponseYesThe data received from the Amazon Pay Checkout Widgets together with a status value.
checkoutOnlyNoPass Y to complete the processing as far as the next Checkout stage and then return with the loaded Checkout details.

Checkout Options (Hosted and Direct Integration)​

The following options may be sent in the amazonPayCheckoutOptions Hosted Integration field or the checkoutOptions Direct Integration field to customise the Amazon Pay Checkout. The options must be formatted using the record or serialised record formats.

Sub-Field NameDescription
billingAgreementRequiredCan be used to specify that a billing agreement must be started. Alternatively, the rtAgreementType standard integration field can be used with a value of ‘recurring’ or ‘instalment’.
shippingAddressRequiredIndication that the shipping address is required, and the Address Checkout Widget will be used.
sellerOrderIDThe Merchant specified identifier for this order. If not sent, then any value in the merchantOrderRef standard integration field is used.
sellerNoteRepresents a description of the order that is displayed in emails to the buyer.
sellerAuthorizationNoteA description for the authorisation transaction that is shown in emails to the buyer.
sellerCaptureNoteA description for the capture that is displayed in emails to the buyer.
sellerBillingAgreementIDThe Merchant specified identifier for this billing agreement. If not sent, then any value in the rtPolicyRef standard integration field is used.
customInformationAny additional information that you want to include with this order reference
supplementaryDataSupplementary data.
softDescriptorThe description to be shown on the buyer's payment statement
billingAgreementRequiredCan be used to specify that a billing agreement must be started. Alternatively, the rtAgreementType standard integration field can be used with a value of ‘recurring’ or ‘instalment’.
shippingAddressRequiredIndication that the shipping address is required, and the Address Checkout Widget will be used.

For further information on the options refer to the Amazon Pay API Reference Guide: https://pay.amazon.com/us/developer/documentation/apireference/201751630

Footnotes

  1. Optional for Hosted Integration.
  2. Not required for Hosted Integration.
  3. Direct Integration Only.
  4. Hosted Integration Only.
  5. See note below.