| Parameter
|
Description
|
| checkoutSessionId Type: string |
Checkout Session identifier |
| webCheckoutDetail Type: webCheckoutDetail |
URLs associated to the Checkout Session used for completing checkout
|
| productType Type: string |
Amazon Pay integration type. You can not set this value via Checkout Session operations, you must set it using button productType parameter
|
| paymentDetail Type: paymentDetail |
Payment details specified by the merchant, such as the amount and method for charging the buyer
|
| merchantMetadata Type: merchantMetadata |
Merchant-provided order info
|
| platformId Type: string |
Merchant identifier of the Solution Provider (SP)- also known as ecommerce provider Only SPs should use this field |
| providerMetadata Type: providerMetadata |
Payment service provider (PSP)-provided order information Only PSPs should use these fields |
| buyer Type: buyer |
Details about the buyer, such as their unique identifier, name, and email This info will only be returned for a Checkout Session in the Open state |
| shippingAddress Type: address |
Shipping address selected by the buyer
|
| paymentPreferences Type: list<paymentPreferences> |
List of payment instruments selected by the buyer
|
| statusDetail Type: statusDetail |
State of the Checkout Session object
|
| constraints Type: list<constraint> |
Constraints that must be addressed to complete Amazon Pay checkout
|
| creationTimestamp Type: dateTime |
Universal Time Coordinated (UTC) date and time when the Checkout Session was created in ISO 8601 format
|
| expirationTimestamp Type: dateTime |
UTC date and time when the Checkout Session will expire in ISO 8601 format
|
| chargePermissionId Type: string |
Charge permission identifier returned after Checkout Session is complete Used for creating charges for deferred transactions |
| chargeId Type: string |
Charge identifier returned after Checkout Session is complete Used for processing refunds |
| storeId Type: string |
Login with Amazon client ID. Do not use the application ID Retrieve this value from "Login with Amazon" in Seller Central |
| deliverySpecifications Type: deliverySpecifications |
Specify shipping restrictions to prevent buyers from selecting unsupported addresses from their Amazon address book
|
| releaseEnvironment Type: string |
The environment the Checkout Session object was created in (either Sandbox or Live)
|
| checkoutButtonText Type: string |
Amazon Pay-provided button text for buyers who have chosen Affirm as payment instrument. For all other use cases, this value will be null
|
| Parameter
|
Description
|
| checkoutReviewReturnUrl Type: string |
Checkout review URL provided by the merchant. Amazon Pay will redirect to this URL after the buyer selects their preferred payment instrument and shipping address Note: In the Live environment, URLs must use HTTPS protocol. In Sandbox environment, you don't need a SSL certificate and can use the HTTP protocol Max length: 1024 characters |
| checkoutResultReturnUrl Type: string |
Checkout result URL provided by the merchant. Amazon Pay will redirect to this URL after completing the transaction Note: In the Live environment, URLs must use HTTPS protocol. In Sandbox environment, you don't need a SSL certificate and can use the HTTP protocol Max length: 1024 characters |
| amazonPayRedirectUrl Type: string |
URL provided by Amazon Pay. Merchant will redirect to this page after setting transaction details to complete checkout Max length: 256 characters |
| Parameter
|
Description
|
| specialRestrictions Type: list<string> |
Rule-based restrictions Note: Amazon will only validate this value in Sandbox. This parameter is ignored in the Live environment if an unsupported value is used Supported values:
|
| addressRestrictions Type: addressRestrictions |
Country-based restrictions |
| Parameter
|
Description
|
| type Type: string |
Specifies whether addresses that match restrictions configuration should or should not be restricted Note: Amazon will only validate this value in Sandbox. This parameter is ignored in the Live environment if an unsupported value is used Supported values: 'Allowed' - Mark addresses that don't match restrictions configuration as restricted 'NotAllowed' - Mark addresses that match restrictions configuration as restricted |
| restrictions Type: hash<countryCode:restriction> |
Hash of country-level restrictions that determine which addresses should or should not be restricted based on addressRestrictions.type parameter.CountryCode is a string that represents the country code of the address in ISO 3166 format. Amazon will only validate CountryCode in Sandbox. CountryCode is ignored in the Live environment if an unsupported value is used |
| Parameter
|
Description
|
| statesOrRegions Type: list<string> |
List of country-specific states that should or should not be restricted based on addressRestrictions.type parameterNote:
|
| zipCodes Type: list<string> |
List of country-specific zip codes that should or should not be restricted based on addressRestrictions.type parameter |
| Parameter
|
Description
|
| paymentIntent Type: string |
Payment flow for charging the buyer Possible values: Confirm or Authorize |
| canHandlePendingAuthorization Type: boolean |
Boolean that indicates whether merchant can handle pending response See asynchronous processing for more info |
| chargeAmount Type: price |
Transaction amount
|
| presentmentCurrency Type: string |
The currency that the buyer will be charged in ISO 4217 format. Example: USD See multi-currency integration for more info |
| Parameter
|
Description
|
| amount Type: string |
Transaction amount
|
| currencyCode Type: string |
Transaction currency code in ISO 4217 format Example: USD |
| Parameter
|
Description
|
| providerReferenceId Type: string |
Payment service provider (PSP)-provided order identifier Only PSPs should use these fields |
| Parameter
|
Description
|
| merchantReferenceId Type: string |
External merchant order identifier. The merchant order identifier is shared in buyer communication and in the buyer transaction history on the Amazon Pay website Max length: 256 characters |
| merchantStoreName Type: string |
Merchant store name. Setting this parameter will override the default value configured in Seller Central (the account management tool for merchants). The store name is shared in buyer communication and in the buyer transaction history on the Amazon Pay website Max length: 50 characters |
| noteToBuyer Type: string |
Description of the order that is shared in buyer communication You should not store sensitive data about the buyer or the transaction in this field Max length: 255 characters |
| customInformation Type: string |
Custom info for the order. This data is not shared in any buyer communication You should not store sensitive data about the buyer or the transaction in this field Max length: 4096 characters |
| Parameter
|
Description
|
| buyerId Type: string |
Unique Amazon Pay buyer identifier
|
| name Type: string |
Buyer name
|
| email Type: string |
Buyer email address
|
| Parameter
|
Description
|
| paymentDescriptor Type: string |
Amazon Pay-provided description for buyer-selected payment instrument
|
| billingAddress Type: address |
Billing address for buyer-selected payment instrument. Billing address is only available in EU or for PayOnly product type
|
| Parameter
|
Description
|
| name Type: string |
Address name Max length: 50 characters |
| addressLine1 Type: string |
The first line of the address Max length: 180 characters |
| addressLine2 Type: string |
The second line of the address Max length: 60 characters |
| addressLine3 Type: string |
The third line of the address Max length: 60 characters |
| city Type: string |
City of the address Max length: 50 characters |
| county Type: string |
County of the address Max length: 50 characters |
| district Type: string |
District of the address Max length: 50 characters |
| stateOrRegion Type: string |
The state or region:
|
| postalCode Type: string |
Postal code of the address Max length: 20 characters |
| countryCode Type: string |
Country code of the address in ISO 3166 format Max length: 3 characters |
| phoneNumber Type: string |
Phone number Max length: 20 characters |
| Parameter
|
Description
|
| state Type: string |
Current object state
|
| reasonCode Type: string |
Reason code for current state
|
| reasonDescription Type: string |
An optional description of the Checkout Session state
|
| lastUpdatedTimestamp Type: dateTime |
UTC date and time when the state was last updated in ISO 8601 format
|
| Parameter
|
Description
|
| constraintId Type: string |
Code for any Checkout Session constraint
|
| description Type: string |
Description of the Checkout Session constraint
|
| Constraint Code
|
Description
|
| CheckoutResultReturnUrlNotSet
|
checkoutResultReturnURL has not been set on the Checkout Session
|
| ChargeAmountNotSet
|
chargeAmount has not been set on the Checkout Session
|
| PaymentIntentNotSet
|
paymentIntent has not been set on the Checkout Session
|
| BuyerNotAssociated
|
Buyer-preferred payment instrument or shipping address has not been set on the Checkout Session |
| State
|
Description
|
Reason code
|
| Open
|
The initial Checkout Session state. Checkout Session state will return missing value constraints, until mandatory fields are provided by the merchant using Update Checkout Session. After all constraints have been removed, the merchant will redirect the buyer to the AmazonPayRedirectUrl to complete checkout. The Checkout Session state will then move to either Completed or Canceled state Note that the Checkout Session will move to Canceled state if the buyer doesn't complete checkout within 24 hours Allowed operation(s): GET Checkout Session UPDATE Checkout Session |
-
|
| Completed
|
Checkout was successfully completed. The buyer was redirected to the AmazonPayRedirectUrl and payment intent was successfully completed. The Checkout Session can no longer be used to perform another payment, or retry a chargeNote: if you set canHandlePendingAuthorization to true, the Checkout Session state will be in a Completed state, even though the Authorization might later fail. See asynchronous processing for more infoAllowed operation(s): GET Checkout Session (will return Charge Permission ID, Charge ID, and other Checkout Session details). |
-
|
| Canceled
|
Checkout was not successfully completed due to either buyer abandoment or payment decline. The payment intent was not successfully completed Allowed operation(s): GET CheckoutSession (will only return state and reasonCode) |
BuyerCanceled - The buyer canceled the checkout by clicking the Return to previous page button Expired - The Checkout Session expired 24 hour after creation because there was no redirect to the amazonPayRedirectUrl or buyer did not complete payment AmazonCanceled - Amazon has canceled the transaction due to service unavailability. This is not a payment associated cancelation Declined - Generic payment decline reason code that includes fraud declines, failure to complete multi-factor authentication (MFA) challenge, and issues with the payment instrument |
| Name
|
Location
|
Description
|
| x-amz-pay-idempotency-key (required) Type: string |
Header
|
Idempotency key to safely retry requests
|
| webCheckoutDetail (required) Type: webCheckoutDetail |
Body
|
Checkout result URL provided by the merchant. Amazon Pay will redirect to this URL after completing the transaction Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl |
| storeId (required) Type: string |
Body
|
Login with Amazon client ID. Do not use the application ID Retrieve this value from "Login with Amazon" in Seller Central |
| deliverySpecifications Type: deliverySpecifications |
Body
|
Specify shipping restrictions and limit which addresses your buyer can select from their Amazon address book
|
| paymentDetail Type: paymentDetail |
Body
|
Payment details specified by the merchant such as the amount and method for charging the buyer Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl
|
| merchantMetadata Type: merchantMetadata |
Body
|
External order details provided by the merchant Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl
|
| platformId Type: string |
Body
|
Merchant identifier of the Solution Provider (SP). Only SPs should use this field. Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl.
|
| providerMetadata Type: providerMetadata |
Body
|
Payment service provider (PSP)-provided order details Only PSPs should use these fields |
| Name
|
Location
|
Description
|
| CheckoutSessionId (required) Type: string |
Path Parameter
|
Checkout session identifier
|
| HTTP status code
|
Reason code
|
Description
|
404 NOT_FOUND |
ResourceNotFound |
Checkout Session details are permanently deleted after 30 days. Any request on the Checkout Session will return this error code
|
| Name
|
Location
|
Description
|
| checkoutSessionId (required) Type: string |
Path parameter
|
Checkout Session identifier
|
| webCheckoutDetail Type: webCheckoutDetail |
Body
|
Checkout result URL provided by the merchant. Amazon Pay will redirect to this URL after completing the transaction Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl |
| paymentDetail Type: paymentDetail |
Body
|
Payment details specified by the merchant such as the amount and method for charging the buyer Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl
|
| merchantMetadata Type: merchantMetadata |
Body
|
External order details provided by the merchant Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl
|
| platformId Type: string |
Body
|
Merchant identifier of the Solution Provider (SP). Only SPs should use this field. Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl.
|
| providerMetadata Type: providerMetadata |
Body
|
Transaction identifier created by the Payment Service Provider (PSP) Only PSPs should use these fields Modifiable: Multiple times before the buyer is redirected to the amazonPayReturnUrl
|
| HTTP status code
|
Reason code
|
Description
|
404 NOT_FOUND |
ResourceNotFound |
Checkout Session details are permanently deleted after 30 days. Any request on the Checkout Session will return this error code
|
422 UNPROCESSABLE_ENTITY |
InvalidCheckoutSessionStatus
|
You tried to call an operation on a Checkout Session that is in a state where that operation is not allowed
|