(Lianja) Amazon Pay - Update Checkout Session

See more Amazon Pay Examples

Update the Checkout Session with transaction details.

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// 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"
//   }
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("webCheckoutDetails.checkoutResultReturnUrl","https://a.com/merchant-confirm-page")
loJson.UpdateString("paymentDetails.paymentIntent","AuthorizeWithCapture")
loJson.UpdateBool("paymentDetails.canHandlePendingAuthorization",.F.)
loJson.UpdateString("paymentDetails.softDescriptor","Descriptor")
loJson.UpdateString("paymentDetails.chargeAmount.amount","1")
loJson.UpdateString("paymentDetails.chargeAmount.currencyCode","USD")
loJson.UpdateString("merchantMetadata.merchantReferenceId","Merchant reference ID")
loJson.UpdateString("merchantMetadata.merchantStoreName","Merchant store name")
loJson.UpdateString("merchantMetadata.noteToBuyer","Note to buyer")
loJson.UpdateString("merchantMetadata.customInformation","Custom information")

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

// 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.
loPrivKey = createobject("CkPrivateKey")
llSuccess = loPrivKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if (llSuccess = .F.) then
    ? loPrivKey.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    return
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"
llSuccess = loHttp.SetAuthPrivateKey(lcPublicKeyId,loPrivKey)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    return
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"

llSuccess = loHttp.SetUrlVar("sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b")
// To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
loResp = loHttp.PTextSb("PATCH","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

// If the status code is not equal to 200, this will display error information.
? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode <> 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'"
    // 	}

    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbRequestBody
    release loPrivKey
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcCheckoutSessionId = loJResp.StringOf("checkoutSessionId")
lcWebCheckoutDetailsCheckoutReviewReturnUrl = loJResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
lcWebCheckoutDetailsCheckoutResultReturnUrl = loJResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
lcWebCheckoutDetailsCheckoutCancelUrl = loJResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
lcWebCheckoutDetailsAmazonPayRedirectUrl = loJResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
lcProductType = loJResp.StringOf("productType")
lcPaymentDetailsPaymentIntent = loJResp.StringOf("paymentDetails.paymentIntent")
llPaymentDetailsCanHandlePendingAuthorization = loJResp.BoolOf("paymentDetails.canHandlePendingAuthorization")
lcPaymentDetailsChargeAmountAmount = loJResp.StringOf("paymentDetails.chargeAmount.amount")
lcPaymentDetailsChargeAmountCurrencyCode = loJResp.StringOf("paymentDetails.chargeAmount.currencyCode")
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
    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 loJson
release loSbRequestBody
release loPrivKey
release loSbResponseBody
release loJResp