Tcl Requires Chilkat v11.0.0+

Amazon Pay - Close Charge Permission

See more Amazon Pay Examples

Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true. Tcl

load ./chilkat.dll

set success 0

#  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/close" \
#  -X DELETE
#  -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
#  -H "x-amz-pay-date:20201012T235046Z"
#  -d '{
#      "closureReason": "No more charges required",
#      "cancelPendingCharges": false
#  }'

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

#  {
#      "closureReason": "No more charges required",
#      "cancelPendingCharges": false
#  }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "closureReason" "No more charges required"
CkJsonObject_UpdateBool $json "cancelPendingCharges" 0

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 chargePermissionId here:
set success [CkHttp_SetUrlVar $http "chargePermissionId" "P21-1111111-1111111"]
#  To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
#  Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
set resp [new_CkHttpResponse]

set success [CkHttp_HttpSb $http "DELETE" "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close" $sbRequestBody "utf-8" "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkPrivateKey $privKey
    delete_CkHttpResponse $resp
    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_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkPrivateKey $privKey
    delete_CkHttpResponse $resp
    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": "Closed",
#          "reasons":
#          [{
#              "reasonCode": null,
#              "reasonDescription": 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 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]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "statusDetails.reasons"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set reasonCode [CkJsonObject_stringOf $jResp "statusDetails.reasons[i].reasonCode"]
    set reasonDescription [CkJsonObject_stringOf $jResp "statusDetails.reasons[i].reasonDescription"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkPrivateKey $privKey
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp