Lua Requires Chilkat v9.5.0.89+
Lua
Amazon Pay - Get Checkout Session
See more Amazon Pay Examples
Get Checkout Session details includes buyer info, payment instrument details, and shipping address.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/:checkoutSessionId"
-- -X GET
-- -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
-- -H "x-amz-pay-date:20201012T235046Z"
-- Use the following online tool to generate HTTP code from a CURL command
-- Convert a cURL Command to HTTP Source Code
-- 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
-- Authorization
http.accept = "application/json"
local respStatusCode = 0
local sbResponseBody = chilkat.StringBuilder.new()
success = http:set_url_var("sessionId", "62b7d028-6c7c-4a43-b077-3897dff27c5b")
-- To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
-- Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
success = http:quick_get_sb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}", sbResponseBody)
if not success then
-- If the LastStatus is not equal to 0, then we received a response, but it was an error response.
respStatusCode = http.last_status
if respStatusCode ~= 0 then
print("Response Status Code = " .. respStatusCode)
-- 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'"}
print("Response body:")
print(http.last_response_body)
else
print(http.last_error_text)
end
return
end
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false
print("Response Body:")
print(jResp:emit())
respStatusCode = http.last_status
print("Response Status Code = " .. respStatusCode)
-- We expect a 200 status code for success.
-- Note: Some Amazon Pay API calls return 200 for success, others return 201.
if respStatusCode ~= 200 then
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
-- },
-- "chargePermissionType": "Recurring",
-- "recurringMetadata": {
-- "frequency": {
-- "unit": "Month",
-- "value": "1"
-- },
-- "amount": {
-- "amount": "30",
-- "currencyCode": "USD"
-- }
-- },
-- "productType": "PayAndShip",
-- "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": {
-- "buyerId": "buyerId",
-- "name": "name-1",
-- "email": "name@amazon.com",
-- "phoneNumber": "800-000-0000",
-- "primeMembershipTypes": null
-- },
-- "billingAddress": {
-- "name": "Work",
-- "addressLine1": "440 Terry Ave",
-- "addressLine2": "",
-- "addressLine3": "",
-- "city": "Seattle",
-- "county": "King",
-- "district": "Seattle",
-- "stateOrRegion": "WA",
-- "postalCode": "98121",
-- "countryCode": "US"
-- },
-- "paymentPreferences": [
-- {
-- "paymentDescriptor": "Your selected Amazon payment method"
-- }
-- ],
-- "statusDetails": {
-- "state": "Open",
-- "reasonCode": null,
-- "reasonDescription": null,
-- "lastUpdatedTimestamp": "20191015T204327Z"
-- },
-- "shippingAddress": {
-- "name": "Susie Smith",
-- "addressLine1": "10 Ditka Ave",
-- "addressLine2": "Suite 2500",
-- "addressLine3": null,
-- "city": "Chicago",
-- "county": null,
-- "district": null,
-- "stateOrRegion": "IL",
-- "postalCode": "60602",
-- "countryCode": "US",
-- "phoneNumber": "800-000-0000"
-- },
-- "platformId": null,
-- "chargePermissionId": null,
-- "chargeId": null,
-- "constraints": [
-- {
-- "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 paymentDescriptor = ""
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 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 productType = jResp:string_of("productType")
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 buyerBuyerId = jResp:string_of("buyer.buyerId")
local buyerName = jResp:string_of("buyer.name")
local buyerEmail = jResp:string_of("buyer.email")
local buyerPhoneNumber = jResp:string_of("buyer.phoneNumber")
local buyerPrimeMembershipTypes = jResp:string_of("buyer.primeMembershipTypes")
local billingAddressName = jResp:string_of("billingAddress.name")
local billingAddressAddressLine1 = jResp:string_of("billingAddress.addressLine1")
local billingAddressAddressLine2 = jResp:string_of("billingAddress.addressLine2")
local billingAddressAddressLine3 = jResp:string_of("billingAddress.addressLine3")
local billingAddressCity = jResp:string_of("billingAddress.city")
local billingAddressCounty = jResp:string_of("billingAddress.county")
local billingAddressDistrict = jResp:string_of("billingAddress.district")
local billingAddressStateOrRegion = jResp:string_of("billingAddress.stateOrRegion")
local billingAddressPostalCode = jResp:string_of("billingAddress.postalCode")
local billingAddressCountryCode = jResp:string_of("billingAddress.countryCode")
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 shippingAddressName = jResp:string_of("shippingAddress.name")
local shippingAddressAddressLine1 = jResp:string_of("shippingAddress.addressLine1")
local shippingAddressAddressLine2 = jResp:string_of("shippingAddress.addressLine2")
local shippingAddressAddressLine3 = jResp:string_of("shippingAddress.addressLine3")
local shippingAddressCity = jResp:string_of("shippingAddress.city")
local shippingAddressCounty = jResp:string_of("shippingAddress.county")
local shippingAddressDistrict = jResp:string_of("shippingAddress.district")
local shippingAddressStateOrRegion = jResp:string_of("shippingAddress.stateOrRegion")
local shippingAddressPostalCode = jResp:string_of("shippingAddress.postalCode")
local shippingAddressCountryCode = jResp:string_of("shippingAddress.countryCode")
local shippingAddressPhoneNumber = jResp:string_of("shippingAddress.phoneNumber")
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")
local i = 0
local count_i = jResp:size_of_array("paymentPreferences")
while i < count_i do
jResp.i = i
paymentDescriptor = jResp:string_of("paymentPreferences[i].paymentDescriptor")
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