DataFlex
DataFlex
Amazon Pay - Create Checkout Session
See more Amazon Pay Examples
Create a new Amazon Pay Checkout Session.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Variant vJson
Handle hoJson
Integer i
Variant vPrivKey
Handle hoPrivKey
String sPublicKeyId
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Boolean iNullVal
String sConstraintId
String sDescription
String sStrVal
String sCheckoutSessionId
String sWebCheckoutDetailsCheckoutReviewReturnUrl
String sWebCheckoutDetailsCheckoutResultReturnUrl
String sWebCheckoutDetailsCheckoutCancelUrl
String sWebCheckoutDetailsAmazonPayRedirectUrl
String sProductType
String sChargePermissionType
String sRecurringMetadataFrequencyUnit
String sRecurringMetadataFrequencyValue
String sRecurringMetadataAmountAmount
String sRecurringMetadataAmountCurrencyCode
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 sBuyer
String sBillingAddress
String sStatusDetailsState
String sStatusDetailsReasonCode
String sStatusDetailsReasonDescription
String sStatusDetailsLastUpdatedTimestamp
String sShippingAddress
String sPlatformId
String sChargePermissionId
String sChargeId
String sCreationTimestamp
String sExpirationTimestamp
String sStoreId
String sDeliverySpecificationsAddressRestrictionsType
String sProviderMetadataProviderReferenceId
String sReleaseEnvironment
Integer iCount_i
String sTemp1
Move False To iSuccess
// 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/" \
// -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": {}
// }
// }
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "webCheckoutDetails.checkoutReviewReturnUrl" "https://a.com/merchant-review-page" To iSuccess
// Make sure to use your storeId here:
Get ComUpdateString Of hoJson "storeId" "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId" To iSuccess
Move 0 To i
Set ComI Of hoJson To i
Get ComUpdateString Of hoJson "scopes[i]" "name" To iSuccess
Move (i + 1) To i
Set ComI Of hoJson To i
Get ComUpdateString Of hoJson "scopes[i]" "email" To iSuccess
Move (i + 1) To i
Set ComI Of hoJson To i
Get ComUpdateString Of hoJson "scopes[i]" "phoneNumber" To iSuccess
Move (i + 1) To i
Set ComI Of hoJson To i
Get ComUpdateString Of hoJson "scopes[i]" "billingAddress" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.specialRestrictions[0]" "RestrictPOBoxes" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.type" "Allowed" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]" "WA" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]" "95050" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]" "93405" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]" "72046" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]" "72047" To iSuccess
Get ComUpdateString Of hoJson "deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]" "AP" To iSuccess
Get ComUpdateNewObject Of hoJson "deliverySpecifications.addressRestrictions.restrictions.JP" To iSuccess
// 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
// x-amz-pay-idempotency-key
// Authorization
Set ComAccept Of hoHttp To "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
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoJson to vJson
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/" vJson "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
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
// If the status code is not equal to 201, this will display error information.
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode <> 201) Begin
// 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."
// }
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
// },
// "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
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 "productType" To sProductType
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 "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" To sBuyer
Get ComStringOf Of hoJResp "billingAddress" To sBillingAddress
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" To sShippingAddress
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 ComIsNullOf Of hoJResp "paymentPreferences[i]" To iNullVal
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