Lua Requires Chilkat v11.0.0+

Amazon Pay - Cancel Charge

See more Amazon Pay Examples

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

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

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

local json = chilkat.JsonObject.new()
json:update_string("cancellationReason", "REASON DESCRIPTION")

local sbRequestBody = chilkat.StringBuilder.new()
json:emit_sb(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.
local privKey = chilkat.PrivateKey.new()
local success = privKey:load_pem_file("C:/someDir/myAmazonPayPrivateKey.pem")
if not success then
    print(privKey.last_error_text)
    return
end

-- 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.
local publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http:set_auth_private_key(publicKeyId, privKey)
if not success then
    print(http.last_error_text)
    return
end

-- 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:set_url_var("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
local resp = chilkat.HttpResponse.new()
success = http:http_sb("DELETE", "https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel", sbRequestBody, "utf-8", "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

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

local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode ~= 200 then
    print("Failed.")
    return
end

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

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