PowerBuilder
PowerBuilder
Amazon Pay - Update Checkout Session
See more Amazon Pay Examples
Update the Checkout Session with transaction details.Chilkat PowerBuilder Downloads
integer li_rc
long li_Success
oleobject loo_Http
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_PrivKey
string ls_PublicKeyId
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
long li_RespStatusCode
string ls_PaymentDescriptor
string ls_StrVal
string ls_CheckoutSessionId
string ls_WebCheckoutDetailsCheckoutReviewReturnUrl
string ls_WebCheckoutDetailsCheckoutResultReturnUrl
string ls_WebCheckoutDetailsCheckoutCancelUrl
string ls_WebCheckoutDetailsAmazonPayRedirectUrl
string ls_ProductType
string ls_PaymentDetailsPaymentIntent
long li_PaymentDetailsCanHandlePendingAuthorization
string ls_PaymentDetailsChargeAmountAmount
string ls_PaymentDetailsChargeAmountCurrencyCode
string ls_PaymentDetailsTotalOrderAmount
string ls_PaymentDetailsSoftDescriptor
string ls_PaymentDetailsPresentmentCurrency
string ls_PaymentDetailsAllowOvercharge
string ls_PaymentDetailsExtendExpiration
string ls_MerchantMetadataMerchantReferenceId
string ls_MerchantMetadataMerchantStoreName
string ls_MerchantMetadataNoteToBuyer
string ls_MerchantMetadataCustomInformation
string ls_SupplementaryData
string ls_BuyerBuyerId
string ls_BuyerName
string ls_BuyerEmail
string ls_BuyerPhoneNumber
string ls_BuyerPrimeMembershipTypes
string ls_BillingAddressName
string ls_BillingAddressAddressLine1
string ls_BillingAddressAddressLine2
string ls_BillingAddressAddressLine3
string ls_BillingAddressCity
string ls_BillingAddressCounty
string ls_BillingAddressDistrict
string ls_BillingAddressStateOrRegion
string ls_BillingAddressPostalCode
string ls_BillingAddressCountryCode
string ls_StatusDetailsState
string ls_StatusDetailsReasonCode
string ls_StatusDetailsReasonDescription
string ls_StatusDetailsLastUpdatedTimestamp
string ls_ShippingAddressName
string ls_ShippingAddressAddressLine1
string ls_ShippingAddressAddressLine2
string ls_ShippingAddressAddressLine3
string ls_ShippingAddressCity
string ls_ShippingAddressCounty
string ls_ShippingAddressDistrict
string ls_ShippingAddressStateOrRegion
string ls_ShippingAddressPostalCode
string ls_ShippingAddressCountryCode
string ls_ShippingAddressPhoneNumber
string ls_PlatformId
string ls_ChargePermissionId
string ls_ChargeId
string ls_CreationTimestamp
string ls_ExpirationTimestamp
string ls_StoreId
string ls_DeliverySpecificationsAddressRestrictionsType
string ls_ProviderMetadataProviderReferenceId
string ls_ReleaseEnvironment
long i
long li_Count_i
li_Success = 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("webCheckoutDetails.checkoutResultReturnUrl","https://a.com/merchant-confirm-page")
loo_Json.UpdateString("paymentDetails.paymentIntent","AuthorizeWithCapture")
loo_Json.UpdateBool("paymentDetails.canHandlePendingAuthorization",0)
loo_Json.UpdateString("paymentDetails.softDescriptor","Descriptor")
loo_Json.UpdateString("paymentDetails.chargeAmount.amount","1")
loo_Json.UpdateString("paymentDetails.chargeAmount.currencyCode","USD")
loo_Json.UpdateString("merchantMetadata.merchantReferenceId","Merchant reference ID")
loo_Json.UpdateString("merchantMetadata.merchantStoreName","Merchant store name")
loo_Json.UpdateString("merchantMetadata.noteToBuyer","Note to buyer")
loo_Json.UpdateString("merchantMetadata.customInformation","Custom information")
loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitSb(loo_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.
loo_PrivKey = create oleobject
li_rc = loo_PrivKey.ConnectToNewObject("Chilkat.PrivateKey")
li_Success = loo_PrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if li_Success = 0 then
Write-Debug loo_PrivKey.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_PrivKey
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
ls_PublicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
li_Success = loo_Http.SetAuthPrivateKey(ls_PublicKeyId,loo_PrivKey)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_PrivKey
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
loo_Http.Accept = "application/json"
li_Success = loo_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
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")
li_Success = loo_Http.HttpSb("PATCH","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",loo_SbRequestBody,"utf-8","application/json",loo_Resp)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_PrivKey
destroy loo_Resp
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
// If the status code is not equal to 200, this will display error information.
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_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'"
// }
Write-Debug "Failed."
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_PrivKey
destroy loo_Resp
destroy loo_SbResponseBody
destroy loo_JResp
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
ls_CheckoutSessionId = loo_JResp.StringOf("checkoutSessionId")
ls_WebCheckoutDetailsCheckoutReviewReturnUrl = loo_JResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
ls_WebCheckoutDetailsCheckoutResultReturnUrl = loo_JResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
ls_WebCheckoutDetailsCheckoutCancelUrl = loo_JResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
ls_WebCheckoutDetailsAmazonPayRedirectUrl = loo_JResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
ls_ProductType = loo_JResp.StringOf("productType")
ls_PaymentDetailsPaymentIntent = loo_JResp.StringOf("paymentDetails.paymentIntent")
li_PaymentDetailsCanHandlePendingAuthorization = loo_JResp.BoolOf("paymentDetails.canHandlePendingAuthorization")
ls_PaymentDetailsChargeAmountAmount = loo_JResp.StringOf("paymentDetails.chargeAmount.amount")
ls_PaymentDetailsChargeAmountCurrencyCode = loo_JResp.StringOf("paymentDetails.chargeAmount.currencyCode")
ls_PaymentDetailsTotalOrderAmount = loo_JResp.StringOf("paymentDetails.totalOrderAmount")
ls_PaymentDetailsSoftDescriptor = loo_JResp.StringOf("paymentDetails.softDescriptor")
ls_PaymentDetailsPresentmentCurrency = loo_JResp.StringOf("paymentDetails.presentmentCurrency")
ls_PaymentDetailsAllowOvercharge = loo_JResp.StringOf("paymentDetails.allowOvercharge")
ls_PaymentDetailsExtendExpiration = loo_JResp.StringOf("paymentDetails.extendExpiration")
ls_MerchantMetadataMerchantReferenceId = loo_JResp.StringOf("merchantMetadata.merchantReferenceId")
ls_MerchantMetadataMerchantStoreName = loo_JResp.StringOf("merchantMetadata.merchantStoreName")
ls_MerchantMetadataNoteToBuyer = loo_JResp.StringOf("merchantMetadata.noteToBuyer")
ls_MerchantMetadataCustomInformation = loo_JResp.StringOf("merchantMetadata.customInformation")
ls_SupplementaryData = loo_JResp.StringOf("supplementaryData")
ls_BuyerBuyerId = loo_JResp.StringOf("buyer.buyerId")
ls_BuyerName = loo_JResp.StringOf("buyer.name")
ls_BuyerEmail = loo_JResp.StringOf("buyer.email")
ls_BuyerPhoneNumber = loo_JResp.StringOf("buyer.phoneNumber")
ls_BuyerPrimeMembershipTypes = loo_JResp.StringOf("buyer.primeMembershipTypes")
ls_BillingAddressName = loo_JResp.StringOf("billingAddress.name")
ls_BillingAddressAddressLine1 = loo_JResp.StringOf("billingAddress.addressLine1")
ls_BillingAddressAddressLine2 = loo_JResp.StringOf("billingAddress.addressLine2")
ls_BillingAddressAddressLine3 = loo_JResp.StringOf("billingAddress.addressLine3")
ls_BillingAddressCity = loo_JResp.StringOf("billingAddress.city")
ls_BillingAddressCounty = loo_JResp.StringOf("billingAddress.county")
ls_BillingAddressDistrict = loo_JResp.StringOf("billingAddress.district")
ls_BillingAddressStateOrRegion = loo_JResp.StringOf("billingAddress.stateOrRegion")
ls_BillingAddressPostalCode = loo_JResp.StringOf("billingAddress.postalCode")
ls_BillingAddressCountryCode = loo_JResp.StringOf("billingAddress.countryCode")
ls_StatusDetailsState = loo_JResp.StringOf("statusDetails.state")
ls_StatusDetailsReasonCode = loo_JResp.StringOf("statusDetails.reasonCode")
ls_StatusDetailsReasonDescription = loo_JResp.StringOf("statusDetails.reasonDescription")
ls_StatusDetailsLastUpdatedTimestamp = loo_JResp.StringOf("statusDetails.lastUpdatedTimestamp")
ls_ShippingAddressName = loo_JResp.StringOf("shippingAddress.name")
ls_ShippingAddressAddressLine1 = loo_JResp.StringOf("shippingAddress.addressLine1")
ls_ShippingAddressAddressLine2 = loo_JResp.StringOf("shippingAddress.addressLine2")
ls_ShippingAddressAddressLine3 = loo_JResp.StringOf("shippingAddress.addressLine3")
ls_ShippingAddressCity = loo_JResp.StringOf("shippingAddress.city")
ls_ShippingAddressCounty = loo_JResp.StringOf("shippingAddress.county")
ls_ShippingAddressDistrict = loo_JResp.StringOf("shippingAddress.district")
ls_ShippingAddressStateOrRegion = loo_JResp.StringOf("shippingAddress.stateOrRegion")
ls_ShippingAddressPostalCode = loo_JResp.StringOf("shippingAddress.postalCode")
ls_ShippingAddressCountryCode = loo_JResp.StringOf("shippingAddress.countryCode")
ls_ShippingAddressPhoneNumber = loo_JResp.StringOf("shippingAddress.phoneNumber")
ls_PlatformId = loo_JResp.StringOf("platformId")
ls_ChargePermissionId = loo_JResp.StringOf("chargePermissionId")
ls_ChargeId = loo_JResp.StringOf("chargeId")
ls_CreationTimestamp = loo_JResp.StringOf("creationTimestamp")
ls_ExpirationTimestamp = loo_JResp.StringOf("expirationTimestamp")
ls_StoreId = loo_JResp.StringOf("storeId")
ls_DeliverySpecificationsAddressRestrictionsType = loo_JResp.StringOf("deliverySpecifications.addressRestrictions.type")
ls_ProviderMetadataProviderReferenceId = loo_JResp.StringOf("providerMetadata.providerReferenceId")
ls_ReleaseEnvironment = loo_JResp.StringOf("releaseEnvironment")
i = 0
li_Count_i = loo_JResp.SizeOfArray("paymentPreferences")
do while i < li_Count_i
loo_JResp.I = i
ls_PaymentDescriptor = loo_JResp.StringOf("paymentPreferences[i].paymentDescriptor")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("constraints")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("deliverySpecifications.specialRestrictions")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("deliverySpecifications.specialRestrictions[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_PrivKey
destroy loo_Resp
destroy loo_SbResponseBody
destroy loo_JResp