PureBasic
PureBasic
Amazon Pay - Update Checkout Session
See more Amazon Pay Examples
Update the Checkout Session with transaction details.Chilkat PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPrivateKey.pb"
Procedure ChilkatExample()
success.i = 0
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; 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"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"webCheckoutDetails.checkoutResultReturnUrl","https://a.com/merchant-confirm-page")
CkJsonObject::ckUpdateString(json,"paymentDetails.paymentIntent","AuthorizeWithCapture")
CkJsonObject::ckUpdateBool(json,"paymentDetails.canHandlePendingAuthorization",0)
CkJsonObject::ckUpdateString(json,"paymentDetails.softDescriptor","Descriptor")
CkJsonObject::ckUpdateString(json,"paymentDetails.chargeAmount.amount","1")
CkJsonObject::ckUpdateString(json,"paymentDetails.chargeAmount.currencyCode","USD")
CkJsonObject::ckUpdateString(json,"merchantMetadata.merchantReferenceId","Merchant reference ID")
CkJsonObject::ckUpdateString(json,"merchantMetadata.merchantStoreName","Merchant store name")
CkJsonObject::ckUpdateString(json,"merchantMetadata.noteToBuyer","Note to buyer")
CkJsonObject::ckUpdateString(json,"merchantMetadata.customInformation","Custom information")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,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.
privKey.i = CkPrivateKey::ckCreate()
If privKey.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkPrivateKey::ckLoadPemFile(privKey,"C:/someDir/myAmazonPayPrivateKey.pem")
If success = 0
Debug CkPrivateKey::ckLastErrorText(privKey)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
ProcedureReturn
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
publicKeyId.s = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = CkHttp::ckSetAuthPrivateKey(http,publicKeyId,privKey)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
ProcedureReturn
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
CkHttp::setCkAccept(http, "application/json")
success = CkHttp::ckSetUrlVar(http,"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
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpSb(http,"PATCH","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",sbRequestBody,"utf-8","application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
; If the status code is not equal to 200, this will display error information.
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode <> 200
; 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'"
; }
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
paymentDescriptor.s
strVal.s
checkoutSessionId.s = CkJsonObject::ckStringOf(jResp,"checkoutSessionId")
webCheckoutDetailsCheckoutReviewReturnUrl.s = CkJsonObject::ckStringOf(jResp,"webCheckoutDetails.checkoutReviewReturnUrl")
webCheckoutDetailsCheckoutResultReturnUrl.s = CkJsonObject::ckStringOf(jResp,"webCheckoutDetails.checkoutResultReturnUrl")
webCheckoutDetailsCheckoutCancelUrl.s = CkJsonObject::ckStringOf(jResp,"webCheckoutDetails.checkoutCancelUrl")
webCheckoutDetailsAmazonPayRedirectUrl.s = CkJsonObject::ckStringOf(jResp,"webCheckoutDetails.amazonPayRedirectUrl")
productType.s = CkJsonObject::ckStringOf(jResp,"productType")
paymentDetailsPaymentIntent.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.paymentIntent")
paymentDetailsCanHandlePendingAuthorization.i = CkJsonObject::ckBoolOf(jResp,"paymentDetails.canHandlePendingAuthorization")
paymentDetailsChargeAmountAmount.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.chargeAmount.amount")
paymentDetailsChargeAmountCurrencyCode.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.chargeAmount.currencyCode")
paymentDetailsTotalOrderAmount.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.totalOrderAmount")
paymentDetailsSoftDescriptor.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.softDescriptor")
paymentDetailsPresentmentCurrency.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.presentmentCurrency")
paymentDetailsAllowOvercharge.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.allowOvercharge")
paymentDetailsExtendExpiration.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.extendExpiration")
merchantMetadataMerchantReferenceId.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.merchantReferenceId")
merchantMetadataMerchantStoreName.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.merchantStoreName")
merchantMetadataNoteToBuyer.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.noteToBuyer")
merchantMetadataCustomInformation.s = CkJsonObject::ckStringOf(jResp,"merchantMetadata.customInformation")
supplementaryData.s = CkJsonObject::ckStringOf(jResp,"supplementaryData")
buyerBuyerId.s = CkJsonObject::ckStringOf(jResp,"buyer.buyerId")
buyerName.s = CkJsonObject::ckStringOf(jResp,"buyer.name")
buyerEmail.s = CkJsonObject::ckStringOf(jResp,"buyer.email")
buyerPhoneNumber.s = CkJsonObject::ckStringOf(jResp,"buyer.phoneNumber")
buyerPrimeMembershipTypes.s = CkJsonObject::ckStringOf(jResp,"buyer.primeMembershipTypes")
billingAddressName.s = CkJsonObject::ckStringOf(jResp,"billingAddress.name")
billingAddressAddressLine1.s = CkJsonObject::ckStringOf(jResp,"billingAddress.addressLine1")
billingAddressAddressLine2.s = CkJsonObject::ckStringOf(jResp,"billingAddress.addressLine2")
billingAddressAddressLine3.s = CkJsonObject::ckStringOf(jResp,"billingAddress.addressLine3")
billingAddressCity.s = CkJsonObject::ckStringOf(jResp,"billingAddress.city")
billingAddressCounty.s = CkJsonObject::ckStringOf(jResp,"billingAddress.county")
billingAddressDistrict.s = CkJsonObject::ckStringOf(jResp,"billingAddress.district")
billingAddressStateOrRegion.s = CkJsonObject::ckStringOf(jResp,"billingAddress.stateOrRegion")
billingAddressPostalCode.s = CkJsonObject::ckStringOf(jResp,"billingAddress.postalCode")
billingAddressCountryCode.s = CkJsonObject::ckStringOf(jResp,"billingAddress.countryCode")
statusDetailsState.s = CkJsonObject::ckStringOf(jResp,"statusDetails.state")
statusDetailsReasonCode.s = CkJsonObject::ckStringOf(jResp,"statusDetails.reasonCode")
statusDetailsReasonDescription.s = CkJsonObject::ckStringOf(jResp,"statusDetails.reasonDescription")
statusDetailsLastUpdatedTimestamp.s = CkJsonObject::ckStringOf(jResp,"statusDetails.lastUpdatedTimestamp")
shippingAddressName.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.name")
shippingAddressAddressLine1.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.addressLine1")
shippingAddressAddressLine2.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.addressLine2")
shippingAddressAddressLine3.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.addressLine3")
shippingAddressCity.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.city")
shippingAddressCounty.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.county")
shippingAddressDistrict.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.district")
shippingAddressStateOrRegion.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.stateOrRegion")
shippingAddressPostalCode.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.postalCode")
shippingAddressCountryCode.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.countryCode")
shippingAddressPhoneNumber.s = CkJsonObject::ckStringOf(jResp,"shippingAddress.phoneNumber")
platformId.s = CkJsonObject::ckStringOf(jResp,"platformId")
chargePermissionId.s = CkJsonObject::ckStringOf(jResp,"chargePermissionId")
chargeId.s = CkJsonObject::ckStringOf(jResp,"chargeId")
creationTimestamp.s = CkJsonObject::ckStringOf(jResp,"creationTimestamp")
expirationTimestamp.s = CkJsonObject::ckStringOf(jResp,"expirationTimestamp")
storeId.s = CkJsonObject::ckStringOf(jResp,"storeId")
deliverySpecificationsAddressRestrictionsType.s = CkJsonObject::ckStringOf(jResp,"deliverySpecifications.addressRestrictions.type")
providerMetadataProviderReferenceId.s = CkJsonObject::ckStringOf(jResp,"providerMetadata.providerReferenceId")
releaseEnvironment.s = CkJsonObject::ckStringOf(jResp,"releaseEnvironment")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"paymentPreferences")
While i < count_i
CkJsonObject::setCkI(jResp, i)
paymentDescriptor = CkJsonObject::ckStringOf(jResp,"paymentPreferences[i].paymentDescriptor")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"constraints")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"deliverySpecifications.specialRestrictions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"deliverySpecifications.specialRestrictions[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure