(Node.js) Amazon Pay - Close Charge Permission

See more Amazon Pay Examples

Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.

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

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/chargePermissions/:chargePermissionId/close" \
    // -X DELETE
    // -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
    // -H "x-amz-pay-date:20201012T235046Z"
    // -d '{
    //     "closureReason": "No more charges required",
    //     "cancelPendingCharges": false
    // }'

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

    // {
    //     "closureReason": "No more charges required",
    //     "cancelPendingCharges": false
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("closureReason","No more charges required");
    json.UpdateBool("cancelPendingCharges",false);

    var sbRequestBody = new chilkat.StringBuilder();
    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 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";

    // Use the actual chargePermissionId here:
    success = http.SetUrlVar("chargePermissionId","P21-1111111-1111111");
    // To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
    // Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
    // resp: HttpResponse
    var resp = http.PTextSb("DELETE","https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);
    var jResp = new chilkat.JsonObject();
    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)

    // {
    //     "chargePermissionId": "chargePermission-1",
    //     "chargePermissionReferenceId": null,
    //     "buyer": {
    //         "buyerId": "buyerId",
    //         "name": "name-1",
    //         "email": "name@amazon.com",
    //         "phoneNumber": "800-000-0000",
    //         "primeMembershipTypes": null
    //     },
    //     "releaseEnvironment": "Live",
    //     "shippingAddress": {  // Null for PayOnly product type
    //         "name": "Work",
    //         "addressLine1": "440 Terry Ave",
    //         "addressLine2": "",
    //         "addressLine3": "",
    //         "city": "Seattle",
    //         "county": "King",
    //         "district": "Seattle",
    //         "stateOrRegion": "WA",
    //         "postalCode": "98121",
    //         "countryCode": "US",
    //         "phoneNumber": "800-000-0000"
    //     },
    //     "billingAddress": {  // Only available in EU or for PayOnly product type
    //         "name": "Work",
    //         "addressLine1": "440 Terry Ave",
    //         "addressLine2": "",
    //         "addressLine3": "",
    //         "city": "Seattle",
    //         "county": "King",
    //         "district": "Seattle",
    //         "stateOrRegion": "WA",
    //         "postalCode": "98121",
    //         "countryCode": "US",
    //         "phoneNumber": "800-000-0000"
    //     },
    //     "paymentPreferences": [
    //     {
    //         "paymentDescriptor": null
    //     }],
    //     "statusDetails": {
    //         "state": "Closed",
    //         "reasons":
    //         [{
    //             "reasonCode": null,
    //             "reasonDescription": null
    //         }],
    //         "lastUpdatedTimestamp": "20190714T155300Z"
    //     },
    //     "creationTimestamp": "20190714T155300Z",
    //     "expirationTimestamp": "20190715T155300Z",
    //     "merchantMetadata":{
    //         "merchantReferenceId": "123-77-876", 
    //         "merchantStoreName": "AmazonTestStoreFront",
    //         "noteToBuyer": "merchantNoteForBuyer",
    //         "customInformation": "This is custom information" 
    //     },
    //     "platformId": "SPId",
    //     "limits": {
    //         "amountLimit": {
    //             "amount": "14.00",
    //             "currencyCode": "USD"
    //         },
    //         "amountBalance": {
    //             "amount": "14.00",
    //             "currencyCode": "USD"
    //         }
    //     },
    //     "presentmentCurrency": "USD"
    // }

    // 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 paymentDescriptor;
    var reasonCode;
    var reasonDescription;

    var chargePermissionId = jResp.StringOf("chargePermissionId");
    var chargePermissionReferenceId = jResp.StringOf("chargePermissionReferenceId");
    var buyerBuyerId = jResp.StringOf("buyer.buyerId");
    var buyerName = jResp.StringOf("buyer.name");
    var buyerEmail = jResp.StringOf("buyer.email");
    var buyerPhoneNumber = jResp.StringOf("buyer.phoneNumber");
    var buyerPrimeMembershipTypes = jResp.StringOf("buyer.primeMembershipTypes");
    var releaseEnvironment = jResp.StringOf("releaseEnvironment");
    var shippingAddressName = jResp.StringOf("shippingAddress.name");
    var shippingAddressAddressLine1 = jResp.StringOf("shippingAddress.addressLine1");
    var shippingAddressAddressLine2 = jResp.StringOf("shippingAddress.addressLine2");
    var shippingAddressAddressLine3 = jResp.StringOf("shippingAddress.addressLine3");
    var shippingAddressCity = jResp.StringOf("shippingAddress.city");
    var shippingAddressCounty = jResp.StringOf("shippingAddress.county");
    var shippingAddressDistrict = jResp.StringOf("shippingAddress.district");
    var shippingAddressStateOrRegion = jResp.StringOf("shippingAddress.stateOrRegion");
    var shippingAddressPostalCode = jResp.StringOf("shippingAddress.postalCode");
    var shippingAddressCountryCode = jResp.StringOf("shippingAddress.countryCode");
    var shippingAddressPhoneNumber = jResp.StringOf("shippingAddress.phoneNumber");
    var billingAddressName = jResp.StringOf("billingAddress.name");
    var billingAddressAddressLine1 = jResp.StringOf("billingAddress.addressLine1");
    var billingAddressAddressLine2 = jResp.StringOf("billingAddress.addressLine2");
    var billingAddressAddressLine3 = jResp.StringOf("billingAddress.addressLine3");
    var billingAddressCity = jResp.StringOf("billingAddress.city");
    var billingAddressCounty = jResp.StringOf("billingAddress.county");
    var billingAddressDistrict = jResp.StringOf("billingAddress.district");
    var billingAddressStateOrRegion = jResp.StringOf("billingAddress.stateOrRegion");
    var billingAddressPostalCode = jResp.StringOf("billingAddress.postalCode");
    var billingAddressCountryCode = jResp.StringOf("billingAddress.countryCode");
    var billingAddressPhoneNumber = jResp.StringOf("billingAddress.phoneNumber");
    var statusDetailsState = jResp.StringOf("statusDetails.state");
    var statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp");
    var creationTimestamp = jResp.StringOf("creationTimestamp");
    var expirationTimestamp = jResp.StringOf("expirationTimestamp");
    var merchantMetadataMerchantReferenceId = jResp.StringOf("merchantMetadata.merchantReferenceId");
    var merchantMetadataMerchantStoreName = jResp.StringOf("merchantMetadata.merchantStoreName");
    var merchantMetadataNoteToBuyer = jResp.StringOf("merchantMetadata.noteToBuyer");
    var merchantMetadataCustomInformation = jResp.StringOf("merchantMetadata.customInformation");
    var platformId = jResp.StringOf("platformId");
    var limitsAmountLimitAmount = jResp.StringOf("limits.amountLimit.amount");
    var limitsAmountLimitCurrencyCode = jResp.StringOf("limits.amountLimit.currencyCode");
    var limitsAmountBalanceAmount = jResp.StringOf("limits.amountBalance.amount");
    var limitsAmountBalanceCurrencyCode = jResp.StringOf("limits.amountBalance.currencyCode");
    var presentmentCurrency = jResp.StringOf("presentmentCurrency");
    var i = 0;
    var count_i = jResp.SizeOfArray("paymentPreferences");
    while (i < count_i) {
        jResp.I = i;
        paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("statusDetails.reasons");
    while (i < count_i) {
        jResp.I = i;
        reasonCode = jResp.StringOf("statusDetails.reasons[i].reasonCode");
        reasonDescription = jResp.StringOf("statusDetails.reasons[i].reasonDescription");
        i = i+1;
    }


}

chilkatExample();