Lua Requires Chilkat v11.0.0+
Lua
Amazon Pay - Create Checkout Session
See more Amazon Pay Examples
Create a new Amazon Pay Checkout Session.Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local http = chilkat.Http.new()
-- 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": {}
-- }
-- }
-- }
-- }
local json = chilkat.JsonObject.new()
json:update_string("webCheckoutDetails.checkoutReviewReturnUrl", "https://a.com/merchant-review-page")
-- Make sure to use your storeId here:
json:update_string("storeId", "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId")
local i = 0
json.i = i
json:update_string("scopes[i]", "name")
i = i + 1
json.i = i
json:update_string("scopes[i]", "email")
i = i + 1
json.i = i
json:update_string("scopes[i]", "phoneNumber")
i = i + 1
json.i = i
json:update_string("scopes[i]", "billingAddress")
json:update_string("deliverySpecifications.specialRestrictions[0]", "RestrictPOBoxes")
json:update_string("deliverySpecifications.addressRestrictions.type", "Allowed")
json:update_string("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]", "WA")
json:update_string("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]", "95050")
json:update_string("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]", "93405")
json:update_string("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]", "72046")
json:update_string("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]", "72047")
json:update_string("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]", "AP")
json:update_new_object("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.
local privKey = chilkat.PrivateKey.new()
local success = privKey:load_pem_file("C:/someDir/myAmazonPayPrivateKey.pem")
if not success then
print(privKey.last_error_text)
return
end
-- 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.
local publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http:set_auth_private_key(publicKeyId, privKey)
if not success then
print(http.last_error_text)
return
end
-- 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
local resp = chilkat.HttpResponse.new()
success = http:http_json("POST", "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/", json, "application/json", resp)
if not success then
print(http.last_error_text)
return
end
local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false
-- If the status code is not equal to 201, this will display error information.
print("Response Body:")
print(jResp:emit())
local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode ~= 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."
-- }
print("Failed.")
return
end
-- 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
local nullVal = false
local constraintId = ""
local description = ""
local strVal = ""
local checkoutSessionId = jResp:string_of("checkoutSessionId")
local webCheckoutDetailsCheckoutReviewReturnUrl = jResp:string_of("webCheckoutDetails.checkoutReviewReturnUrl")
local webCheckoutDetailsCheckoutResultReturnUrl = jResp:string_of("webCheckoutDetails.checkoutResultReturnUrl")
local webCheckoutDetailsCheckoutCancelUrl = jResp:string_of("webCheckoutDetails.checkoutCancelUrl")
local webCheckoutDetailsAmazonPayRedirectUrl = jResp:string_of("webCheckoutDetails.amazonPayRedirectUrl")
local productType = jResp:string_of("productType")
local chargePermissionType = jResp:string_of("chargePermissionType")
local recurringMetadataFrequencyUnit = jResp:string_of("recurringMetadata.frequency.unit")
local recurringMetadataFrequencyValue = jResp:string_of("recurringMetadata.frequency.value")
local recurringMetadataAmountAmount = jResp:string_of("recurringMetadata.amount.amount")
local recurringMetadataAmountCurrencyCode = jResp:string_of("recurringMetadata.amount.currencyCode")
local paymentDetailsPaymentIntent = jResp:string_of("paymentDetails.paymentIntent")
local paymentDetailsCanHandlePendingAuthorization = jResp:bool_of("paymentDetails.canHandlePendingAuthorization")
local paymentDetailsChargeAmount = jResp:string_of("paymentDetails.chargeAmount")
local paymentDetailsTotalOrderAmount = jResp:string_of("paymentDetails.totalOrderAmount")
local paymentDetailsSoftDescriptor = jResp:string_of("paymentDetails.softDescriptor")
local paymentDetailsPresentmentCurrency = jResp:string_of("paymentDetails.presentmentCurrency")
local paymentDetailsAllowOvercharge = jResp:string_of("paymentDetails.allowOvercharge")
local paymentDetailsExtendExpiration = jResp:string_of("paymentDetails.extendExpiration")
local merchantMetadataMerchantReferenceId = jResp:string_of("merchantMetadata.merchantReferenceId")
local merchantMetadataMerchantStoreName = jResp:string_of("merchantMetadata.merchantStoreName")
local merchantMetadataNoteToBuyer = jResp:string_of("merchantMetadata.noteToBuyer")
local merchantMetadataCustomInformation = jResp:string_of("merchantMetadata.customInformation")
local supplementaryData = jResp:string_of("supplementaryData")
local buyer = jResp:string_of("buyer")
local billingAddress = jResp:string_of("billingAddress")
local statusDetailsState = jResp:string_of("statusDetails.state")
local statusDetailsReasonCode = jResp:string_of("statusDetails.reasonCode")
local statusDetailsReasonDescription = jResp:string_of("statusDetails.reasonDescription")
local statusDetailsLastUpdatedTimestamp = jResp:string_of("statusDetails.lastUpdatedTimestamp")
local shippingAddress = jResp:string_of("shippingAddress")
local platformId = jResp:string_of("platformId")
local chargePermissionId = jResp:string_of("chargePermissionId")
local chargeId = jResp:string_of("chargeId")
local creationTimestamp = jResp:string_of("creationTimestamp")
local expirationTimestamp = jResp:string_of("expirationTimestamp")
local storeId = jResp:string_of("storeId")
local deliverySpecificationsAddressRestrictionsType = jResp:string_of("deliverySpecifications.addressRestrictions.type")
local providerMetadataProviderReferenceId = jResp:string_of("providerMetadata.providerReferenceId")
local releaseEnvironment = jResp:string_of("releaseEnvironment")
i = 0
local count_i = jResp:size_of_array("paymentPreferences")
while i < count_i do
jResp.i = i
nullVal = jResp:is_null_of("paymentPreferences[i]")
i = i + 1
end
i = 0
count_i = jResp:size_of_array("constraints")
while i < count_i do
jResp.i = i
constraintId = jResp:string_of("constraints[i].constraintId")
description = jResp:string_of("constraints[i].description")
i = i + 1
end
i = 0
count_i = jResp:size_of_array("deliverySpecifications.specialRestrictions")
while i < count_i do
jResp.i = i
strVal = jResp:string_of("deliverySpecifications.specialRestrictions[i]")
i = i + 1
end
i = 0
count_i = jResp:size_of_array("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
while i < count_i do
jResp.i = i
strVal = jResp:string_of("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
i = i + 1
end
i = 0
count_i = jResp:size_of_array("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
while i < count_i do
jResp.i = i
strVal = jResp:string_of("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
i = i + 1
end
i = 0
count_i = jResp:size_of_array("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
while i < count_i do
jResp.i = i
strVal = jResp:string_of("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
i = i + 1
end
i = 0
count_i = jResp:size_of_array("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
while i < count_i do
jResp.i = i
strVal = jResp:string_of("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
i = i + 1
end