(PowerShell) 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 .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.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 = New-Object Chilkat.JsonObject
$json.UpdateString("cancellationReason","REASON DESCRIPTION")

$sbRequestBody = New-Object Chilkat.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 = New-Object Chilkat.PrivateKey
$success = $privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if ($success -eq $false) {
    $($privKey.LastErrorText)
    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 -eq $false) {
    $($http.LastErrorText)
    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 = $http.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel",$sbRequestBody,"utf-8","application/json",$false,$false)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

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

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Failed.")

    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")