(Tcl) Amazon Pay - Get Charge

See more Amazon Pay Examples

Get Charge details such as charge amount and authorization state. Use this operation to determine if authorization or capture was successful.

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

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/charges/:chargeId"
#  -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
#  -H "x-amz-pay-date:20201012T235046Z"
#  -X GET

# 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 "chargeId" "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/charges/{$chargeId}" $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)

# {
#      "chargeId": "P21-1111111-1111111-C111111",
#      "chargePermissionId": "P21-1111111-1111111",
#      "chargeAmount": {
#          "amount": "14.00",
#          "currencyCode": "USD"
#      },
#      "captureAmount": {
#          "amount": "14.00",
#          "currencyCode": "USD"
#      },
#      "refundedAmount": {
#          "amount": "0.00",
#          "currencyCode": "USD"
#      },
#      "convertedAmount": "14.00",
#      "conversionRate": "1.00",
#      "softDescriptor": "Descriptor",
#      "merchantMetadata": null,
#      "providerMetadata": {
#          "providerReferenceId": null
#      },
#      "statusDetails":{
#          "state": "Captured",
#          "reasonCode": null,
#          "reasonDescription": null,
#          "lastUpdatedTimestamp": "20190714T155300Z"
#      },
#      "creationTimestamp": "20190714T155300Z",
#      "expirationTimestamp": "20190715T155300Z",
#      "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 chargeId [CkJsonObject_stringOf $jResp "chargeId"]
set chargePermissionId [CkJsonObject_stringOf $jResp "chargePermissionId"]
set chargeAmountAmount [CkJsonObject_stringOf $jResp "chargeAmount.amount"]
set chargeAmountCurrencyCode [CkJsonObject_stringOf $jResp "chargeAmount.currencyCode"]
set captureAmountAmount [CkJsonObject_stringOf $jResp "captureAmount.amount"]
set captureAmountCurrencyCode [CkJsonObject_stringOf $jResp "captureAmount.currencyCode"]
set refundedAmountAmount [CkJsonObject_stringOf $jResp "refundedAmount.amount"]
set refundedAmountCurrencyCode [CkJsonObject_stringOf $jResp "refundedAmount.currencyCode"]
set convertedAmount [CkJsonObject_stringOf $jResp "convertedAmount"]
set conversionRate [CkJsonObject_stringOf $jResp "conversionRate"]
set softDescriptor [CkJsonObject_stringOf $jResp "softDescriptor"]
set merchantMetadata [CkJsonObject_stringOf $jResp "merchantMetadata"]
set providerMetadataProviderReferenceId [CkJsonObject_stringOf $jResp "providerMetadata.providerReferenceId"]
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 creationTimestamp [CkJsonObject_stringOf $jResp "creationTimestamp"]
set expirationTimestamp [CkJsonObject_stringOf $jResp "expirationTimestamp"]
set releaseEnvironment [CkJsonObject_stringOf $jResp "releaseEnvironment"]

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