(AutoIt) Amazon Pay - Create Checkout Session

See more Amazon Pay Examples

Create a new Amazon Pay Checkout Session.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#create-checkout-session

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Implements the following CURL command:

; curl "https://pay-api.amazon.com/:version/checkoutSessions/" \
; -X POST
; -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
; -H "x-amz-pay-date:20201012T235046Z"
; -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
; -d '{
;     "webCheckoutDetails": {
;         "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
;     },
;     "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
;     "scopes": ["name", "email", "phoneNumber", "billingAddress"],
;     "deliverySpecifications": {
;         "specialRestrictions": ["RestrictPOBoxes"],
;         "addressRestrictions": {
;             "type": "Allowed",
;             "restrictions": {
;                 "US": {
;                     "statesOrRegions": ["WA"],
;                     "zipCodes": ["95050", "93405"]
;                 },
;                 "GB": {
;                     "zipCodes": ["72046", "72047"]
;                 },
;                 "IN": {
;                     "statesOrRegions": ["AP"]
;                 },
;                 "JP": {}
;             }
;         }
;     }
; }'

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

; Use this online tool to generate code from sample JSON:
; Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "webCheckoutDetails": {
;     "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
;   },
;   "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
;   "scopes": [
;     "name",
;     "email",
;     "phoneNumber",
;     "billingAddress"
;   ],
;   "deliverySpecifications": {
;     "specialRestrictions": [
;       "RestrictPOBoxes"
;     ],
;     "addressRestrictions": {
;       "type": "Allowed",
;       "restrictions": {
;         "US": {
;           "statesOrRegions": [
;             "WA"
;           ],
;           "zipCodes": [
;             "95050",
;             "93405"
;           ]
;         },
;         "GB": {
;           "zipCodes": [
;             "72046",
;             "72047"
;           ]
;         },
;         "IN": {
;           "statesOrRegions": [
;             "AP"
;           ]
;         },
;         "JP": {}
;       }
;     }
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("webCheckoutDetails.checkoutReviewReturnUrl","https://a.com/merchant-review-page")
; Make sure to use your storeId here:
$oJson.UpdateString("storeId","amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId")
Local $i = 0
$oJson.I = $i
$oJson.UpdateString("scopes[i]","name")
$i = $i + 1
$oJson.I = $i
$oJson.UpdateString("scopes[i]","email")
$i = $i + 1
$oJson.I = $i
$oJson.UpdateString("scopes[i]","phoneNumber")
$i = $i + 1
$oJson.I = $i
$oJson.UpdateString("scopes[i]","billingAddress")
$oJson.UpdateString("deliverySpecifications.specialRestrictions[0]","RestrictPOBoxes")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.type","Allowed")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]","WA")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]","95050")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]","93405")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]","72046")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]","72047")
$oJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]","AP")
$oJson.UpdateNewObject("deliverySpecifications.addressRestrictions.restrictions.JP")

; 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
; x-amz-pay-idempotency-key
; Authorization

$oHttp.Accept = "application/json"

; To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
; Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
Local $oResp = $oHttp.PostJson3("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

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

; If the status code is not equal to 201, this will display error information.
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode <> 201) Then

    ; The jResp would've contained an error message, similar to this:
    ; 	{
    ; 	  "reasonCode": "InvalidHeaderValue",
    ; 	  "message": "The value AF2EGWREIPHV2S2TUFFBRDGM provided for PublicKeyId is invalid. Please verify that you are using the PublicKeyId in the correct region and environment."
    ; 	}

    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
;   },
;   "productType": "PayAndShip",
;   "chargePermissionType": "Recurring",
;   "recurringMetadata": {
;     "frequency": {
;       "unit": "Month",
;       "value": "1"
;     },
;     "amount": {
;       "amount": "30",
;       "currencyCode": "USD"
;     }
;   },
;   "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": null,
;   "billingAddress": null,
;   "paymentPreferences": [
;     null
;   ],
;   "statusDetails": {
;     "state": "Open",
;     "reasonCode": null,
;     "reasonDescription": null,
;     "lastUpdatedTimestamp": "20191015T204327Z"
;   },
;   "shippingAddress": null,
;   "platformId": null,
;   "chargePermissionId": null,
;   "chargeId": null,
;   "constraints": [
;     {
;       "constraintId": "BuyerNotAssociated",
;       "description": "There is no buyer associated with the Checkout Session. Return the checkout session id to the Amazon Pay Button to allow buyer to login."
;     },
;     {
;       "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 $bNullVal
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 $sProductType = $oJResp.StringOf("productType")
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 $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 $sBuyer = $oJResp.StringOf("buyer")
Local $sBillingAddress = $oJResp.StringOf("billingAddress")
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 $shippingAddress = $oJResp.StringOf("shippingAddress")
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")
$i = 0
Local $iCount_i = $oJResp.SizeOfArray("paymentPreferences")
While $i < $iCount_i
    $oJResp.I = $i
    $bNullVal = $oJResp.IsNullOf("paymentPreferences[i]")
    $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