(DataFlex) 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

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vPrivKey
    Handle hoPrivKey
    String sPublicKeyId
    Integer iRespStatusCode
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    String sPaymentDescriptor
    String sConstraintId
    String sDescription
    String sStrVal
    String sCheckoutSessionId
    String sWebCheckoutDetailsCheckoutReviewReturnUrl
    String sWebCheckoutDetailsCheckoutResultReturnUrl
    String sWebCheckoutDetailsCheckoutCancelUrl
    String sWebCheckoutDetailsAmazonPayRedirectUrl
    String sChargePermissionType
    String sRecurringMetadataFrequencyUnit
    String sRecurringMetadataFrequencyValue
    String sRecurringMetadataAmountAmount
    String sRecurringMetadataAmountCurrencyCode
    String sProductType
    String sPaymentDetailsPaymentIntent
    Boolean iPaymentDetailsCanHandlePendingAuthorization
    String sPaymentDetailsChargeAmount
    String sPaymentDetailsTotalOrderAmount
    String sPaymentDetailsSoftDescriptor
    String sPaymentDetailsPresentmentCurrency
    String sPaymentDetailsAllowOvercharge
    String sPaymentDetailsExtendExpiration
    String sMerchantMetadataMerchantReferenceId
    String sMerchantMetadataMerchantStoreName
    String sMerchantMetadataNoteToBuyer
    String sMerchantMetadataCustomInformation
    String sSupplementaryData
    String sBuyerBuyerId
    String sBuyerName
    String sBuyerEmail
    String sBuyerPhoneNumber
    String sBuyerPrimeMembershipTypes
    String sBillingAddressName
    String sBillingAddressAddressLine1
    String sBillingAddressAddressLine2
    String sBillingAddressAddressLine3
    String sBillingAddressCity
    String sBillingAddressCounty
    String sBillingAddressDistrict
    String sBillingAddressStateOrRegion
    String sBillingAddressPostalCode
    String sBillingAddressCountryCode
    String sStatusDetailsState
    String sStatusDetailsReasonCode
    String sStatusDetailsReasonDescription
    String sStatusDetailsLastUpdatedTimestamp
    String sShippingAddressName
    String sShippingAddressAddressLine1
    String sShippingAddressAddressLine2
    String sShippingAddressAddressLine3
    String sShippingAddressCity
    String sShippingAddressCounty
    String sShippingAddressDistrict
    String sShippingAddressStateOrRegion
    String sShippingAddressPostalCode
    String sShippingAddressCountryCode
    String sShippingAddressPhoneNumber
    String sPlatformId
    String sChargePermissionId
    String sChargeId
    String sCreationTimestamp
    String sExpirationTimestamp
    String sStoreId
    String sDeliverySpecificationsAddressRestrictionsType
    String sProviderMetadataProviderReferenceId
    String sReleaseEnvironment
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // 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.
    Get Create (RefClass(cComChilkatPrivateKey)) To hoPrivKey
    If (Not(IsComObjectCreated(hoPrivKey))) Begin
        Send CreateComObject of hoPrivKey
    End
    Get ComLoadPemFile Of hoPrivKey "C:/someDir/myAmazonPayPrivateKey.pem" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPrivKey To sTemp1
        Showln sTemp1
        Procedure_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.
    // Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
    Move "SANDBOX-AHEGSJCM3L2S637RBGABLAFW" To sPublicKeyId
    Get pvComObject of hoPrivKey to vPrivKey
    Get ComSetAuthPrivateKey Of hoHttp sPublicKeyId vPrivKey To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_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

    Set ComAccept Of hoHttp To "application/json"

    Move 0 To iRespStatusCode

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get ComSetUrlVar Of hoHttp "sessionId" "62b7d028-6c7c-4a43-b077-3897dff27c5b" To iSuccess
    // 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
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
        Get ComLastStatus Of hoHttp To iRespStatusCode
        If (iRespStatusCode <> 0) Begin
            Showln "Response Status Code = " iRespStatusCode
            // 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'"}

            Showln "Response body:"
            Get ComLastResponseBody Of hoHttp To sTemp1
            Showln sTemp1
        End
        Else Begin
            Get ComLastErrorText Of hoHttp To sTemp1
            Showln sTemp1
        End

        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    // We expect a 200 status code for success.
    // Note: Some Amazon Pay API calls return 200 for success, others return 201.
    If (iRespStatusCode <> 200) Begin
        Showln "Failed."
        Procedure_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

    Get ComStringOf Of hoJResp "checkoutSessionId" To sCheckoutSessionId
    Get ComStringOf Of hoJResp "webCheckoutDetails.checkoutReviewReturnUrl" To sWebCheckoutDetailsCheckoutReviewReturnUrl
    Get ComStringOf Of hoJResp "webCheckoutDetails.checkoutResultReturnUrl" To sWebCheckoutDetailsCheckoutResultReturnUrl
    Get ComStringOf Of hoJResp "webCheckoutDetails.checkoutCancelUrl" To sWebCheckoutDetailsCheckoutCancelUrl
    Get ComStringOf Of hoJResp "webCheckoutDetails.amazonPayRedirectUrl" To sWebCheckoutDetailsAmazonPayRedirectUrl
    Get ComStringOf Of hoJResp "chargePermissionType" To sChargePermissionType
    Get ComStringOf Of hoJResp "recurringMetadata.frequency.unit" To sRecurringMetadataFrequencyUnit
    Get ComStringOf Of hoJResp "recurringMetadata.frequency.value" To sRecurringMetadataFrequencyValue
    Get ComStringOf Of hoJResp "recurringMetadata.amount.amount" To sRecurringMetadataAmountAmount
    Get ComStringOf Of hoJResp "recurringMetadata.amount.currencyCode" To sRecurringMetadataAmountCurrencyCode
    Get ComStringOf Of hoJResp "productType" To sProductType
    Get ComStringOf Of hoJResp "paymentDetails.paymentIntent" To sPaymentDetailsPaymentIntent
    Get ComBoolOf Of hoJResp "paymentDetails.canHandlePendingAuthorization" To iPaymentDetailsCanHandlePendingAuthorization
    Get ComStringOf Of hoJResp "paymentDetails.chargeAmount" To sPaymentDetailsChargeAmount
    Get ComStringOf Of hoJResp "paymentDetails.totalOrderAmount" To sPaymentDetailsTotalOrderAmount
    Get ComStringOf Of hoJResp "paymentDetails.softDescriptor" To sPaymentDetailsSoftDescriptor
    Get ComStringOf Of hoJResp "paymentDetails.presentmentCurrency" To sPaymentDetailsPresentmentCurrency
    Get ComStringOf Of hoJResp "paymentDetails.allowOvercharge" To sPaymentDetailsAllowOvercharge
    Get ComStringOf Of hoJResp "paymentDetails.extendExpiration" To sPaymentDetailsExtendExpiration
    Get ComStringOf Of hoJResp "merchantMetadata.merchantReferenceId" To sMerchantMetadataMerchantReferenceId
    Get ComStringOf Of hoJResp "merchantMetadata.merchantStoreName" To sMerchantMetadataMerchantStoreName
    Get ComStringOf Of hoJResp "merchantMetadata.noteToBuyer" To sMerchantMetadataNoteToBuyer
    Get ComStringOf Of hoJResp "merchantMetadata.customInformation" To sMerchantMetadataCustomInformation
    Get ComStringOf Of hoJResp "supplementaryData" To sSupplementaryData
    Get ComStringOf Of hoJResp "buyer.buyerId" To sBuyerBuyerId
    Get ComStringOf Of hoJResp "buyer.name" To sBuyerName
    Get ComStringOf Of hoJResp "buyer.email" To sBuyerEmail
    Get ComStringOf Of hoJResp "buyer.phoneNumber" To sBuyerPhoneNumber
    Get ComStringOf Of hoJResp "buyer.primeMembershipTypes" To sBuyerPrimeMembershipTypes
    Get ComStringOf Of hoJResp "billingAddress.name" To sBillingAddressName
    Get ComStringOf Of hoJResp "billingAddress.addressLine1" To sBillingAddressAddressLine1
    Get ComStringOf Of hoJResp "billingAddress.addressLine2" To sBillingAddressAddressLine2
    Get ComStringOf Of hoJResp "billingAddress.addressLine3" To sBillingAddressAddressLine3
    Get ComStringOf Of hoJResp "billingAddress.city" To sBillingAddressCity
    Get ComStringOf Of hoJResp "billingAddress.county" To sBillingAddressCounty
    Get ComStringOf Of hoJResp "billingAddress.district" To sBillingAddressDistrict
    Get ComStringOf Of hoJResp "billingAddress.stateOrRegion" To sBillingAddressStateOrRegion
    Get ComStringOf Of hoJResp "billingAddress.postalCode" To sBillingAddressPostalCode
    Get ComStringOf Of hoJResp "billingAddress.countryCode" To sBillingAddressCountryCode
    Get ComStringOf Of hoJResp "statusDetails.state" To sStatusDetailsState
    Get ComStringOf Of hoJResp "statusDetails.reasonCode" To sStatusDetailsReasonCode
    Get ComStringOf Of hoJResp "statusDetails.reasonDescription" To sStatusDetailsReasonDescription
    Get ComStringOf Of hoJResp "statusDetails.lastUpdatedTimestamp" To sStatusDetailsLastUpdatedTimestamp
    Get ComStringOf Of hoJResp "shippingAddress.name" To sShippingAddressName
    Get ComStringOf Of hoJResp "shippingAddress.addressLine1" To sShippingAddressAddressLine1
    Get ComStringOf Of hoJResp "shippingAddress.addressLine2" To sShippingAddressAddressLine2
    Get ComStringOf Of hoJResp "shippingAddress.addressLine3" To sShippingAddressAddressLine3
    Get ComStringOf Of hoJResp "shippingAddress.city" To sShippingAddressCity
    Get ComStringOf Of hoJResp "shippingAddress.county" To sShippingAddressCounty
    Get ComStringOf Of hoJResp "shippingAddress.district" To sShippingAddressDistrict
    Get ComStringOf Of hoJResp "shippingAddress.stateOrRegion" To sShippingAddressStateOrRegion
    Get ComStringOf Of hoJResp "shippingAddress.postalCode" To sShippingAddressPostalCode
    Get ComStringOf Of hoJResp "shippingAddress.countryCode" To sShippingAddressCountryCode
    Get ComStringOf Of hoJResp "shippingAddress.phoneNumber" To sShippingAddressPhoneNumber
    Get ComStringOf Of hoJResp "platformId" To sPlatformId
    Get ComStringOf Of hoJResp "chargePermissionId" To sChargePermissionId
    Get ComStringOf Of hoJResp "chargeId" To sChargeId
    Get ComStringOf Of hoJResp "creationTimestamp" To sCreationTimestamp
    Get ComStringOf Of hoJResp "expirationTimestamp" To sExpirationTimestamp
    Get ComStringOf Of hoJResp "storeId" To sStoreId
    Get ComStringOf Of hoJResp "deliverySpecifications.addressRestrictions.type" To sDeliverySpecificationsAddressRestrictionsType
    Get ComStringOf Of hoJResp "providerMetadata.providerReferenceId" To sProviderMetadataProviderReferenceId
    Get ComStringOf Of hoJResp "releaseEnvironment" To sReleaseEnvironment
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "paymentPreferences" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "paymentPreferences[i].paymentDescriptor" To sPaymentDescriptor
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "constraints" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "constraints[i].constraintId" To sConstraintId
        Get ComStringOf Of hoJResp "constraints[i].description" To sDescription
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "deliverySpecifications.specialRestrictions" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "deliverySpecifications.specialRestrictions[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]" To sStrVal
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]" To sStrVal
        Move (i + 1) To i
    Loop



End_Procedure