Sample code for 30+ languages & platforms
C++

Amazon Pay - Create Checkout Session

See more Amazon Pay Examples

Create a new Amazon Pay Checkout Session.

Chilkat C++ Downloads

C++
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkPrivateKey.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkHttp http;

    //  Implements the following CURL command:

    //  curl "https://pay-api.amazon.com/:version/checkoutSessions/" \
    //  -X POST
    //  -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
    //  -H "x-amz-pay-date:20201012T235046Z"
    //  -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
    //  -d '{
    //      "webCheckoutDetails": {
    //          "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
    //      },
    //      "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
    //      "scopes": ["name", "email", "phoneNumber", "billingAddress"],
    //      "deliverySpecifications": {
    //          "specialRestrictions": ["RestrictPOBoxes"],
    //          "addressRestrictions": {
    //              "type": "Allowed",
    //              "restrictions": {
    //                  "US": {
    //                      "statesOrRegions": ["WA"],
    //                      "zipCodes": ["95050", "93405"]
    //                  },
    //                  "GB": {
    //                      "zipCodes": ["72046", "72047"]
    //                  },
    //                  "IN": {
    //                      "statesOrRegions": ["AP"]
    //                  },
    //                  "JP": {}
    //              }
    //          }
    //      }
    //  }'

    //  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": {
    //      "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
    //    },
    //    "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
    //    "scopes": [
    //      "name",
    //      "email",
    //      "phoneNumber",
    //      "billingAddress"
    //    ],
    //    "deliverySpecifications": {
    //      "specialRestrictions": [
    //        "RestrictPOBoxes"
    //      ],
    //      "addressRestrictions": {
    //        "type": "Allowed",
    //        "restrictions": {
    //          "US": {
    //            "statesOrRegions": [
    //              "WA"
    //            ],
    //            "zipCodes": [
    //              "95050",
    //              "93405"
    //            ]
    //          },
    //          "GB": {
    //            "zipCodes": [
    //              "72046",
    //              "72047"
    //            ]
    //          },
    //          "IN": {
    //            "statesOrRegions": [
    //              "AP"
    //            ]
    //          },
    //          "JP": {}
    //        }
    //      }
    //    }
    //  }

    CkJsonObject json;
    json.UpdateString("webCheckoutDetails.checkoutReviewReturnUrl","https://a.com/merchant-review-page");
    //  Make sure to use your storeId here:
    json.UpdateString("storeId","amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId");
    int i = 0;
    json.put_I(i);
    json.UpdateString("scopes[i]","name");
    i = i + 1;
    json.put_I(i);
    json.UpdateString("scopes[i]","email");
    i = i + 1;
    json.put_I(i);
    json.UpdateString("scopes[i]","phoneNumber");
    i = i + 1;
    json.put_I(i);
    json.UpdateString("scopes[i]","billingAddress");
    json.UpdateString("deliverySpecifications.specialRestrictions[0]","RestrictPOBoxes");
    json.UpdateString("deliverySpecifications.addressRestrictions.type","Allowed");
    json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]","WA");
    json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]","95050");
    json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]","93405");
    json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]","72046");
    json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]","72047");
    json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]","AP");
    json.UpdateNewObject("deliverySpecifications.addressRestrictions.restrictions.JP");

    //  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.
    CkPrivateKey privKey;
    success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
    if (success == false) {
        std::cout << privKey.lastErrorText() << "\r\n";
        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 char *publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
    success = http.SetAuthPrivateKey(publicKeyId,privKey);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        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.put_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
    CkHttpResponse resp;
    success = http.HttpJson("POST","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/",json,"application/json",resp);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp.GetBodySb(sbResponseBody);
    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    //  If the status code is not equal to 201, this will display error information.
    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp.get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode != 201) {

        //  The jResp would've contained an error message, similar to this:
        //  	{
        //  	  "reasonCode": "InvalidHeaderValue",
        //  	  "message": "The value AF2EGWREIPHV2S2TUFFBRDGM provided for PublicKeyId is invalid. Please verify that you are using the PublicKeyId in the correct region and environment."
        //  	}

        std::cout << "Failed." << "\r\n";
        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
    //    },
    //    "productType": "PayAndShip",
    //    "chargePermissionType": "Recurring",
    //    "recurringMetadata": {
    //      "frequency": {
    //        "unit": "Month",
    //        "value": "1"
    //      },
    //      "amount": {
    //        "amount": "30",
    //        "currencyCode": "USD"
    //      }
    //    },
    //    "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": null,
    //    "billingAddress": null,
    //    "paymentPreferences": [
    //      null
    //    ],
    //    "statusDetails": {
    //      "state": "Open",
    //      "reasonCode": null,
    //      "reasonDescription": null,
    //      "lastUpdatedTimestamp": "20191015T204327Z"
    //    },
    //    "shippingAddress": null,
    //    "platformId": null,
    //    "chargePermissionId": null,
    //    "chargeId": null,
    //    "constraints": [
    //      {
    //        "constraintId": "BuyerNotAssociated",
    //        "description": "There is no buyer associated with the Checkout Session. Return the checkout session id to the Amazon Pay Button to allow buyer to login."
    //      },
    //      {
    //        "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

    //  Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    //  See this example explaining how this memory should be used: const char * functions.

    bool nullVal;
    const char *constraintId = 0;
    const char *description = 0;
    const char *strVal = 0;

    const char *checkoutSessionId = jResp.stringOf("checkoutSessionId");
    const char *webCheckoutDetailsCheckoutReviewReturnUrl = jResp.stringOf("webCheckoutDetails.checkoutReviewReturnUrl");
    const char *webCheckoutDetailsCheckoutResultReturnUrl = jResp.stringOf("webCheckoutDetails.checkoutResultReturnUrl");
    const char *webCheckoutDetailsCheckoutCancelUrl = jResp.stringOf("webCheckoutDetails.checkoutCancelUrl");
    const char *webCheckoutDetailsAmazonPayRedirectUrl = jResp.stringOf("webCheckoutDetails.amazonPayRedirectUrl");
    const char *productType = jResp.stringOf("productType");
    const char *chargePermissionType = jResp.stringOf("chargePermissionType");
    const char *recurringMetadataFrequencyUnit = jResp.stringOf("recurringMetadata.frequency.unit");
    const char *recurringMetadataFrequencyValue = jResp.stringOf("recurringMetadata.frequency.value");
    const char *recurringMetadataAmountAmount = jResp.stringOf("recurringMetadata.amount.amount");
    const char *recurringMetadataAmountCurrencyCode = jResp.stringOf("recurringMetadata.amount.currencyCode");
    const char *paymentDetailsPaymentIntent = jResp.stringOf("paymentDetails.paymentIntent");
    bool paymentDetailsCanHandlePendingAuthorization = jResp.BoolOf("paymentDetails.canHandlePendingAuthorization");
    const char *paymentDetailsChargeAmount = jResp.stringOf("paymentDetails.chargeAmount");
    const char *paymentDetailsTotalOrderAmount = jResp.stringOf("paymentDetails.totalOrderAmount");
    const char *paymentDetailsSoftDescriptor = jResp.stringOf("paymentDetails.softDescriptor");
    const char *paymentDetailsPresentmentCurrency = jResp.stringOf("paymentDetails.presentmentCurrency");
    const char *paymentDetailsAllowOvercharge = jResp.stringOf("paymentDetails.allowOvercharge");
    const char *paymentDetailsExtendExpiration = jResp.stringOf("paymentDetails.extendExpiration");
    const char *merchantMetadataMerchantReferenceId = jResp.stringOf("merchantMetadata.merchantReferenceId");
    const char *merchantMetadataMerchantStoreName = jResp.stringOf("merchantMetadata.merchantStoreName");
    const char *merchantMetadataNoteToBuyer = jResp.stringOf("merchantMetadata.noteToBuyer");
    const char *merchantMetadataCustomInformation = jResp.stringOf("merchantMetadata.customInformation");
    const char *supplementaryData = jResp.stringOf("supplementaryData");
    const char *buyer = jResp.stringOf("buyer");
    const char *billingAddress = jResp.stringOf("billingAddress");
    const char *statusDetailsState = jResp.stringOf("statusDetails.state");
    const char *statusDetailsReasonCode = jResp.stringOf("statusDetails.reasonCode");
    const char *statusDetailsReasonDescription = jResp.stringOf("statusDetails.reasonDescription");
    const char *statusDetailsLastUpdatedTimestamp = jResp.stringOf("statusDetails.lastUpdatedTimestamp");
    const char *shippingAddress = jResp.stringOf("shippingAddress");
    const char *platformId = jResp.stringOf("platformId");
    const char *chargePermissionId = jResp.stringOf("chargePermissionId");
    const char *chargeId = jResp.stringOf("chargeId");
    const char *creationTimestamp = jResp.stringOf("creationTimestamp");
    const char *expirationTimestamp = jResp.stringOf("expirationTimestamp");
    const char *storeId = jResp.stringOf("storeId");
    const char *deliverySpecificationsAddressRestrictionsType = jResp.stringOf("deliverySpecifications.addressRestrictions.type");
    const char *providerMetadataProviderReferenceId = jResp.stringOf("providerMetadata.providerReferenceId");
    const char *releaseEnvironment = jResp.stringOf("releaseEnvironment");
    i = 0;
    int count_i = jResp.SizeOfArray("paymentPreferences");
    while (i < count_i) {
        jResp.put_I(i);
        nullVal = jResp.IsNullOf("paymentPreferences[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("constraints");
    while (i < count_i) {
        jResp.put_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.put_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.put_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.put_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.put_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.put_I(i);
        strVal = jResp.stringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]");
        i = i + 1;
    }
    }