(JavaScript) Amazon Pay - Get Refund

See more Amazon Pay Examples

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/refund.html#get-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/:refundId" \
// -X GET
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"

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

var respStatusCode = 0;

var sbResponseBody = new CkStringBuilder();
success = http.SetUrlVar("refundId","S01-5105180-3221187-R022311");
// To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
success = http.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/refunds/{$refundId}",sbResponseBody);
if (success == false) {
    // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    respStatusCode = http.LastStatus;
    if (respStatusCode !== 0) {
        console.log("Response Status Code = " + respStatusCode);
        console.log("Response body:");
        console.log(http.LastResponseBody);
    }
    else {
        console.log(http.LastErrorText);
    }

    return;
}

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

console.log("Response Body:");
console.log(jResp.Emit());

respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
// We expect a 200 status code for success.
// Note: Some Amazon Pay API calls return 200 for success, others return 201.
if (respStatusCode !== 200) {
    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": "Refunded",
//          "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");