Node.js
Node.js
Amazon Pay - Get Checkout Session
See more Amazon Pay Examples
Get Checkout Session details includes buyer info, payment instrument details, and shipping address.Chilkat Node.js Downloads
NODEJS_PRELUDE
function chilkatExample() {
var success = false;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId"
// -X GET
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code
// 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("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b");
// 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/checkoutSessions/{$sessionId}",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);
// 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("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)
// {
// "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
// "checkoutResultReturnUrl": null,
// "checkoutCancelUrl": null,
// "amazonPayRedirectUrl": null
// },
// "chargePermissionType": "Recurring",
// "recurringMetadata": {
// "frequency": {
// "unit": "Month",
// "value": "1"
// },
// "amount": {
// "amount": "30",
// "currencyCode": "USD"
// }
// },
// "productType": "PayAndShip",
// "paymentDetails": {
// "paymentIntent": null,
// "canHandlePendingAuthorization": false,
// "chargeAmount": null,
// "totalOrderAmount": null,
// "softDescriptor": null,
// "presentmentCurrency": null,
// "allowOvercharge": null,
// "extendExpiration": null
// },
// "merchantMetadata": {
// "merchantReferenceId": null,
// "merchantStoreName": null,
// "noteToBuyer": null,
// "customInformation": null
// },
// "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": "20191015T204327Z"
// },
// "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": [
// {
// "constraintId": "ChargeAmountNotSet",
// "description": "chargeAmount is not set."
// },
// {
// "constraintId": "CheckoutResultReturnUrlNotSet",
// "description": "checkoutResultReturnUrl is not set."
// },
// {
// "constraintId": "PaymentIntentNotSet",
// "description": "paymentIntent is not set."
// }
// ],
// "creationTimestamp": "20191015T204313Z",
// "expirationTimestamp": "20191016T204313Z",
// "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
var paymentDescriptor;
var constraintId;
var description;
var strVal;
var checkoutSessionId = jResp.StringOf("checkoutSessionId");
var webCheckoutDetailsCheckoutReviewReturnUrl = jResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl");
var webCheckoutDetailsCheckoutResultReturnUrl = jResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl");
var webCheckoutDetailsCheckoutCancelUrl = jResp.StringOf("webCheckoutDetails.checkoutCancelUrl");
var webCheckoutDetailsAmazonPayRedirectUrl = jResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl");
var chargePermissionType = jResp.StringOf("chargePermissionType");
var recurringMetadataFrequencyUnit = jResp.StringOf("recurringMetadata.frequency.unit");
var recurringMetadataFrequencyValue = jResp.StringOf("recurringMetadata.frequency.value");
var recurringMetadataAmountAmount = jResp.StringOf("recurringMetadata.amount.amount");
var recurringMetadataAmountCurrencyCode = jResp.StringOf("recurringMetadata.amount.currencyCode");
var productType = jResp.StringOf("productType");
var paymentDetailsPaymentIntent = jResp.StringOf("paymentDetails.paymentIntent");
var paymentDetailsCanHandlePendingAuthorization = jResp.BoolOf("paymentDetails.canHandlePendingAuthorization");
var paymentDetailsChargeAmount = jResp.StringOf("paymentDetails.chargeAmount");
var paymentDetailsTotalOrderAmount = jResp.StringOf("paymentDetails.totalOrderAmount");
var paymentDetailsSoftDescriptor = jResp.StringOf("paymentDetails.softDescriptor");
var paymentDetailsPresentmentCurrency = jResp.StringOf("paymentDetails.presentmentCurrency");
var paymentDetailsAllowOvercharge = jResp.StringOf("paymentDetails.allowOvercharge");
var paymentDetailsExtendExpiration = jResp.StringOf("paymentDetails.extendExpiration");
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 supplementaryData = jResp.StringOf("supplementaryData");
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 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 statusDetailsState = jResp.StringOf("statusDetails.state");
var statusDetailsReasonCode = jResp.StringOf("statusDetails.reasonCode");
var statusDetailsReasonDescription = jResp.StringOf("statusDetails.reasonDescription");
var statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp");
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 platformId = jResp.StringOf("platformId");
var chargePermissionId = jResp.StringOf("chargePermissionId");
var chargeId = jResp.StringOf("chargeId");
var creationTimestamp = jResp.StringOf("creationTimestamp");
var expirationTimestamp = jResp.StringOf("expirationTimestamp");
var storeId = jResp.StringOf("storeId");
var deliverySpecificationsAddressRestrictionsType = jResp.StringOf("deliverySpecifications.addressRestrictions.type");
var providerMetadataProviderReferenceId = jResp.StringOf("providerMetadata.providerReferenceId");
var releaseEnvironment = jResp.StringOf("releaseEnvironment");
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("constraints");
while (i < count_i) {
jResp.I = i;
constraintId = jResp.StringOf("constraints[i].constraintId");
description = jResp.StringOf("constraints[i].description");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.specialRestrictions");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("deliverySpecifications.specialRestrictions[i]");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]");
i = i+1;
}
}
chilkatExample();