(Node.js) Amazon Pay - Get Charge

See more Amazon Pay Examples

Get Charge details such as charge amount and authorization state. Use this operation to determine if authorization or capture was successful.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // Implements the following CURL command:

    // curl "https://pay-api.amazon.com/:version/charges/:chargeId"
    //  -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
    //  -H "x-amz-pay-date:20201012T235046Z"
    //  -X GET

    // 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 chilkat.PrivateKey();
    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
    // Authorization

    http.Accept = "application/json";

    var respStatusCode = 0;

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.SetUrlVar("chargeId","P21-1111111-1111111");
    // 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/charges/{$chargeId}",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 chilkat.JsonObject();
    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)

    // {
    //      "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": "Descriptor",
    //      "merchantMetadata": null,
    //      "providerMetadata": {
    //          "providerReferenceId": null
    //      },
    //      "statusDetails":{
    //          "state": "Captured",
    //          "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");

}

chilkatExample();