(Tcl) Amazon Pay - Complete Checkout Session

See more Amazon Pay Examples

Complete Checkout Session after the buyer returns to checkoutResultReturnUrl to finalize the paymentIntent.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#complete-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/complete" \
# -X POST
# -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
# -H "x-amz-pay-date:20201012T235046Z"
# -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
# -d '{
#     "chargeAmount": {
#         "amount": "14.00",
#         "currencyCode": "USD"
#     }
# }'

# 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.

# {
#   "chargeAmount": {
#     "amount": "14.00",
#     "currencyCode": "USD"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "chargeAmount.amount" "14.00"
CkJsonObject_UpdateString $json "chargeAmount.currencyCode" "USD"

# 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 PTextSb.
# Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
set success [CkHttp_SetUrlVar $http "sessionId" "62b7d028-6c7c-4a43-b077-3897dff27c5b"]
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}/complete" "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 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'"
    # 	}

    # Another sample failure response (status code = 422)
    # 	{
    # 	  "reasonCode": "InvalidCheckoutSessionStatus",
    # 	  "message": "You tried to call an operation on a Checkout Session that is in a state where that operation is not allowed"
    # 	}

    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": null,
#   "chargePermissionType": "OneTime",
#   "recurringMetadata": null,
#   "productType": null,
#   "paymentDetails": null,
#   "merchantMetadata": null,
#   "supplementaryData": null,
#   "buyer": null,
#   "billingAddress": null,
#   "paymentPreferences": [
#     null
#   ],
#   "statusDetails": {
#     "state": "Completed",
#     "reasonCode": null,
#     "reasonDescription": null,
#     "lastUpdatedTimestamp": "20191015T204327Z"
#   },
#   "shippingAddress": null,
#   "platformId": null,
#   "chargePermissionId": "S01-5105180-3221187",
#   "chargeId": "S01-5105180-3221187-C056351",
#   "constraints": [
#     null
#   ],
#   "creationTimestamp": "20191015T204313Z",
#   "expirationTimestamp": null,
#   "storeId": null,
#   "deliverySpecifications": null,
#   "providerMetadata": null,
#   "releaseEnvironment": null
# }

# 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 webCheckoutDetails [CkJsonObject_stringOf $jResp "webCheckoutDetails"]
set chargePermissionType [CkJsonObject_stringOf $jResp "chargePermissionType"]
set recurringMetadata [CkJsonObject_stringOf $jResp "recurringMetadata"]
set productType [CkJsonObject_stringOf $jResp "productType"]
set paymentDetails [CkJsonObject_stringOf $jResp "paymentDetails"]
set merchantMetadata [CkJsonObject_stringOf $jResp "merchantMetadata"]
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 deliverySpecifications [CkJsonObject_stringOf $jResp "deliverySpecifications"]
set providerMetadata [CkJsonObject_stringOf $jResp "providerMetadata"]
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 nullVal [CkJsonObject_IsNullOf $jResp "constraints[i]"]
    set i [expr $i + 1]
}

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