(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL i
LOCAL loPrivKey
LOCAL lcPublicKeyId
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnNullVal
LOCAL lcConstraintId
LOCAL lcDescription
LOCAL lcStrVal
LOCAL lcCheckoutSessionId
LOCAL lcWebCheckoutDetailsCheckoutReviewReturnUrl
LOCAL lcWebCheckoutDetailsCheckoutResultReturnUrl
LOCAL lcWebCheckoutDetailsCheckoutCancelUrl
LOCAL lcWebCheckoutDetailsAmazonPayRedirectUrl
LOCAL lcProductType
LOCAL lcChargePermissionType
LOCAL lcRecurringMetadataFrequencyUnit
LOCAL lcRecurringMetadataFrequencyValue
LOCAL lcRecurringMetadataAmountAmount
LOCAL lcRecurringMetadataAmountCurrencyCode
LOCAL lcPaymentDetailsPaymentIntent
LOCAL lnPaymentDetailsCanHandlePendingAuthorization
LOCAL lcPaymentDetailsChargeAmount
LOCAL lcPaymentDetailsTotalOrderAmount
LOCAL lcPaymentDetailsSoftDescriptor
LOCAL lcPaymentDetailsPresentmentCurrency
LOCAL lcPaymentDetailsAllowOvercharge
LOCAL lcPaymentDetailsExtendExpiration
LOCAL lcMerchantMetadataMerchantReferenceId
LOCAL lcMerchantMetadataMerchantStoreName
LOCAL lcMerchantMetadataNoteToBuyer
LOCAL lcMerchantMetadataCustomInformation
LOCAL lcSupplementaryData
LOCAL lcBuyer
LOCAL lcBillingAddress
LOCAL lcStatusDetailsState
LOCAL lcStatusDetailsReasonCode
LOCAL lcStatusDetailsReasonDescription
LOCAL lcStatusDetailsLastUpdatedTimestamp
LOCAL lcShippingAddress
LOCAL lcPlatformId
LOCAL lcChargePermissionId
LOCAL lcChargeId
LOCAL lcCreationTimestamp
LOCAL lcExpirationTimestamp
LOCAL lcStoreId
LOCAL lcDeliverySpecificationsAddressRestrictionsType
LOCAL lcProviderMetadataProviderReferenceId
LOCAL lcReleaseEnvironment
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.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": {}
*       }
*     }
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("webCheckoutDetails.checkoutReviewReturnUrl","https://a.com/merchant-review-page")
* Make sure to use your storeId here:
loJson.UpdateString("storeId","amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId")
i = 0
loJson.I = i
loJson.UpdateString("scopes[i]","name")
i = i + 1
loJson.I = i
loJson.UpdateString("scopes[i]","email")
i = i + 1
loJson.I = i
loJson.UpdateString("scopes[i]","phoneNumber")
i = i + 1
loJson.I = i
loJson.UpdateString("scopes[i]","billingAddress")
loJson.UpdateString("deliverySpecifications.specialRestrictions[0]","RestrictPOBoxes")
loJson.UpdateString("deliverySpecifications.addressRestrictions.type","Allowed")
loJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]","WA")
loJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]","95050")
loJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]","93405")
loJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]","72046")
loJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]","72047")
loJson.UpdateString("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]","AP")
loJson.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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.PrivateKey')
loPrivKey = CreateObject('Chilkat.PrivateKey')
lnSuccess = loPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
IF (lnSuccess = 0) THEN
    ? loPrivKey.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loPrivKey
    CANCEL
ENDIF

* 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
lcPublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
lnSuccess = loHttp.SetAuthPrivateKey(lcPublicKeyId,loPrivKey)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loPrivKey
    CANCEL
ENDIF

* 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

loHttp.Accept = "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
loResp = loHttp.PostJson3("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loPrivKey
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

* If the status code is not equal to 201, this will display error information.
? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode <> 201) THEN

    * 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."
    * 	}

    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loPrivKey
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcCheckoutSessionId = loJResp.StringOf("checkoutSessionId")
lcWebCheckoutDetailsCheckoutReviewReturnUrl = loJResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
lcWebCheckoutDetailsCheckoutResultReturnUrl = loJResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
lcWebCheckoutDetailsCheckoutCancelUrl = loJResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
lcWebCheckoutDetailsAmazonPayRedirectUrl = loJResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
lcProductType = loJResp.StringOf("productType")
lcChargePermissionType = loJResp.StringOf("chargePermissionType")
lcRecurringMetadataFrequencyUnit = loJResp.StringOf("recurringMetadata.frequency.unit")
lcRecurringMetadataFrequencyValue = loJResp.StringOf("recurringMetadata.frequency.value")
lcRecurringMetadataAmountAmount = loJResp.StringOf("recurringMetadata.amount.amount")
lcRecurringMetadataAmountCurrencyCode = loJResp.StringOf("recurringMetadata.amount.currencyCode")
lcPaymentDetailsPaymentIntent = loJResp.StringOf("paymentDetails.paymentIntent")
lnPaymentDetailsCanHandlePendingAuthorization = loJResp.BoolOf("paymentDetails.canHandlePendingAuthorization")
lcPaymentDetailsChargeAmount = loJResp.StringOf("paymentDetails.chargeAmount")
lcPaymentDetailsTotalOrderAmount = loJResp.StringOf("paymentDetails.totalOrderAmount")
lcPaymentDetailsSoftDescriptor = loJResp.StringOf("paymentDetails.softDescriptor")
lcPaymentDetailsPresentmentCurrency = loJResp.StringOf("paymentDetails.presentmentCurrency")
lcPaymentDetailsAllowOvercharge = loJResp.StringOf("paymentDetails.allowOvercharge")
lcPaymentDetailsExtendExpiration = loJResp.StringOf("paymentDetails.extendExpiration")
lcMerchantMetadataMerchantReferenceId = loJResp.StringOf("merchantMetadata.merchantReferenceId")
lcMerchantMetadataMerchantStoreName = loJResp.StringOf("merchantMetadata.merchantStoreName")
lcMerchantMetadataNoteToBuyer = loJResp.StringOf("merchantMetadata.noteToBuyer")
lcMerchantMetadataCustomInformation = loJResp.StringOf("merchantMetadata.customInformation")
lcSupplementaryData = loJResp.StringOf("supplementaryData")
lcBuyer = loJResp.StringOf("buyer")
lcBillingAddress = loJResp.StringOf("billingAddress")
lcStatusDetailsState = loJResp.StringOf("statusDetails.state")
lcStatusDetailsReasonCode = loJResp.StringOf("statusDetails.reasonCode")
lcStatusDetailsReasonDescription = loJResp.StringOf("statusDetails.reasonDescription")
lcStatusDetailsLastUpdatedTimestamp = loJResp.StringOf("statusDetails.lastUpdatedTimestamp")
lcShippingAddress = loJResp.StringOf("shippingAddress")
lcPlatformId = loJResp.StringOf("platformId")
lcChargePermissionId = loJResp.StringOf("chargePermissionId")
lcChargeId = loJResp.StringOf("chargeId")
lcCreationTimestamp = loJResp.StringOf("creationTimestamp")
lcExpirationTimestamp = loJResp.StringOf("expirationTimestamp")
lcStoreId = loJResp.StringOf("storeId")
lcDeliverySpecificationsAddressRestrictionsType = loJResp.StringOf("deliverySpecifications.addressRestrictions.type")
lcProviderMetadataProviderReferenceId = loJResp.StringOf("providerMetadata.providerReferenceId")
lcReleaseEnvironment = loJResp.StringOf("releaseEnvironment")
i = 0
lnCount_i = loJResp.SizeOfArray("paymentPreferences")
DO WHILE i < lnCount_i
    loJResp.I = i
    lnNullVal = loJResp.IsNullOf("paymentPreferences[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("constraints")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcConstraintId = loJResp.StringOf("constraints[i].constraintId")
    lcDescription = loJResp.StringOf("constraints[i].description")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("deliverySpecifications.specialRestrictions")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("deliverySpecifications.specialRestrictions[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loPrivKey
RELEASE loSbResponseBody
RELEASE loJResp