(Visual FoxPro) Amazon Pay - Get Checkout Session

See more Amazon Pay Examples

Get Checkout Session details includes buyer info, payment instrument details, and shipping address.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loPrivKey
LOCAL lcPublicKeyId
LOCAL lnRespStatusCode
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lcPaymentDescriptor
LOCAL lcConstraintId
LOCAL lcDescription
LOCAL lcStrVal
LOCAL lcCheckoutSessionId
LOCAL lcWebCheckoutDetailsCheckoutReviewReturnUrl
LOCAL lcWebCheckoutDetailsCheckoutResultReturnUrl
LOCAL lcWebCheckoutDetailsCheckoutCancelUrl
LOCAL lcWebCheckoutDetailsAmazonPayRedirectUrl
LOCAL lcChargePermissionType
LOCAL lcRecurringMetadataFrequencyUnit
LOCAL lcRecurringMetadataFrequencyValue
LOCAL lcRecurringMetadataAmountAmount
LOCAL lcRecurringMetadataAmountCurrencyCode
LOCAL lcProductType
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 lcBuyerBuyerId
LOCAL lcBuyerName
LOCAL lcBuyerEmail
LOCAL lcBuyerPhoneNumber
LOCAL lcBuyerPrimeMembershipTypes
LOCAL lcBillingAddressName
LOCAL lcBillingAddressAddressLine1
LOCAL lcBillingAddressAddressLine2
LOCAL lcBillingAddressAddressLine3
LOCAL lcBillingAddressCity
LOCAL lcBillingAddressCounty
LOCAL lcBillingAddressDistrict
LOCAL lcBillingAddressStateOrRegion
LOCAL lcBillingAddressPostalCode
LOCAL lcBillingAddressCountryCode
LOCAL lcStatusDetailsState
LOCAL lcStatusDetailsReasonCode
LOCAL lcStatusDetailsReasonDescription
LOCAL lcStatusDetailsLastUpdatedTimestamp
LOCAL lcShippingAddressName
LOCAL lcShippingAddressAddressLine1
LOCAL lcShippingAddressAddressLine2
LOCAL lcShippingAddressAddressLine3
LOCAL lcShippingAddressCity
LOCAL lcShippingAddressCounty
LOCAL lcShippingAddressDistrict
LOCAL lcShippingAddressStateOrRegion
LOCAL lcShippingAddressPostalCode
LOCAL lcShippingAddressCountryCode
LOCAL lcShippingAddressPhoneNumber
LOCAL lcPlatformId
LOCAL lcChargePermissionId
LOCAL lcChargeId
LOCAL lcCreationTimestamp
LOCAL lcExpirationTimestamp
LOCAL lcStoreId
LOCAL lcDeliverySpecificationsAddressRestrictionsType
LOCAL lcProviderMetadataProviderReferenceId
LOCAL lcReleaseEnvironment
LOCAL i
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/: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.
* 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 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 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
* Authorization

loHttp.Accept = "application/json"

lnRespStatusCode = 0

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.SetUrlVar("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
lnSuccess = loHttp.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",loSbResponseBody)
IF (lnSuccess = 0) THEN
    * If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    lnRespStatusCode = loHttp.LastStatus
    IF (lnRespStatusCode <> 0) THEN
        ? "Response Status Code = " + STR(lnRespStatusCode)
        * 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'"}

        ? "Response body:"
        ? loHttp.LastResponseBody
    ELSE
        ? loHttp.LastErrorText
    ENDIF

    RELEASE loHttp
    RELEASE loPrivKey
    RELEASE loSbResponseBody
    CANCEL
ENDIF

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

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
* We expect a 200 status code for success.
* Note: Some Amazon Pay API calls return 200 for success, others return 201.
IF (lnRespStatusCode <> 200) THEN
    ? "Failed."
    RELEASE loHttp
    RELEASE loPrivKey
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

lcCheckoutSessionId = loJResp.StringOf("checkoutSessionId")
lcWebCheckoutDetailsCheckoutReviewReturnUrl = loJResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
lcWebCheckoutDetailsCheckoutResultReturnUrl = loJResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
lcWebCheckoutDetailsCheckoutCancelUrl = loJResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
lcWebCheckoutDetailsAmazonPayRedirectUrl = loJResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
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")
lcProductType = loJResp.StringOf("productType")
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")
lcBuyerBuyerId = loJResp.StringOf("buyer.buyerId")
lcBuyerName = loJResp.StringOf("buyer.name")
lcBuyerEmail = loJResp.StringOf("buyer.email")
lcBuyerPhoneNumber = loJResp.StringOf("buyer.phoneNumber")
lcBuyerPrimeMembershipTypes = loJResp.StringOf("buyer.primeMembershipTypes")
lcBillingAddressName = loJResp.StringOf("billingAddress.name")
lcBillingAddressAddressLine1 = loJResp.StringOf("billingAddress.addressLine1")
lcBillingAddressAddressLine2 = loJResp.StringOf("billingAddress.addressLine2")
lcBillingAddressAddressLine3 = loJResp.StringOf("billingAddress.addressLine3")
lcBillingAddressCity = loJResp.StringOf("billingAddress.city")
lcBillingAddressCounty = loJResp.StringOf("billingAddress.county")
lcBillingAddressDistrict = loJResp.StringOf("billingAddress.district")
lcBillingAddressStateOrRegion = loJResp.StringOf("billingAddress.stateOrRegion")
lcBillingAddressPostalCode = loJResp.StringOf("billingAddress.postalCode")
lcBillingAddressCountryCode = loJResp.StringOf("billingAddress.countryCode")
lcStatusDetailsState = loJResp.StringOf("statusDetails.state")
lcStatusDetailsReasonCode = loJResp.StringOf("statusDetails.reasonCode")
lcStatusDetailsReasonDescription = loJResp.StringOf("statusDetails.reasonDescription")
lcStatusDetailsLastUpdatedTimestamp = loJResp.StringOf("statusDetails.lastUpdatedTimestamp")
lcShippingAddressName = loJResp.StringOf("shippingAddress.name")
lcShippingAddressAddressLine1 = loJResp.StringOf("shippingAddress.addressLine1")
lcShippingAddressAddressLine2 = loJResp.StringOf("shippingAddress.addressLine2")
lcShippingAddressAddressLine3 = loJResp.StringOf("shippingAddress.addressLine3")
lcShippingAddressCity = loJResp.StringOf("shippingAddress.city")
lcShippingAddressCounty = loJResp.StringOf("shippingAddress.county")
lcShippingAddressDistrict = loJResp.StringOf("shippingAddress.district")
lcShippingAddressStateOrRegion = loJResp.StringOf("shippingAddress.stateOrRegion")
lcShippingAddressPostalCode = loJResp.StringOf("shippingAddress.postalCode")
lcShippingAddressCountryCode = loJResp.StringOf("shippingAddress.countryCode")
lcShippingAddressPhoneNumber = loJResp.StringOf("shippingAddress.phoneNumber")
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
    lcPaymentDescriptor = loJResp.StringOf("paymentPreferences[i].paymentDescriptor")
    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 loPrivKey
RELEASE loSbResponseBody
RELEASE loJResp