(Tcl) Amazon Pay - Update Checkout Session

See more Amazon Pay Examples

Update the Checkout Session with transaction details.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#update-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/:checkoutSessionId" \
# -X PATCH
# -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
# -H "x-amz-pay-date:20201012T235046Z"
# -d '{
#     "webCheckoutDetails": {
#         "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
#     },
#     "paymentDetails": {
#         "paymentIntent": "AuthorizeWithCapture",
#         "canHandlePendingAuthorization":false,
#         "softDescriptor": "Descriptor",
#         "chargeAmount": {
#             "amount": "1",
#             "currencyCode": "USD"
#         }
#      },
#     "merchantMetadata": {
#         "merchantReferenceId": "Merchant reference ID",
#         "merchantStoreName": "Merchant store name",
#         "noteToBuyer": "Note to buyer",
#         "customInformation": "Custom information"
#     }
# }'

# 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": {
#     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
#   },
#   "paymentDetails": {
#     "paymentIntent": "AuthorizeWithCapture",
#     "canHandlePendingAuthorization": false,
#     "softDescriptor": "Descriptor",
#     "chargeAmount": {
#       "amount": "1",
#       "currencyCode": "USD"
#     }
#   },
#   "merchantMetadata": {
#     "merchantReferenceId": "Merchant reference ID",
#     "merchantStoreName": "Merchant store name",
#     "noteToBuyer": "Note to buyer",
#     "customInformation": "Custom information"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "webCheckoutDetails.checkoutResultReturnUrl" "https://a.com/merchant-confirm-page"
CkJsonObject_UpdateString $json "paymentDetails.paymentIntent" "AuthorizeWithCapture"
CkJsonObject_UpdateBool $json "paymentDetails.canHandlePendingAuthorization" 0
CkJsonObject_UpdateString $json "paymentDetails.softDescriptor" "Descriptor"
CkJsonObject_UpdateString $json "paymentDetails.chargeAmount.amount" "1"
CkJsonObject_UpdateString $json "paymentDetails.chargeAmount.currencyCode" "USD"
CkJsonObject_UpdateString $json "merchantMetadata.merchantReferenceId" "Merchant reference ID"
CkJsonObject_UpdateString $json "merchantMetadata.merchantStoreName" "Merchant store name"
CkJsonObject_UpdateString $json "merchantMetadata.noteToBuyer" "Note to buyer"
CkJsonObject_UpdateString $json "merchantMetadata.customInformation" "Custom information"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# 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_CkStringBuilder $sbRequestBody
    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_CkStringBuilder $sbRequestBody
    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
# Authorization

CkHttp_put_Accept $http "application/json"

set success [CkHttp_SetUrlVar $http "sessionId" "62b7d028-6c7c-4a43-b077-3897dff27c5b"]
# To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
# 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_PTextSb $http "PATCH" "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    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 200, 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 != 200} then {

    # 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'"
    # 	}

    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    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": "ada3f397-7d4b-4a55-abac-786685c02d8b",
#   "webCheckoutDetails": {
#     "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
#     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
#     "checkoutCancelUrl": null,
#     "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
#   },
#   "productType": "PayAndShip",
#   "paymentDetails": {
#     "paymentIntent": "AuthorizeWithCapture",
#     "canHandlePendingAuthorization": false,
#     "chargeAmount": {
#       "amount": "1",
#       "currencyCode": "USD"
#     },
#     "totalOrderAmount": null,
#     "softDescriptor": "Descriptor",
#     "presentmentCurrency": "USD",
#     "allowOvercharge": null,
#     "extendExpiration": null
#   },
#   "merchantMetadata": {
#     "merchantReferenceId": "Merchant reference ID",
#     "merchantStoreName": "Merchant store name",
#     "noteToBuyer": "Note to buyer",
#     "customInformation": "Custom information"
#   },
#   "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": "20191015T195703Z"
#   },
#   "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": [
#   ],
#   "creationTimestamp": "20191015T195655Z",
#   "expirationTimestamp": "20191016T195655Z",
#   "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 paymentDetailsPaymentIntent [CkJsonObject_stringOf $jResp "paymentDetails.paymentIntent"]
set paymentDetailsCanHandlePendingAuthorization [CkJsonObject_BoolOf $jResp "paymentDetails.canHandlePendingAuthorization"]
set paymentDetailsChargeAmountAmount [CkJsonObject_stringOf $jResp "paymentDetails.chargeAmount.amount"]
set paymentDetailsChargeAmountCurrencyCode [CkJsonObject_stringOf $jResp "paymentDetails.chargeAmount.currencyCode"]
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 buyerBuyerId [CkJsonObject_stringOf $jResp "buyer.buyerId"]
set buyerName [CkJsonObject_stringOf $jResp "buyer.name"]
set buyerEmail [CkJsonObject_stringOf $jResp "buyer.email"]
set buyerPhoneNumber [CkJsonObject_stringOf $jResp "buyer.phoneNumber"]
set buyerPrimeMembershipTypes [CkJsonObject_stringOf $jResp "buyer.primeMembershipTypes"]
set billingAddressName [CkJsonObject_stringOf $jResp "billingAddress.name"]
set billingAddressAddressLine1 [CkJsonObject_stringOf $jResp "billingAddress.addressLine1"]
set billingAddressAddressLine2 [CkJsonObject_stringOf $jResp "billingAddress.addressLine2"]
set billingAddressAddressLine3 [CkJsonObject_stringOf $jResp "billingAddress.addressLine3"]
set billingAddressCity [CkJsonObject_stringOf $jResp "billingAddress.city"]
set billingAddressCounty [CkJsonObject_stringOf $jResp "billingAddress.county"]
set billingAddressDistrict [CkJsonObject_stringOf $jResp "billingAddress.district"]
set billingAddressStateOrRegion [CkJsonObject_stringOf $jResp "billingAddress.stateOrRegion"]
set billingAddressPostalCode [CkJsonObject_stringOf $jResp "billingAddress.postalCode"]
set billingAddressCountryCode [CkJsonObject_stringOf $jResp "billingAddress.countryCode"]
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 shippingAddressName [CkJsonObject_stringOf $jResp "shippingAddress.name"]
set shippingAddressAddressLine1 [CkJsonObject_stringOf $jResp "shippingAddress.addressLine1"]
set shippingAddressAddressLine2 [CkJsonObject_stringOf $jResp "shippingAddress.addressLine2"]
set shippingAddressAddressLine3 [CkJsonObject_stringOf $jResp "shippingAddress.addressLine3"]
set shippingAddressCity [CkJsonObject_stringOf $jResp "shippingAddress.city"]
set shippingAddressCounty [CkJsonObject_stringOf $jResp "shippingAddress.county"]
set shippingAddressDistrict [CkJsonObject_stringOf $jResp "shippingAddress.district"]
set shippingAddressStateOrRegion [CkJsonObject_stringOf $jResp "shippingAddress.stateOrRegion"]
set shippingAddressPostalCode [CkJsonObject_stringOf $jResp "shippingAddress.postalCode"]
set shippingAddressCountryCode [CkJsonObject_stringOf $jResp "shippingAddress.countryCode"]
set shippingAddressPhoneNumber [CkJsonObject_stringOf $jResp "shippingAddress.phoneNumber"]
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 paymentDescriptor [CkJsonObject_stringOf $jResp "paymentPreferences[i].paymentDescriptor"]
    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 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_CkStringBuilder $sbRequestBody
delete_CkPrivateKey $privKey
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp