PureBasic
PureBasic
Amazon Pay - Get Checkout Session
See more Amazon Pay Examples
Get Checkout Session details includes buyer info, payment instrument details, and shipping address.Chilkat PureBasic Downloads
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkPrivateKey.pb"
IncludeFile "CkJsonObject.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 GET
; -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
; -H "x-amz-pay-date:20201012T235046Z"
; Use the following online tool to generate HTTP code from a CURL command
; Convert a cURL Command to HTTP Source Code
; 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)
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)
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")
respStatusCode.i = 0
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckSetUrlVar(http,"sessionId","62b7d028-6c7c-4a43-b077-3897dff27c5b")
; To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
; Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
success = CkHttp::ckQuickGetSb(http,"https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}",sbResponseBody)
If success = 0
; If the LastStatus is not equal to 0, then we received a response, but it was an error response.
respStatusCode = CkHttp::ckLastStatus(http)
If respStatusCode <> 0
Debug "Response Status Code = " + Str(respStatusCode)
; 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 "Response body:"
Debug CkHttp::ckLastResponseBody(http)
Else
Debug CkHttp::ckLastErrorText(http)
EndIf
CkHttp::ckDispose(http)
CkPrivateKey::ckDispose(privKey)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
; We expect a 200 status code for success.
; Note: Some Amazon Pay API calls return 200 for success, others return 201.
If respStatusCode <> 200
Debug "Failed."
CkHttp::ckDispose(http)
CkPrivateKey::ckDispose(privKey)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
; },
; "chargePermissionType": "Recurring",
; "recurringMetadata": {
; "frequency": {
; "unit": "Month",
; "value": "1"
; },
; "amount": {
; "amount": "30",
; "currencyCode": "USD"
; }
; },
; "productType": "PayAndShip",
; "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": {
; "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": "20191015T204327Z"
; },
; "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": [
; {
; "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
paymentDescriptor.s
constraintId.s
description.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")
chargePermissionType.s = CkJsonObject::ckStringOf(jResp,"chargePermissionType")
recurringMetadataFrequencyUnit.s = CkJsonObject::ckStringOf(jResp,"recurringMetadata.frequency.unit")
recurringMetadataFrequencyValue.s = CkJsonObject::ckStringOf(jResp,"recurringMetadata.frequency.value")
recurringMetadataAmountAmount.s = CkJsonObject::ckStringOf(jResp,"recurringMetadata.amount.amount")
recurringMetadataAmountCurrencyCode.s = CkJsonObject::ckStringOf(jResp,"recurringMetadata.amount.currencyCode")
productType.s = CkJsonObject::ckStringOf(jResp,"productType")
paymentDetailsPaymentIntent.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.paymentIntent")
paymentDetailsCanHandlePendingAuthorization.i = CkJsonObject::ckBoolOf(jResp,"paymentDetails.canHandlePendingAuthorization")
paymentDetailsChargeAmount.s = CkJsonObject::ckStringOf(jResp,"paymentDetails.chargeAmount")
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)
constraintId = CkJsonObject::ckStringOf(jResp,"constraints[i].constraintId")
description = CkJsonObject::ckStringOf(jResp,"constraints[i].description")
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)
CkPrivateKey::ckDispose(privKey)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure