Sample code for 30+ languages & platforms
AutoIt

Amazon Pay - Get Checkout Session

See more Amazon Pay Examples

Get Checkout Session details includes buyer info, payment instrument details, and shipping address.

Chilkat AutoIt Downloads

AutoIt
Local $bSuccess = False

;  This example assumes the Chilkat API to have been previously unlocked.
;  See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")

;  Implements the following CURL command:

;  curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId"
;    -X GET
;    -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
;    -H "x-amz-pay-date:20201012T235046Z"

;  Use the following online tool to generate HTTP code from a CURL command
;  Convert a cURL Command to HTTP Source Code

;  Load your Amazon Pay private key.  
;  There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
;  or from in-memory strings or bytes.
$oPrivKey = ObjCreate("Chilkat.PrivateKey")
$bSuccess = $oPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If ($bSuccess = False) Then
    ConsoleWrite($oPrivKey.LastErrorText & @CRLF)
    Exit
EndIf

;  Provide your Amazon Pay private key and Public Key ID 
;  Use your public key ID here.  It must be the one associated with the private key.
;  Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
Local $sPublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
$bSuccess = $oHttp.SetAuthPrivateKey($sPublicKeyId,$oPrivKey)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

;  Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
;  and will also sign the request.  Nothing more is needed.
;  Chilkat automatically generates and adds the following headers:
;  
;  x-amz-pay-date
;  x-amz-pay-host
;  x-amz-pay-region
;  Authorization

$oHttp.Accept = "application/json"

Local $iRespStatusCode = 0

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.SetUrlVar("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b")
;  To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
;  Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
$bSuccess = $oHttp.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",$oSbResponseBody)
If ($bSuccess = False) Then
    ;  If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    $iRespStatusCode = $oHttp.LastStatus
    If ($iRespStatusCode <> 0) Then
        ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
        ;  A sample response body for the case where the session ID does not exist:
        ;  {"reasonCode":"ResourceNotFound","message":"Resource you are trying to access is not available. Requested path '/sandbox/v2/checkoutSessions/bd504926-f659-4ad7-a1a9-9a747aaf5275'"}

        ConsoleWrite("Response body:" & @CRLF)
        ConsoleWrite($oHttp.LastResponseBody & @CRLF)
    Else
        ConsoleWrite($oHttp.LastErrorText & @CRLF)
    EndIf

    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

$iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
;  We expect a 200 status code for success.
;  Note: Some Amazon Pay API calls return 200 for success, others return 201.
If ($iRespStatusCode <> 200) Then
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

;  Sample JSON response:
;  (Sample code for parsing the JSON response is shown below)

;  {
;    "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
;    "webCheckoutDetails": {
;      "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
;      "checkoutResultReturnUrl": null,
;      "checkoutCancelUrl": null,
;      "amazonPayRedirectUrl": null
;    },
;    "chargePermissionType": "Recurring",
;    "recurringMetadata": {
;      "frequency": {
;        "unit": "Month",
;        "value": "1"
;      },
;      "amount": {
;        "amount": "30",
;        "currencyCode": "USD"
;      }
;    },
;    "productType": "PayAndShip",
;    "paymentDetails": {
;      "paymentIntent": null,
;      "canHandlePendingAuthorization": false,
;      "chargeAmount": null,
;      "totalOrderAmount": null,
;      "softDescriptor": null,
;      "presentmentCurrency": null,
;      "allowOvercharge": null,
;      "extendExpiration": null
;    },
;    "merchantMetadata": {
;      "merchantReferenceId": null,
;      "merchantStoreName": null,
;      "noteToBuyer": null,
;      "customInformation": null
;    },
;    "supplementaryData": null,
;    "buyer": {
;      "buyerId": "buyerId",
;      "name": "name-1",
;      "email": "name@amazon.com",
;      "phoneNumber": "800-000-0000",
;      "primeMembershipTypes": null
;    },
;    "billingAddress": {
;      "name": "Work",
;      "addressLine1": "440 Terry Ave",
;      "addressLine2": "",
;      "addressLine3": "",
;      "city": "Seattle",
;      "county": "King",
;      "district": "Seattle",
;      "stateOrRegion": "WA",
;      "postalCode": "98121",
;      "countryCode": "US"
;    },
;    "paymentPreferences": [
;      {
;        "paymentDescriptor": "Your selected Amazon payment method"
;      }
;    ],
;    "statusDetails": {
;      "state": "Open",
;      "reasonCode": null,
;      "reasonDescription": null,
;      "lastUpdatedTimestamp": "20191015T204327Z"
;    },
;    "shippingAddress": {
;      "name": "Susie Smith",
;      "addressLine1": "10 Ditka Ave",
;      "addressLine2": "Suite 2500",
;      "addressLine3": null,
;      "city": "Chicago",
;      "county": null,
;      "district": null,
;      "stateOrRegion": "IL",
;      "postalCode": "60602",
;      "countryCode": "US",
;      "phoneNumber": "800-000-0000"
;    },
;    "platformId": null,
;    "chargePermissionId": null,
;    "chargeId": null,
;    "constraints": [
;      {
;        "constraintId": "ChargeAmountNotSet",
;        "description": "chargeAmount is not set."
;      },
;      {
;        "constraintId": "CheckoutResultReturnUrlNotSet",
;        "description": "checkoutResultReturnUrl is not set."
;      },
;      {
;        "constraintId": "PaymentIntentNotSet",
;        "description": "paymentIntent is not set."
;      }
;    ],
;    "creationTimestamp": "20191015T204313Z",
;    "expirationTimestamp": "20191016T204313Z",
;    "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
;    "deliverySpecifications": {
;      "specialRestrictions": [
;        "RestrictPOBoxes"
;      ],
;      "addressRestrictions": {
;        "type": "Allowed",
;        "restrictions": {
;          "US": {
;            "statesOrRegions": [
;              "WA"
;            ],
;            "zipCodes": [
;              "95050",
;              "93405"
;            ]
;          },
;          "GB": {
;            "zipCodes": [
;              "72046",
;              "72047"
;            ]
;          },
;          "IN": {
;            "statesOrRegions": [
;              "AP"
;            ]
;          },
;          "JP": {}
;        }
;      }
;    },
;    "providerMetadata": {
;      "providerReferenceId": null
;    },
;    "releaseEnvironment": "Sandbox"
;  }

;  Sample code for parsing the JSON response...
;  Use the following online tool to generate parsing code from sample JSON:
;  Generate Parsing Code from JSON

Local $sPaymentDescriptor
Local $sConstraintId
Local $sDescription
Local $strVal

Local $sCheckoutSessionId = $oJResp.StringOf("checkoutSessionId")
Local $sWebCheckoutDetailsCheckoutReviewReturnUrl = $oJResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
Local $sWebCheckoutDetailsCheckoutResultReturnUrl = $oJResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
Local $sWebCheckoutDetailsCheckoutCancelUrl = $oJResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
Local $sWebCheckoutDetailsAmazonPayRedirectUrl = $oJResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
Local $sChargePermissionType = $oJResp.StringOf("chargePermissionType")
Local $sRecurringMetadataFrequencyUnit = $oJResp.StringOf("recurringMetadata.frequency.unit")
Local $sRecurringMetadataFrequencyValue = $oJResp.StringOf("recurringMetadata.frequency.value")
Local $sRecurringMetadataAmountAmount = $oJResp.StringOf("recurringMetadata.amount.amount")
Local $sRecurringMetadataAmountCurrencyCode = $oJResp.StringOf("recurringMetadata.amount.currencyCode")
Local $sProductType = $oJResp.StringOf("productType")
Local $sPaymentDetailsPaymentIntent = $oJResp.StringOf("paymentDetails.paymentIntent")
Local $bPaymentDetailsCanHandlePendingAuthorization = $oJResp.BoolOf("paymentDetails.canHandlePendingAuthorization")
Local $sPaymentDetailsChargeAmount = $oJResp.StringOf("paymentDetails.chargeAmount")
Local $sPaymentDetailsTotalOrderAmount = $oJResp.StringOf("paymentDetails.totalOrderAmount")
Local $sPaymentDetailsSoftDescriptor = $oJResp.StringOf("paymentDetails.softDescriptor")
Local $sPaymentDetailsPresentmentCurrency = $oJResp.StringOf("paymentDetails.presentmentCurrency")
Local $sPaymentDetailsAllowOvercharge = $oJResp.StringOf("paymentDetails.allowOvercharge")
Local $sPaymentDetailsExtendExpiration = $oJResp.StringOf("paymentDetails.extendExpiration")
Local $sMerchantMetadataMerchantReferenceId = $oJResp.StringOf("merchantMetadata.merchantReferenceId")
Local $sMerchantMetadataMerchantStoreName = $oJResp.StringOf("merchantMetadata.merchantStoreName")
Local $sMerchantMetadataNoteToBuyer = $oJResp.StringOf("merchantMetadata.noteToBuyer")
Local $sMerchantMetadataCustomInformation = $oJResp.StringOf("merchantMetadata.customInformation")
Local $supplementaryData = $oJResp.StringOf("supplementaryData")
Local $sBuyerBuyerId = $oJResp.StringOf("buyer.buyerId")
Local $sBuyerName = $oJResp.StringOf("buyer.name")
Local $sBuyerEmail = $oJResp.StringOf("buyer.email")
Local $sBuyerPhoneNumber = $oJResp.StringOf("buyer.phoneNumber")
Local $sBuyerPrimeMembershipTypes = $oJResp.StringOf("buyer.primeMembershipTypes")
Local $sBillingAddressName = $oJResp.StringOf("billingAddress.name")
Local $sBillingAddressAddressLine1 = $oJResp.StringOf("billingAddress.addressLine1")
Local $sBillingAddressAddressLine2 = $oJResp.StringOf("billingAddress.addressLine2")
Local $sBillingAddressAddressLine3 = $oJResp.StringOf("billingAddress.addressLine3")
Local $sBillingAddressCity = $oJResp.StringOf("billingAddress.city")
Local $sBillingAddressCounty = $oJResp.StringOf("billingAddress.county")
Local $sBillingAddressDistrict = $oJResp.StringOf("billingAddress.district")
Local $sBillingAddressStateOrRegion = $oJResp.StringOf("billingAddress.stateOrRegion")
Local $sBillingAddressPostalCode = $oJResp.StringOf("billingAddress.postalCode")
Local $sBillingAddressCountryCode = $oJResp.StringOf("billingAddress.countryCode")
Local $statusDetailsState = $oJResp.StringOf("statusDetails.state")
Local $statusDetailsReasonCode = $oJResp.StringOf("statusDetails.reasonCode")
Local $statusDetailsReasonDescription = $oJResp.StringOf("statusDetails.reasonDescription")
Local $statusDetailsLastUpdatedTimestamp = $oJResp.StringOf("statusDetails.lastUpdatedTimestamp")
Local $shippingAddressName = $oJResp.StringOf("shippingAddress.name")
Local $shippingAddressAddressLine1 = $oJResp.StringOf("shippingAddress.addressLine1")
Local $shippingAddressAddressLine2 = $oJResp.StringOf("shippingAddress.addressLine2")
Local $shippingAddressAddressLine3 = $oJResp.StringOf("shippingAddress.addressLine3")
Local $shippingAddressCity = $oJResp.StringOf("shippingAddress.city")
Local $shippingAddressCounty = $oJResp.StringOf("shippingAddress.county")
Local $shippingAddressDistrict = $oJResp.StringOf("shippingAddress.district")
Local $shippingAddressStateOrRegion = $oJResp.StringOf("shippingAddress.stateOrRegion")
Local $shippingAddressPostalCode = $oJResp.StringOf("shippingAddress.postalCode")
Local $shippingAddressCountryCode = $oJResp.StringOf("shippingAddress.countryCode")
Local $shippingAddressPhoneNumber = $oJResp.StringOf("shippingAddress.phoneNumber")
Local $sPlatformId = $oJResp.StringOf("platformId")
Local $sChargePermissionId = $oJResp.StringOf("chargePermissionId")
Local $sChargeId = $oJResp.StringOf("chargeId")
Local $sCreationTimestamp = $oJResp.StringOf("creationTimestamp")
Local $sExpirationTimestamp = $oJResp.StringOf("expirationTimestamp")
Local $storeId = $oJResp.StringOf("storeId")
Local $sDeliverySpecificationsAddressRestrictionsType = $oJResp.StringOf("deliverySpecifications.addressRestrictions.type")
Local $sProviderMetadataProviderReferenceId = $oJResp.StringOf("providerMetadata.providerReferenceId")
Local $sReleaseEnvironment = $oJResp.StringOf("releaseEnvironment")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("paymentPreferences")
While $i < $iCount_i
    $oJResp.I = $i
    $sPaymentDescriptor = $oJResp.StringOf("paymentPreferences[i].paymentDescriptor")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("constraints")
While $i < $iCount_i
    $oJResp.I = $i
    $sConstraintId = $oJResp.StringOf("constraints[i].constraintId")
    $sDescription = $oJResp.StringOf("constraints[i].description")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("deliverySpecifications.specialRestrictions")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("deliverySpecifications.specialRestrictions[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
    $i = $i + 1
Wend