GET api/Payment/GetCheckoutSession?checkoutSessionId={checkoutSessionId}

Request Information

URI Parameters

Name	Description	Type	Additional information
checkoutSessionId		string	Required

Body Parameters

None.

Response Information

Resource Description

CheckoutSessionResponse

Name	Type	Additional information
storeId	string	None.
checkoutSessionId	string	None.
webCheckoutDetails	WebCheckoutDetails	None.
productType	string	None.
paymentDetails	PaymentDetails	None.
merchantMetadata	MerchantMetadata	None.
buyer	Buyer	None.
statusDetails	StatusDetails	None.
supplementaryData	string	None.
platformId	string	None.
providerMetadata	ProviderMetadata	None.
shippingAddress	Address	None.
billingAddress	Address	None.
paymentPreferences	Collection of PaymentPreferences	None.
constraints	Collection of Constraint	None.
creationTimestamp	date	None.
expirationTimestamp	date	None.
chargePermissionId	string	None.
chargeId	string	None.
deliverySpecifications	DeliverySpecifications	None.
releaseEnvironment	string	None.
chargePermissionType	ChargePermissionType	None.
recurringMetadata	RecurringMetadata	None.
Url	URI	None.
Method	HttpMethod	None.
RawRequest	string	None.
RawResponse	string	None.
RequestId	string	None.
Status	integer	None.
Retries	integer	None.
Duration	integer	None.
Success	boolean	None.
Headers	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "storeId": "sample string 1",
  "checkoutSessionId": "sample string 2",
  "webCheckoutDetails": {
    "checkoutReviewReturnUrl": "sample string 1",
    "checkoutResultReturnUrl": "sample string 2",
    "checkoutCancelUrl": "sample string 3",
    "amazonPayRedirectUrl": "sample string 4",
    "checkoutMode": "ProcessOrder"
  },
  "productType": "sample string 3",
  "paymentDetails": {
    "paymentIntent": "Confirm",
    "canHandlePendingAuthorization": true,
    "chargeAmount": null,
    "totalOrderAmount": null,
    "presentmentCurrency": "AUD",
    "allowOvercharge": true,
    "extendExpiration": true,
    "softDescriptor": "sample string 1",
    "estimateOrderTotal": null
  },
  "merchantMetadata": {
    "merchantReferenceId": "sample string 1",
    "merchantStoreName": "sample string 2",
    "noteToBuyer": "sample string 3",
    "customInformation": "sample string 4"
  },
  "buyer": {
    "buyerId": "sample string 1",
    "name": "sample string 2",
    "email": "sample string 3",
    "phoneNumber": "sample string 4",
    "primeMembershipTypes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "statusDetails": {
    "state": "sample string 1",
    "reasonCode": "sample string 2",
    "reasonDescription": "sample string 3",
    "lastUpdatedTimestamp": "2025-11-08T05:01:03.0399822-06:00"
  },
  "supplementaryData": "sample string 4",
  "platformId": "sample string 5",
  "providerMetadata": {
    "providerReferenceId": "sample string 1"
  },
  "shippingAddress": {
    "county": "sample string 1",
    "district": "sample string 2",
    "name": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "addressLine3": "sample string 6",
    "city": "sample string 7",
    "stateOrRegion": "sample string 8",
    "postalCode": "sample string 9",
    "countryCode": "sample string 10",
    "phoneNumber": "sample string 11"
  },
  "billingAddress": {
    "county": "sample string 1",
    "district": "sample string 2",
    "name": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "addressLine3": "sample string 6",
    "city": "sample string 7",
    "stateOrRegion": "sample string 8",
    "postalCode": "sample string 9",
    "countryCode": "sample string 10",
    "phoneNumber": "sample string 11"
  },
  "paymentPreferences": [
    {
      "paymentDescriptor": "sample string 1"
    },
    {
      "paymentDescriptor": "sample string 1"
    }
  ],
  "constraints": [
    {
      "constraintId": "sample string 1",
      "description": "sample string 2"
    },
    {
      "constraintId": "sample string 1",
      "description": "sample string 2"
    }
  ],
  "creationTimestamp": "2025-11-08T05:01:03.0399822-06:00",
  "expirationTimestamp": "2025-11-08T05:01:03.0399822-06:00",
  "chargePermissionId": "sample string 7",
  "chargeId": "sample string 8",
  "deliverySpecifications": {
    "specialRestrictions": [
      "RestrictPOBoxes",
      "RestrictPOBoxes"
    ],
    "addressRestrictions": {
      "type": "Allowed",
      "restrictions": {
        "sample string 1": {
          "statesOrRegions": [
            "sample string 1",
            "sample string 2"
          ],
          "zipCodes": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "sample string 2": {
          "statesOrRegions": [
            "sample string 1",
            "sample string 2"
          ],
          "zipCodes": [
            "sample string 1",
            "sample string 2"
          ]
        }
      }
    }
  },
  "releaseEnvironment": "sample string 9",
  "chargePermissionType": "OneTime",
  "recurringMetadata": {
    "frequency": {
      "unit": "Year",
      "value": 1
    },
    "amount": null
  },
  "url": "http://webapihelppage10.com",
  "method": 0,
  "rawRequest": "sample string 11",
  "rawResponse": "sample string 12",
  "requestId": "sample string 13",
  "status": 14,
  "retries": 15,
  "duration": 16,
  "success": false,
  "headers": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

text/html

Sample:

{"storeId":"sample string 1","checkoutSessionId":"sample string 2","webCheckoutDetails":{"checkoutReviewReturnUrl":"sample string 1","checkoutResultReturnUrl":"sample string 2","checkoutCancelUrl":"sample string 3","amazonPayRedirectUrl":"sample string 4","checkoutMode":"ProcessOrder"},"productType":"sample string 3","paymentDetails":{"paymentIntent":"Confirm","canHandlePendingAuthorization":true,"chargeAmount":null,"totalOrderAmount":null,"presentmentCurrency":"AUD","allowOvercharge":true,"extendExpiration":true,"softDescriptor":"sample string 1","estimateOrderTotal":null},"merchantMetadata":{"merchantReferenceId":"sample string 1","merchantStoreName":"sample string 2","noteToBuyer":"sample string 3","customInformation":"sample string 4"},"buyer":{"buyerId":"sample string 1","name":"sample string 2","email":"sample string 3","phoneNumber":"sample string 4","primeMembershipTypes":["sample string 1","sample string 2"]},"statusDetails":{"state":"sample string 1","reasonCode":"sample string 2","reasonDescription":"sample string 3","lastUpdatedTimestamp":"2025-11-08T05:01:03.0399822-06:00"},"supplementaryData":"sample string 4","platformId":"sample string 5","providerMetadata":{"providerReferenceId":"sample string 1"},"shippingAddress":{"county":"sample string 1","district":"sample string 2","name":"sample string 3","addressLine1":"sample string 4","addressLine2":"sample string 5","addressLine3":"sample string 6","city":"sample string 7","stateOrRegion":"sample string 8","postalCode":"sample string 9","countryCode":"sample string 10","phoneNumber":"sample string 11"},"billingAddress":{"county":"sample string 1","district":"sample string 2","name":"sample string 3","addressLine1":"sample string 4","addressLine2":"sample string 5","addressLine3":"sample string 6","city":"sample string 7","stateOrRegion":"sample string 8","postalCode":"sample string 9","countryCode":"sample string 10","phoneNumber":"sample string 11"},"paymentPreferences":[{"paymentDescriptor":"sample string 1"},{"paymentDescriptor":"sample string 1"}],"constraints":[{"constraintId":"sample string 1","description":"sample string 2"},{"constraintId":"sample string 1","description":"sample string 2"}],"creationTimestamp":"2025-11-08T05:01:03.0399822-06:00","expirationTimestamp":"2025-11-08T05:01:03.0399822-06:00","chargePermissionId":"sample string 7","chargeId":"sample string 8","deliverySpecifications":{"specialRestrictions":["RestrictPOBoxes","RestrictPOBoxes"],"addressRestrictions":{"type":"Allowed","restrictions":{"sample string 1":{"statesOrRegions":["sample string 1","sample string 2"],"zipCodes":["sample string 1","sample string 2"]},"sample string 2":{"statesOrRegions":["sample string 1","sample string 2"],"zipCodes":["sample string 1","sample string 2"]}}}},"releaseEnvironment":"sample string 9","chargePermissionType":"OneTime","recurringMetadata":{"frequency":{"unit":"Year","value":1},"amount":null},"url":"http://webapihelppage10.com","method":0,"rawRequest":"sample string 11","rawResponse":"sample string 12","requestId":"sample string 13","status":14,"retries":15,"duration":16,"success":false,"headers":{"sample string 1":"sample string 2","sample string 3":"sample string 4"}}

application/xml, text/xml

Sample:

<CheckoutSessionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Amazon.Pay.API.WebStore.CheckoutSession">
  <PlatformId>sample string 5</PlatformId>
  <StoreId>sample string 1</StoreId>
  <SupplementaryData>sample string 4</SupplementaryData>
</CheckoutSessionResponse>