Xojo Plugin
Xojo Plugin
Amazon Pay - Update Checkout Session
See more Amazon Pay Examples
Update the Checkout Session with transaction details.Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId" \
// -X PATCH
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
// "webCheckoutDetails": {
// "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
// },
// "paymentDetails": {
// "paymentIntent": "AuthorizeWithCapture",
// "canHandlePendingAuthorization":false,
// "softDescriptor": "Descriptor",
// "chargeAmount": {
// "amount": "1",
// "currencyCode": "USD"
// }
// },
// "merchantMetadata": {
// "merchantReferenceId": "Merchant reference ID",
// "merchantStoreName": "Merchant store name",
// "noteToBuyer": "Note to buyer",
// "customInformation": "Custom information"
// }
// }'
// 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": {
// "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
// },
// "paymentDetails": {
// "paymentIntent": "AuthorizeWithCapture",
// "canHandlePendingAuthorization": false,
// "softDescriptor": "Descriptor",
// "chargeAmount": {
// "amount": "1",
// "currencyCode": "USD"
// }
// },
// "merchantMetadata": {
// "merchantReferenceId": "Merchant reference ID",
// "merchantStoreName": "Merchant store name",
// "noteToBuyer": "Note to buyer",
// "customInformation": "Custom information"
// }
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("webCheckoutDetails.checkoutResultReturnUrl","https://a.com/merchant-confirm-page")
success = json.UpdateString("paymentDetails.paymentIntent","AuthorizeWithCapture")
success = json.UpdateBool("paymentDetails.canHandlePendingAuthorization",False)
success = json.UpdateString("paymentDetails.softDescriptor","Descriptor")
success = json.UpdateString("paymentDetails.chargeAmount.amount","1")
success = json.UpdateString("paymentDetails.chargeAmount.currencyCode","USD")
success = json.UpdateString("merchantMetadata.merchantReferenceId","Merchant reference ID")
success = json.UpdateString("merchantMetadata.merchantStoreName","Merchant store name")
success = json.UpdateString("merchantMetadata.noteToBuyer","Note to buyer")
success = json.UpdateString("merchantMetadata.customInformation","Custom information")
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
// 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.
Dim privKey As New Chilkat.PrivateKey
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If (success = False) Then
System.DebugLog(privKey.LastErrorText)
Return
End If
// 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
Dim publicKeyId As String
publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
// 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"
success = http.SetUrlVar("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b")
// To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
Dim resp As New Chilkat.HttpResponse
success = http.HttpSb("PATCH","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",sbRequestBody,"utf-8","application/json",resp)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
// If the status code is not equal to 200, this will display error information.
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
// 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'"
// }
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
// "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
// "checkoutCancelUrl": null,
// "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
// },
// "productType": "PayAndShip",
// "paymentDetails": {
// "paymentIntent": "AuthorizeWithCapture",
// "canHandlePendingAuthorization": false,
// "chargeAmount": {
// "amount": "1",
// "currencyCode": "USD"
// },
// "totalOrderAmount": null,
// "softDescriptor": "Descriptor",
// "presentmentCurrency": "USD",
// "allowOvercharge": null,
// "extendExpiration": null
// },
// "merchantMetadata": {
// "merchantReferenceId": "Merchant reference ID",
// "merchantStoreName": "Merchant store name",
// "noteToBuyer": "Note to buyer",
// "customInformation": "Custom information"
// },
// "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": "20191015T195703Z"
// },
// "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": [
// ],
// "creationTimestamp": "20191015T195655Z",
// "expirationTimestamp": "20191016T195655Z",
// "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
Dim paymentDescriptor As String
Dim strVal As String
Dim checkoutSessionId As String
checkoutSessionId = jResp.StringOf("checkoutSessionId")
Dim webCheckoutDetailsCheckoutReviewReturnUrl As String
webCheckoutDetailsCheckoutReviewReturnUrl = jResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
Dim webCheckoutDetailsCheckoutResultReturnUrl As String
webCheckoutDetailsCheckoutResultReturnUrl = jResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
Dim webCheckoutDetailsCheckoutCancelUrl As String
webCheckoutDetailsCheckoutCancelUrl = jResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
Dim webCheckoutDetailsAmazonPayRedirectUrl As String
webCheckoutDetailsAmazonPayRedirectUrl = jResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
Dim productType As String
productType = jResp.StringOf("productType")
Dim paymentDetailsPaymentIntent As String
paymentDetailsPaymentIntent = jResp.StringOf("paymentDetails.paymentIntent")
Dim paymentDetailsCanHandlePendingAuthorization As Boolean
paymentDetailsCanHandlePendingAuthorization = jResp.BoolOf("paymentDetails.canHandlePendingAuthorization")
Dim paymentDetailsChargeAmountAmount As String
paymentDetailsChargeAmountAmount = jResp.StringOf("paymentDetails.chargeAmount.amount")
Dim paymentDetailsChargeAmountCurrencyCode As String
paymentDetailsChargeAmountCurrencyCode = jResp.StringOf("paymentDetails.chargeAmount.currencyCode")
Dim paymentDetailsTotalOrderAmount As String
paymentDetailsTotalOrderAmount = jResp.StringOf("paymentDetails.totalOrderAmount")
Dim paymentDetailsSoftDescriptor As String
paymentDetailsSoftDescriptor = jResp.StringOf("paymentDetails.softDescriptor")
Dim paymentDetailsPresentmentCurrency As String
paymentDetailsPresentmentCurrency = jResp.StringOf("paymentDetails.presentmentCurrency")
Dim paymentDetailsAllowOvercharge As String
paymentDetailsAllowOvercharge = jResp.StringOf("paymentDetails.allowOvercharge")
Dim paymentDetailsExtendExpiration As String
paymentDetailsExtendExpiration = jResp.StringOf("paymentDetails.extendExpiration")
Dim merchantMetadataMerchantReferenceId As String
merchantMetadataMerchantReferenceId = jResp.StringOf("merchantMetadata.merchantReferenceId")
Dim merchantMetadataMerchantStoreName As String
merchantMetadataMerchantStoreName = jResp.StringOf("merchantMetadata.merchantStoreName")
Dim merchantMetadataNoteToBuyer As String
merchantMetadataNoteToBuyer = jResp.StringOf("merchantMetadata.noteToBuyer")
Dim merchantMetadataCustomInformation As String
merchantMetadataCustomInformation = jResp.StringOf("merchantMetadata.customInformation")
Dim supplementaryData As String
supplementaryData = jResp.StringOf("supplementaryData")
Dim buyerBuyerId As String
buyerBuyerId = jResp.StringOf("buyer.buyerId")
Dim buyerName As String
buyerName = jResp.StringOf("buyer.name")
Dim buyerEmail As String
buyerEmail = jResp.StringOf("buyer.email")
Dim buyerPhoneNumber As String
buyerPhoneNumber = jResp.StringOf("buyer.phoneNumber")
Dim buyerPrimeMembershipTypes As String
buyerPrimeMembershipTypes = jResp.StringOf("buyer.primeMembershipTypes")
Dim billingAddressName As String
billingAddressName = jResp.StringOf("billingAddress.name")
Dim billingAddressAddressLine1 As String
billingAddressAddressLine1 = jResp.StringOf("billingAddress.addressLine1")
Dim billingAddressAddressLine2 As String
billingAddressAddressLine2 = jResp.StringOf("billingAddress.addressLine2")
Dim billingAddressAddressLine3 As String
billingAddressAddressLine3 = jResp.StringOf("billingAddress.addressLine3")
Dim billingAddressCity As String
billingAddressCity = jResp.StringOf("billingAddress.city")
Dim billingAddressCounty As String
billingAddressCounty = jResp.StringOf("billingAddress.county")
Dim billingAddressDistrict As String
billingAddressDistrict = jResp.StringOf("billingAddress.district")
Dim billingAddressStateOrRegion As String
billingAddressStateOrRegion = jResp.StringOf("billingAddress.stateOrRegion")
Dim billingAddressPostalCode As String
billingAddressPostalCode = jResp.StringOf("billingAddress.postalCode")
Dim billingAddressCountryCode As String
billingAddressCountryCode = jResp.StringOf("billingAddress.countryCode")
Dim statusDetailsState As String
statusDetailsState = jResp.StringOf("statusDetails.state")
Dim statusDetailsReasonCode As String
statusDetailsReasonCode = jResp.StringOf("statusDetails.reasonCode")
Dim statusDetailsReasonDescription As String
statusDetailsReasonDescription = jResp.StringOf("statusDetails.reasonDescription")
Dim statusDetailsLastUpdatedTimestamp As String
statusDetailsLastUpdatedTimestamp = jResp.StringOf("statusDetails.lastUpdatedTimestamp")
Dim shippingAddressName As String
shippingAddressName = jResp.StringOf("shippingAddress.name")
Dim shippingAddressAddressLine1 As String
shippingAddressAddressLine1 = jResp.StringOf("shippingAddress.addressLine1")
Dim shippingAddressAddressLine2 As String
shippingAddressAddressLine2 = jResp.StringOf("shippingAddress.addressLine2")
Dim shippingAddressAddressLine3 As String
shippingAddressAddressLine3 = jResp.StringOf("shippingAddress.addressLine3")
Dim shippingAddressCity As String
shippingAddressCity = jResp.StringOf("shippingAddress.city")
Dim shippingAddressCounty As String
shippingAddressCounty = jResp.StringOf("shippingAddress.county")
Dim shippingAddressDistrict As String
shippingAddressDistrict = jResp.StringOf("shippingAddress.district")
Dim shippingAddressStateOrRegion As String
shippingAddressStateOrRegion = jResp.StringOf("shippingAddress.stateOrRegion")
Dim shippingAddressPostalCode As String
shippingAddressPostalCode = jResp.StringOf("shippingAddress.postalCode")
Dim shippingAddressCountryCode As String
shippingAddressCountryCode = jResp.StringOf("shippingAddress.countryCode")
Dim shippingAddressPhoneNumber As String
shippingAddressPhoneNumber = jResp.StringOf("shippingAddress.phoneNumber")
Dim platformId As String
platformId = jResp.StringOf("platformId")
Dim chargePermissionId As String
chargePermissionId = jResp.StringOf("chargePermissionId")
Dim chargeId As String
chargeId = jResp.StringOf("chargeId")
Dim creationTimestamp As String
creationTimestamp = jResp.StringOf("creationTimestamp")
Dim expirationTimestamp As String
expirationTimestamp = jResp.StringOf("expirationTimestamp")
Dim storeId As String
storeId = jResp.StringOf("storeId")
Dim deliverySpecificationsAddressRestrictionsType As String
deliverySpecificationsAddressRestrictionsType = jResp.StringOf("deliverySpecifications.addressRestrictions.type")
Dim providerMetadataProviderReferenceId As String
providerMetadataProviderReferenceId = jResp.StringOf("providerMetadata.providerReferenceId")
Dim releaseEnvironment As String
releaseEnvironment = jResp.StringOf("releaseEnvironment")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("paymentPreferences")
While i < count_i
jResp.I = i
paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("constraints")
While i < count_i
jResp.I = i
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.specialRestrictions")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.specialRestrictions[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
i = i + 1
Wend