Sample code for 30+ languages & platforms
React Native Requires Chilkat v11.0.0+

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.

Chilkat React Native Downloads

React Native
import { Http, HttpResponse, JsonObject, PrivateKey, StringBuilder } from '@chilkat/react-native'

async function chilkatExample() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const http = new Http();

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

  const json = new JsonObject();
  json.updateString('closureReason', 'No more charges required');
  json.updateBool('cancelPendingCharges', false);

  const sbRequestBody = new 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.
  const privKey = new PrivateKey();
  try {
    privKey.loadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
  } catch {
    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
  const publicKeyId = 'SANDBOX-AHEGSJCM3L2S637RBGABLAFW';
  try {
    http.setAuthPrivateKey(publicKeyId, privKey);
  } catch {
    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:
  http.setUrlVar('chargePermissionId', 'P21-1111111-1111111');
  // 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
  const resp = new HttpResponse();
  try {
    await http.httpSbAsync('DELETE', 'https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close', sbRequestBody, 'utf-8', 'application/json', resp);
  } catch {
    console.log(http.lastErrorText);
    return;
  }

  const sbResponseBody = new StringBuilder();
  resp.getBodySb(sbResponseBody);
  const jResp = new 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());

  const 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

  let paymentDescriptor = '';
  let reasonCode = '';
  let reasonDescription = '';

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

  i = 0;
  countI = jResp.sizeOfArray('statusDetails.reasons');
  while (i < countI) {
    jResp.i = i;
    reasonCode = jResp.stringOf('statusDetails.reasons[i].reasonCode');
    reasonDescription = jResp.stringOf('statusDetails.reasons[i].reasonDescription');
    i++;
  }
}