(Tcl) Amazon Pay - Get Charge Permission

See more Amazon Pay Examples

Get Charge Permission to determine if this Charge Permission can be used to charge the buyer.

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/charge-permission.html#get-charge-permission

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/chargePermissions/:chargePermissionId"
# 	-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.
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_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_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 respStatusCode 0

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_SetUrlVar $http "chargePermissionId" "P21-1111111-1111111"]
# 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
set success [CkHttp_QuickGetSb $http "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}" $sbResponseBody]
if {$success == 0} then {
    # If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    set respStatusCode [CkHttp_get_LastStatus $http]
    if {$respStatusCode != 0} then {
        puts "Response Status Code = $respStatusCode"
        puts "Response body:"
        puts [CkHttp_lastResponseBody $http]
    }     else {
        puts [CkHttp_lastErrorText $http]
    }

    delete_CkHttp $http
    delete_CkPrivateKey $privKey
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
# We expect a 200 status code for success.
# Note: Some Amazon Pay API calls return 200 for success, others return 201.
if {$respStatusCode != 200} then {
    puts "Failed."
    delete_CkHttp $http
    delete_CkPrivateKey $privKey
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#     "chargePermissionId": "chargePermission-1",
#     "chargePermissionReferenceId": null,
#     "buyer": {
#         "buyerId": "buyerId",
#         "name": "name-1",
#         "email": "name@amazon.com",
#         "phoneNumber": "800-000-0000",
#         "primeMembershipTypes": null
#     },
#     "releaseEnvironment": "Live",
#     "shippingAddress":{  // Null for PayOnly product type
#         "name": "Work",
#         "addressLine1": "440 Terry Ave",
#         "addressLine2": "",
#         "addressLine3": "",
#         "city": "Seattle",
#         "county": "King",
#         "district": "Seattle",
#         "stateOrRegion": "WA",
#         "postalCode": "98121",
#         "countryCode": "US",
#         "phoneNumber": "800-000-0000"
#     },
#     "billingAddress":{  // Only available in EU or for PayOnly product type
#         "name": "Work",
#         "addressLine1": "440 Terry Ave",
#         "addressLine2": "",
#         "addressLine3": "",
#         "city": "Seattle",
#         "county": "King",
#         "district": "Seattle",
#         "stateOrRegion": "WA",
#         "postalCode": "98121",
#         "countryCode": "US",
#         "phoneNumber": "800-000-0000"
#     },
#     "paymentPreferences":[{
#         "paymentDescriptor": null
#     }],
#     "statusDetails":{
#         "state": "Chargeable",
#         "reasons":null,
#         "lastUpdatedTimestamp": "20190714T155300Z"
#     },
#     "creationTimestamp": "20190714T155300Z",
#     "expirationTimestamp": "20190715T155300Z",
#     "merchantMetadata":{
#         "merchantReferenceId": "123-77-876", 
#         "merchantStoreName": "AmazonTestStoreFront",
#         "noteToBuyer": "merchantNoteForBuyer",
#         "customInformation": "This is custom information"
#     },
#     "platformId": "SPId",
#     "limits": {
#         "amountLimit": {
#             "amount": "14.00",
#             "currencyCode": "USD"
#         },
#         "amountBalance": {
#             "amount": "14.00",
#             "currencyCode": "USD"
#         }
#     },
#     "presentmentCurrency": "USD"
# }

# 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 chargePermissionId [CkJsonObject_stringOf $jResp "chargePermissionId"]
set chargePermissionReferenceId [CkJsonObject_stringOf $jResp "chargePermissionReferenceId"]
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 releaseEnvironment [CkJsonObject_stringOf $jResp "releaseEnvironment"]
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 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 billingAddressPhoneNumber [CkJsonObject_stringOf $jResp "billingAddress.phoneNumber"]
set statusDetailsState [CkJsonObject_stringOf $jResp "statusDetails.state"]
set statusDetailsReasons [CkJsonObject_stringOf $jResp "statusDetails.reasons"]
set statusDetailsLastUpdatedTimestamp [CkJsonObject_stringOf $jResp "statusDetails.lastUpdatedTimestamp"]
set creationTimestamp [CkJsonObject_stringOf $jResp "creationTimestamp"]
set expirationTimestamp [CkJsonObject_stringOf $jResp "expirationTimestamp"]
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 platformId [CkJsonObject_stringOf $jResp "platformId"]
set limitsAmountLimitAmount [CkJsonObject_stringOf $jResp "limits.amountLimit.amount"]
set limitsAmountLimitCurrencyCode [CkJsonObject_stringOf $jResp "limits.amountLimit.currencyCode"]
set limitsAmountBalanceAmount [CkJsonObject_stringOf $jResp "limits.amountBalance.amount"]
set limitsAmountBalanceCurrencyCode [CkJsonObject_stringOf $jResp "limits.amountBalance.currencyCode"]
set presentmentCurrency [CkJsonObject_stringOf $jResp "presentmentCurrency"]
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]
}

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