(C) Amazon Pay - Create Checkout Session

See more Amazon Pay Examples

Create a new Amazon Pay Checkout Session.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

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

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkPrivateKey.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    int i;
    HCkPrivateKey privKey;
    const char *publicKeyId;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    BOOL nullVal;
    const char *constraintId;
    const char *description;
    const char *strVal;
    const char *checkoutSessionId;
    const char *webCheckoutDetailsCheckoutReviewReturnUrl;
    const char *webCheckoutDetailsCheckoutResultReturnUrl;
    const char *webCheckoutDetailsCheckoutCancelUrl;
    const char *webCheckoutDetailsAmazonPayRedirectUrl;
    const char *productType;
    const char *chargePermissionType;
    const char *recurringMetadataFrequencyUnit;
    const char *recurringMetadataFrequencyValue;
    const char *recurringMetadataAmountAmount;
    const char *recurringMetadataAmountCurrencyCode;
    const char *paymentDetailsPaymentIntent;
    BOOL paymentDetailsCanHandlePendingAuthorization;
    const char *paymentDetailsChargeAmount;
    const char *paymentDetailsTotalOrderAmount;
    const char *paymentDetailsSoftDescriptor;
    const char *paymentDetailsPresentmentCurrency;
    const char *paymentDetailsAllowOvercharge;
    const char *paymentDetailsExtendExpiration;
    const char *merchantMetadataMerchantReferenceId;
    const char *merchantMetadataMerchantStoreName;
    const char *merchantMetadataNoteToBuyer;
    const char *merchantMetadataCustomInformation;
    const char *supplementaryData;
    const char *buyer;
    const char *billingAddress;
    const char *statusDetailsState;
    const char *statusDetailsReasonCode;
    const char *statusDetailsReasonDescription;
    const char *statusDetailsLastUpdatedTimestamp;
    const char *shippingAddress;
    const char *platformId;
    const char *chargePermissionId;
    const char *chargeId;
    const char *creationTimestamp;
    const char *expirationTimestamp;
    const char *storeId;
    const char *deliverySpecificationsAddressRestrictionsType;
    const char *providerMetadataProviderReferenceId;
    const char *releaseEnvironment;
    int count_i;

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

    http = CkHttp_Create();

    // 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": {}
    //       }
    //     }
    //   }
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"webCheckoutDetails.checkoutReviewReturnUrl","https://a.com/merchant-review-page");
    // Make sure to use your storeId here:
    CkJsonObject_UpdateString(json,"storeId","amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId");
    i = 0;
    CkJsonObject_putI(json,i);
    CkJsonObject_UpdateString(json,"scopes[i]","name");
    i = i + 1;
    CkJsonObject_putI(json,i);
    CkJsonObject_UpdateString(json,"scopes[i]","email");
    i = i + 1;
    CkJsonObject_putI(json,i);
    CkJsonObject_UpdateString(json,"scopes[i]","phoneNumber");
    i = i + 1;
    CkJsonObject_putI(json,i);
    CkJsonObject_UpdateString(json,"scopes[i]","billingAddress");
    CkJsonObject_UpdateString(json,"deliverySpecifications.specialRestrictions[0]","RestrictPOBoxes");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.type","Allowed");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]","WA");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]","95050");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]","93405");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]","72046");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]","72047");
    CkJsonObject_UpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]","AP");
    CkJsonObject_UpdateNewObject(json,"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.
    privKey = CkPrivateKey_Create();
    success = CkPrivateKey_LoadPemFile(privKey,"C:/someDir/myAmazonPayPrivateKey.pem");
    if (success == FALSE) {
        printf("%s\n",CkPrivateKey_lastErrorText(privKey));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkPrivateKey_Dispose(privKey);
        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
    publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
    success = CkHttp_SetAuthPrivateKey(http,publicKeyId,privKey);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkPrivateKey_Dispose(privKey);
        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

    CkHttp_putAccept(http,"application/json");

    // To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
    // Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
    resp = CkHttp_PostJson3(http,"https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkPrivateKey_Dispose(privKey);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);
    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    // If the status code is not equal to 201, this will display error information.
    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    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."
        // 	}

        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkPrivateKey_Dispose(privKey);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

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

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

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"constraints");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        constraintId = CkJsonObject_stringOf(jResp,"constraints[i].constraintId");
        description = CkJsonObject_stringOf(jResp,"constraints[i].description");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"deliverySpecifications.specialRestrictions");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"deliverySpecifications.specialRestrictions[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkPrivateKey_Dispose(privKey);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }