(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# 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": {}
#       }
#     }
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "webCheckoutDetails.checkoutReviewReturnUrl" "https://a.com/merchant-review-page"
# Make sure to use your storeId here:
CkJsonObject_UpdateString $json "storeId" "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId"
set i 0
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "scopes[i]" "name"
set i [expr $i + 1]
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "scopes[i]" "email"
set i [expr $i + 1]
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "scopes[i]" "phoneNumber"
set i [expr $i + 1]
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "scopes[i]" "billingAddress"
CkJsonObject_UpdateString $json "deliverySpecifications.specialRestrictions[0]" "RestrictPOBoxes"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.type" "Allowed"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]" "WA"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]" "95050"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]" "93405"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]" "72046"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]" "72047"
CkJsonObject_UpdateString $json "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]" "AP"
CkJsonObject_UpdateNewObject $json "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.
set privKey [new_CkPrivateKey]

set success [CkPrivateKey_LoadPemFile $privKey "C:/someDir/myAmazonPayPrivateKey.pem"]
if {$success == 0} then {
    puts [CkPrivateKey_lastErrorText $privKey]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkPrivateKey $privKey
    exit
}

# 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
set publicKeyId "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
set success [CkHttp_SetAuthPrivateKey $http $publicKeyId $privKey]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkPrivateKey $privKey
    exit
}

# 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

CkHttp_put_Accept $http "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
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkPrivateKey $privKey
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

# If the status code is not equal to 201, this will display error information.
puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode != 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."
    # 	}

    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkPrivateKey $privKey
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set checkoutSessionId [CkJsonObject_stringOf $jResp "checkoutSessionId"]
set webCheckoutDetailsCheckoutReviewReturnUrl [CkJsonObject_stringOf $jResp "webCheckoutDetails.checkoutReviewReturnUrl"]
set webCheckoutDetailsCheckoutResultReturnUrl [CkJsonObject_stringOf $jResp "webCheckoutDetails.checkoutResultReturnUrl"]
set webCheckoutDetailsCheckoutCancelUrl [CkJsonObject_stringOf $jResp "webCheckoutDetails.checkoutCancelUrl"]
set webCheckoutDetailsAmazonPayRedirectUrl [CkJsonObject_stringOf $jResp "webCheckoutDetails.amazonPayRedirectUrl"]
set productType [CkJsonObject_stringOf $jResp "productType"]
set chargePermissionType [CkJsonObject_stringOf $jResp "chargePermissionType"]
set recurringMetadataFrequencyUnit [CkJsonObject_stringOf $jResp "recurringMetadata.frequency.unit"]
set recurringMetadataFrequencyValue [CkJsonObject_stringOf $jResp "recurringMetadata.frequency.value"]
set recurringMetadataAmountAmount [CkJsonObject_stringOf $jResp "recurringMetadata.amount.amount"]
set recurringMetadataAmountCurrencyCode [CkJsonObject_stringOf $jResp "recurringMetadata.amount.currencyCode"]
set paymentDetailsPaymentIntent [CkJsonObject_stringOf $jResp "paymentDetails.paymentIntent"]
set paymentDetailsCanHandlePendingAuthorization [CkJsonObject_BoolOf $jResp "paymentDetails.canHandlePendingAuthorization"]
set paymentDetailsChargeAmount [CkJsonObject_stringOf $jResp "paymentDetails.chargeAmount"]
set paymentDetailsTotalOrderAmount [CkJsonObject_stringOf $jResp "paymentDetails.totalOrderAmount"]
set paymentDetailsSoftDescriptor [CkJsonObject_stringOf $jResp "paymentDetails.softDescriptor"]
set paymentDetailsPresentmentCurrency [CkJsonObject_stringOf $jResp "paymentDetails.presentmentCurrency"]
set paymentDetailsAllowOvercharge [CkJsonObject_stringOf $jResp "paymentDetails.allowOvercharge"]
set paymentDetailsExtendExpiration [CkJsonObject_stringOf $jResp "paymentDetails.extendExpiration"]
set merchantMetadataMerchantReferenceId [CkJsonObject_stringOf $jResp "merchantMetadata.merchantReferenceId"]
set merchantMetadataMerchantStoreName [CkJsonObject_stringOf $jResp "merchantMetadata.merchantStoreName"]
set merchantMetadataNoteToBuyer [CkJsonObject_stringOf $jResp "merchantMetadata.noteToBuyer"]
set merchantMetadataCustomInformation [CkJsonObject_stringOf $jResp "merchantMetadata.customInformation"]
set supplementaryData [CkJsonObject_stringOf $jResp "supplementaryData"]
set buyer [CkJsonObject_stringOf $jResp "buyer"]
set billingAddress [CkJsonObject_stringOf $jResp "billingAddress"]
set statusDetailsState [CkJsonObject_stringOf $jResp "statusDetails.state"]
set statusDetailsReasonCode [CkJsonObject_stringOf $jResp "statusDetails.reasonCode"]
set statusDetailsReasonDescription [CkJsonObject_stringOf $jResp "statusDetails.reasonDescription"]
set statusDetailsLastUpdatedTimestamp [CkJsonObject_stringOf $jResp "statusDetails.lastUpdatedTimestamp"]
set shippingAddress [CkJsonObject_stringOf $jResp "shippingAddress"]
set platformId [CkJsonObject_stringOf $jResp "platformId"]
set chargePermissionId [CkJsonObject_stringOf $jResp "chargePermissionId"]
set chargeId [CkJsonObject_stringOf $jResp "chargeId"]
set creationTimestamp [CkJsonObject_stringOf $jResp "creationTimestamp"]
set expirationTimestamp [CkJsonObject_stringOf $jResp "expirationTimestamp"]
set storeId [CkJsonObject_stringOf $jResp "storeId"]
set deliverySpecificationsAddressRestrictionsType [CkJsonObject_stringOf $jResp "deliverySpecifications.addressRestrictions.type"]
set providerMetadataProviderReferenceId [CkJsonObject_stringOf $jResp "providerMetadata.providerReferenceId"]
set releaseEnvironment [CkJsonObject_stringOf $jResp "releaseEnvironment"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "paymentPreferences"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set nullVal [CkJsonObject_IsNullOf $jResp "paymentPreferences[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "constraints"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set constraintId [CkJsonObject_stringOf $jResp "constraints[i].constraintId"]
    set description [CkJsonObject_stringOf $jResp "constraints[i].description"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deliverySpecifications.specialRestrictions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "deliverySpecifications.specialRestrictions[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkPrivateKey $privKey
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp