JavaScript

Amazon Pay - Cancel Charge

See more Amazon Pay Examples

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

var success = false;

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

var http = new 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"
// }

var json = new CkJsonObject();
json.UpdateString("cancellationReason","REASON DESCRIPTION");

var sbRequestBody = new 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.
var privKey = new CkPrivateKey();
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if (success == false) {
    console.log(privKey.LastErrorText);
    return;
}

// 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.
var publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
success = http.SetAuthPrivateKey(publicKeyId,privKey);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

// 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 HttpSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
var resp = new CkHttpResponse();
success = http.HttpSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel",sbRequestBody,"utf-8","application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

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

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode !== 200) {
    console.log("Failed.");
    return;
}

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

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