(Tcl) Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/charge.html#cancel-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/cancel" \
# -X DELETE
# -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
# -H "x-amz-pay-date:20201012T235046Z"
# -d '{
#     "cancellationReason": "REASON DESCRIPTION"
# }'

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

# {
#   "cancellationReason": "REASON DESCRIPTION"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "cancellationReason" "REASON DESCRIPTION"

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"

# Use the actual chargeId here:
set success [CkHttp_SetUrlVar $http "chargeId" "bd504926-f659-4ad7-a1a9-9a747aaf5275"]
# 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 "DELETE" "https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel" $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 {
    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)

# {
#   "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": "SOFT DESCRIPTOR",
#   "merchantMetadata": null,
#   "providerMetadata": {
#     "providerReferenceId": null
#   },
#   "statusDetails": {
#     "state": "Canceled",
#     "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_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkPrivateKey $privKey
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp