Sample code for 30+ languages & platforms
React Native

Amazon Pay - Update Checkout Session

See more Amazon Pay Examples

Update the Checkout Session with transaction details.

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/checkoutSessions/:checkoutSessionId" \
  // -X PATCH
  // -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
  // -H "x-amz-pay-date:20201012T235046Z"
  // -d '{
  //     "webCheckoutDetails": {
  //         "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
  //     },
  //     "paymentDetails": {
  //         "paymentIntent": "AuthorizeWithCapture",
  //         "canHandlePendingAuthorization":false,
  //         "softDescriptor": "Descriptor",
  //         "chargeAmount": {
  //             "amount": "1",
  //             "currencyCode": "USD"
  //         }
  //      },
  //     "merchantMetadata": {
  //         "merchantReferenceId": "Merchant reference ID",
  //         "merchantStoreName": "Merchant store name",
  //         "noteToBuyer": "Note to buyer",
  //         "customInformation": "Custom information"
  //     }
  // }'

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

  // {
  //   "webCheckoutDetails": {
  //     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
  //   },
  //   "paymentDetails": {
  //     "paymentIntent": "AuthorizeWithCapture",
  //     "canHandlePendingAuthorization": false,
  //     "softDescriptor": "Descriptor",
  //     "chargeAmount": {
  //       "amount": "1",
  //       "currencyCode": "USD"
  //     }
  //   },
  //   "merchantMetadata": {
  //     "merchantReferenceId": "Merchant reference ID",
  //     "merchantStoreName": "Merchant store name",
  //     "noteToBuyer": "Note to buyer",
  //     "customInformation": "Custom information"
  //   }
  // }

  const json = new JsonObject();
  json.updateString('webCheckoutDetails.checkoutResultReturnUrl', 'https://a.com/merchant-confirm-page');
  json.updateString('paymentDetails.paymentIntent', 'AuthorizeWithCapture');
  json.updateBool('paymentDetails.canHandlePendingAuthorization', false);
  json.updateString('paymentDetails.softDescriptor', 'Descriptor');
  json.updateString('paymentDetails.chargeAmount.amount', '1');
  json.updateString('paymentDetails.chargeAmount.currencyCode', 'USD');
  json.updateString('merchantMetadata.merchantReferenceId', 'Merchant reference ID');
  json.updateString('merchantMetadata.merchantStoreName', 'Merchant store name');
  json.updateString('merchantMetadata.noteToBuyer', 'Note to buyer');
  json.updateString('merchantMetadata.customInformation', 'Custom information');

  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';

  http.setUrlVar('sessionId', '62b7d028-6c7c-4a43-b077-3897dff27c5b');
  // 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('PATCH', 'https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}', 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) {

    // A sample response body for the case where the session ID does not exist:
    // 	{
    // 	  "reasonCode": "ResourceNotFound",
    // 	  "message": "Resource you are trying to access is not available. Requested path '/sandbox/v2/checkoutSessions/bd504926-f659-4ad7-a1a9-9a747aaf5275'"
    // 	}

    console.log('Failed.');
    return;
  }

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

  // {
  //   "checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
  //   "webCheckoutDetails": {
  //     "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
  //     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
  //     "checkoutCancelUrl": null,
  //     "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
  //   },
  //   "productType": "PayAndShip",
  //   "paymentDetails": {
  //     "paymentIntent": "AuthorizeWithCapture",
  //     "canHandlePendingAuthorization": false,
  //     "chargeAmount": {
  //       "amount": "1",
  //       "currencyCode": "USD"
  //     },
  //     "totalOrderAmount": null,
  //     "softDescriptor": "Descriptor",
  //     "presentmentCurrency": "USD",
  //     "allowOvercharge": null,
  //     "extendExpiration": null
  //   },
  //   "merchantMetadata": {
  //     "merchantReferenceId": "Merchant reference ID",
  //     "merchantStoreName": "Merchant store name",
  //     "noteToBuyer": "Note to buyer",
  //     "customInformation": "Custom information"
  //   },
  //   "supplementaryData": null,
  //   "buyer": {
  //     "buyerId": "buyerId",
  //     "name": "name-1",
  //     "email": "name@amazon.com",
  //     "phoneNumber": "800-000-0000",
  //     "primeMembershipTypes": null
  //   },
  //   "billingAddress": {
  //     "name": "Work",
  //     "addressLine1": "440 Terry Ave",
  //     "addressLine2": "",
  //     "addressLine3": "",
  //     "city": "Seattle",
  //     "county": "King",
  //     "district": "Seattle",
  //     "stateOrRegion": "WA",
  //     "postalCode": "98121",
  //     "countryCode": "US"
  //   },
  //   "paymentPreferences": [
  //     {
  //       "paymentDescriptor": "Your selected Amazon payment method"
  //     }
  //   ],
  //   "statusDetails": {
  //     "state": "Open",
  //     "reasonCode": null,
  //     "reasonDescription": null,
  //     "lastUpdatedTimestamp": "20191015T195703Z"
  //   },
  //   "shippingAddress": {
  //     "name": "Susie Smith",
  //     "addressLine1": "10 Ditka Ave",
  //     "addressLine2": "Suite 2500",
  //     "addressLine3": null,
  //     "city": "Chicago",
  //     "county": null,
  //     "district": null,
  //     "stateOrRegion": "IL",
  //     "postalCode": "60602",
  //     "countryCode": "US",
  //     "phoneNumber": "800-000-0000"
  //   },
  //   "platformId": null,
  //   "chargePermissionId": null,
  //   "chargeId": null,
  //   "constraints": [
  //   ],
  //   "creationTimestamp": "20191015T195655Z",
  //   "expirationTimestamp": "20191016T195655Z",
  //   "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
  //   "deliverySpecifications": {
  //     "specialRestrictions": [
  //       "RestrictPOBoxes"
  //     ],
  //     "addressRestrictions": {
  //       "type": "Allowed",
  //       "restrictions": {
  //         "US": {
  //           "statesOrRegions": [
  //             "WA"
  //           ],
  //           "zipCodes": [
  //             "95050",
  //             "93405"
  //           ]
  //         },
  //         "GB": {
  //           "zipCodes": [
  //             "72046",
  //             "72047"
  //           ]
  //         },
  //         "IN": {
  //           "statesOrRegions": [
  //             "AP"
  //           ]
  //         },
  //         "JP": {}
  //       }
  //     }
  //   },
  //   "providerMetadata": {
  //     "providerReferenceId": null
  //   },
  //   "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

  let paymentDescriptor = '';
  let strVal = '';

  const checkoutSessionId = jResp.stringOf('checkoutSessionId');
  const webCheckoutDetailsCheckoutReviewReturnUrl = jResp.stringOf('webCheckoutDetails.checkoutReviewReturnUrl');
  const webCheckoutDetailsCheckoutResultReturnUrl = jResp.stringOf('webCheckoutDetails.checkoutResultReturnUrl');
  const webCheckoutDetailsCheckoutCancelUrl = jResp.stringOf('webCheckoutDetails.checkoutCancelUrl');
  const webCheckoutDetailsAmazonPayRedirectUrl = jResp.stringOf('webCheckoutDetails.amazonPayRedirectUrl');
  const productType = jResp.stringOf('productType');
  const paymentDetailsPaymentIntent = jResp.stringOf('paymentDetails.paymentIntent');
  const paymentDetailsChargeAmountAmount = jResp.stringOf('paymentDetails.chargeAmount.amount');
  const paymentDetailsChargeAmountCurrencyCode = jResp.stringOf('paymentDetails.chargeAmount.currencyCode');
  const paymentDetailsTotalOrderAmount = jResp.stringOf('paymentDetails.totalOrderAmount');
  const paymentDetailsSoftDescriptor = jResp.stringOf('paymentDetails.softDescriptor');
  const paymentDetailsPresentmentCurrency = jResp.stringOf('paymentDetails.presentmentCurrency');
  const paymentDetailsAllowOvercharge = jResp.stringOf('paymentDetails.allowOvercharge');
  const paymentDetailsExtendExpiration = jResp.stringOf('paymentDetails.extendExpiration');
  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 supplementaryData = jResp.stringOf('supplementaryData');
  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 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 statusDetailsState = jResp.stringOf('statusDetails.state');
  const statusDetailsReasonCode = jResp.stringOf('statusDetails.reasonCode');
  const statusDetailsReasonDescription = jResp.stringOf('statusDetails.reasonDescription');
  const statusDetailsLastUpdatedTimestamp = jResp.stringOf('statusDetails.lastUpdatedTimestamp');
  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 platformId = jResp.stringOf('platformId');
  const chargePermissionId = jResp.stringOf('chargePermissionId');
  const chargeId = jResp.stringOf('chargeId');
  const creationTimestamp = jResp.stringOf('creationTimestamp');
  const expirationTimestamp = jResp.stringOf('expirationTimestamp');
  const storeId = jResp.stringOf('storeId');
  const deliverySpecificationsAddressRestrictionsType = jResp.stringOf('deliverySpecifications.addressRestrictions.type');
  const providerMetadataProviderReferenceId = jResp.stringOf('providerMetadata.providerReferenceId');
  const releaseEnvironment = jResp.stringOf('releaseEnvironment');
  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('constraints');
  while (i < countI) {
    jResp.i = i;
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('deliverySpecifications.specialRestrictions');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deliverySpecifications.specialRestrictions[i]');
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]');
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]');
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]');
    i++;
  }

  i = 0;
  countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]');
    i++;
  }
}