(JavaScript) Amazon Pay - Complete Checkout Session

See more Amazon Pay Examples

Complete Checkout Session after the buyer returns to checkoutResultReturnUrl to finalize the paymentIntent.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#complete-checkout-session

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId/complete" \
// -X POST
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
// -d '{
//     "chargeAmount": {
//         "amount": "14.00",
//         "currencyCode": "USD"
//     }
// }'

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

// {
//   "chargeAmount": {
//     "amount": "14.00",
//     "currencyCode": "USD"
//   }
// }

var json = new CkJsonObject();
json.UpdateString("chargeAmount.amount","14.00");
json.UpdateString("chargeAmount.currencyCode","USD");

// 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 CkPrivateKey();
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
// x-amz-pay-idempotency-key
// Authorization

http.Accept = "application/json";

// To use the live system, replace "sandbox" with "live" in the URL passed to HttpJson.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
success = http.SetUrlVar("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b");
var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}/complete",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
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) {

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

    // Another sample failure response (status code = 422)
    // 	{
    // 	  "reasonCode": "InvalidCheckoutSessionStatus",
    // 	  "message": "You tried to call an operation on a Checkout Session that is in a state where that operation is not allowed"
    // 	}

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

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

// {
//   "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
//   "webCheckoutDetails": null,
//   "chargePermissionType": "OneTime",
//   "recurringMetadata": null,
//   "productType": null,
//   "paymentDetails": null,
//   "merchantMetadata": null,
//   "supplementaryData": null,
//   "buyer": null,
//   "billingAddress": null,
//   "paymentPreferences": [
//     null
//   ],
//   "statusDetails": {
//     "state": "Completed",
//     "reasonCode": null,
//     "reasonDescription": null,
//     "lastUpdatedTimestamp": "20191015T204327Z"
//   },
//   "shippingAddress": null,
//   "platformId": null,
//   "chargePermissionId": "S01-5105180-3221187",
//   "chargeId": "S01-5105180-3221187-C056351",
//   "constraints": [
//     null
//   ],
//   "creationTimestamp": "20191015T204313Z",
//   "expirationTimestamp": null,
//   "storeId": null,
//   "deliverySpecifications": null,
//   "providerMetadata": null,
//   "releaseEnvironment": null
// }

// 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 nullVal;

var checkoutSessionId = jResp.StringOf("checkoutSessionId");
var webCheckoutDetails = jResp.StringOf("webCheckoutDetails");
var chargePermissionType = jResp.StringOf("chargePermissionType");
var recurringMetadata = jResp.StringOf("recurringMetadata");
var productType = jResp.StringOf("productType");
var paymentDetails = jResp.StringOf("paymentDetails");
var merchantMetadata = jResp.StringOf("merchantMetadata");
var supplementaryData = jResp.StringOf("supplementaryData");
var buyer = jResp.StringOf("buyer");
var billingAddress = jResp.StringOf("billingAddress");
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 shippingAddress = jResp.StringOf("shippingAddress");
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 deliverySpecifications = jResp.StringOf("deliverySpecifications");
var providerMetadata = jResp.StringOf("providerMetadata");
var releaseEnvironment = jResp.StringOf("releaseEnvironment");
var i = 0;
var count_i = jResp.SizeOfArray("paymentPreferences");
while (i < count_i) {
    jResp.I = i;
    nullVal = jResp.IsNullOf("paymentPreferences[i]");
    i = i+1;
}

i = 0;
count_i = jResp.SizeOfArray("constraints");
while (i < count_i) {
    jResp.I = i;
    nullVal = jResp.IsNullOf("constraints[i]");
    i = i+1;
}