CkPython Requires Chilkat v11.0.0+

Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments. CkPython

import sys
import chilkat

success = False

#  This example assumes the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

http = chilkat.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"
#  }

json = chilkat.CkJsonObject()
json.UpdateString("cancellationReason","REASON DESCRIPTION")

sbRequestBody = chilkat.CkStringBuilder()
json.EmitSb(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.
privKey = chilkat.CkPrivateKey()
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if (success == False):
    print(privKey.lastErrorText())
    sys.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.
publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
if (success == False):
    print(http.lastErrorText())
    sys.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

http.put_Accept("application/json")

#  Use the actual chargeId here:
success = http.SetUrlVar("chargeId","bd504926-f659-4ad7-a1a9-9a747aaf5275")
#  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
resp = chilkat.CkHttpResponse()
success = http.HttpSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel",sbRequestBody,"utf-8","application/json",resp)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

#  If the status code is not equal to 200, this will display error information.
print("Response Body:")
print(jResp.emit())

respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode != 200):
    print("Failed.")
    sys.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": "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

chargeId = jResp.stringOf("chargeId")
chargePermissionId = jResp.stringOf("chargePermissionId")
chargeAmountAmount = jResp.stringOf("chargeAmount.amount")
chargeAmountCurrencyCode = jResp.stringOf("chargeAmount.currencyCode")
captureAmountAmount = jResp.stringOf("captureAmount.amount")
captureAmountCurrencyCode = jResp.stringOf("captureAmount.currencyCode")
refundedAmountAmount = jResp.stringOf("refundedAmount.amount")
refundedAmountCurrencyCode = jResp.stringOf("refundedAmount.currencyCode")
convertedAmount = jResp.stringOf("convertedAmount")
conversionRate = jResp.stringOf("conversionRate")
softDescriptor = jResp.stringOf("softDescriptor")
merchantMetadata = jResp.stringOf("merchantMetadata")
providerMetadataProviderReferenceId = jResp.stringOf("providerMetadata.providerReferenceId")
statusDetailsState = jResp.stringOf("statusDetails.state")
statusDetailsReasonCode = jResp.stringOf("statusDetails.reasonCode")
statusDetailsReasonDescription = jResp.stringOf("statusDetails.reasonDescription")
statusDetailsLastUpdatedTimestamp = jResp.stringOf("statusDetails.lastUpdatedTimestamp")
creationTimestamp = jResp.stringOf("creationTimestamp")
expirationTimestamp = jResp.stringOf("expirationTimestamp")
releaseEnvironment = jResp.stringOf("releaseEnvironment")