(JavaScript) Amazon Pay - Create Refund

See more Amazon Pay Examples

Note: This example requires Chilkat v11.0.0 or greater.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/refund.html#create-refund

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

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/refunds/" \
// -X POST
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
// -d '{
//     "chargeId": "CHARGE_ID",
//     "refundAmount": {
//         "amount": "14.00",
//         "currencyCode": "USD"
//     },
//     "softDescriptor": "Descriptor"
// }'

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

// {
//     "chargeId": "CHARGE_ID",
//     "refundAmount": {
//         "amount": "14.00",
//         "currencyCode": "USD"
//     },
//     "softDescriptor": "Descriptor"
// }

var json = new CkJsonObject();
json.UpdateString("chargeId","CHARGE_ID");
json.UpdateString("refundAmount.amount","14.00");
json.UpdateString("refundAmount.currencyCode","USD");
json.UpdateString("softDescriptor","Descriptor");

// 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.
// Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
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
// x-amz-pay-idempotency-key
// Authorization

http.Accept = "application/json";

// To use the live system, replace "sandbox" with "live" in the URL passed to HttpJson.
// 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.HttpJson("POST","https://pay-api.amazon.eu/sandbox/v2/refunds/",json,"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 201, 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 !== 201) {
    console.log("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//      "refundId": "S01-5105180-3221187-R022311",
//      "chargeId": "S01-5105180-3221187-C056351",
//      "refundAmount": {
//          "amount": "14.00",
//          "currencyCode": "USD"
//      },
//      "softDescriptor": "Descriptor",
//      "creationTimestamp": "20190714T155300Z",
//      "statusDetails": {
//          "state": "RefundInitiated",
//          "reasonCode": null,
//          "reasonDescription": null,
//          "lastUpdatedTimestamp": "20190714T155300Z"
//      },
//      "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 refundId = jResp.StringOf("refundId");
var chargeId = jResp.StringOf("chargeId");
var refundAmountAmount = jResp.StringOf("refundAmount.amount");
var refundAmountCurrencyCode = jResp.StringOf("refundAmount.currencyCode");
var softDescriptor = jResp.StringOf("softDescriptor");
var creationTimestamp = jResp.StringOf("creationTimestamp");
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 releaseEnvironment = jResp.StringOf("releaseEnvironment");