(Chilkat2-Python) 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

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

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

http = chilkat2.Http()

# 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 = chilkat2.JsonObject()
json.UpdateString("cancellationReason","REASON DESCRIPTION")

sbRequestBody = chilkat2.StringBuilder()
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 = chilkat2.PrivateKey()
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.
# Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
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.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 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
resp = http.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

respStatusCode = resp.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")