B4X
B4X
Amazon Pay - Get Checkout Session
See more Amazon Pay Examples
Get Checkout Session details includes buyer info, payment instrument details, and shipping address.Chilkat B4X Downloads
Dim success As Boolean = False
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As ChilkatHttp
http.Initialize("http")
' 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.
Dim privKey As ChilkatPrivateKey
privKey.Initialize("privKey")
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If success = False Then
Log(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 = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId, privKey)
If success = False Then
Log(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"
Dim respStatusCode As Int = 0
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
success = http.SetUrlVar("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 = http.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}", sbResponseBody)
If success = False Then
' If the LastStatus is not equal to 0, then we received a response, but it was an error response.
respStatusCode = http.LastStatus
If respStatusCode <> 0 Then
Log("Response Status Code = " & 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'"}
Log("Response body:")
Log(http.LastResponseBody)
Else
Log(http.LastErrorText)
End If
Return
End If
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Log("Response Body:")
Log(jResp.Emit)
respStatusCode = http.LastStatus
Log("Response Status Code = " & 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 Then
Log("Failed.")
Return
End If
' 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
Dim paymentDescriptor As String
Dim constraintId As String
Dim description As String
Dim strVal As String
Dim checkoutSessionId As String = jResp.StringOf("checkoutSessionId")
Dim webCheckoutDetailsCheckoutReviewReturnUrl As String = jResp.StringOf("webCheckoutDetails.checkoutReviewReturnUrl")
Dim webCheckoutDetailsCheckoutResultReturnUrl As String = jResp.StringOf("webCheckoutDetails.checkoutResultReturnUrl")
Dim webCheckoutDetailsCheckoutCancelUrl As String = jResp.StringOf("webCheckoutDetails.checkoutCancelUrl")
Dim webCheckoutDetailsAmazonPayRedirectUrl As String = jResp.StringOf("webCheckoutDetails.amazonPayRedirectUrl")
Dim chargePermissionType As String = jResp.StringOf("chargePermissionType")
Dim recurringMetadataFrequencyUnit As String = jResp.StringOf("recurringMetadata.frequency.unit")
Dim recurringMetadataFrequencyValue As String = jResp.StringOf("recurringMetadata.frequency.value")
Dim recurringMetadataAmountAmount As String = jResp.StringOf("recurringMetadata.amount.amount")
Dim recurringMetadataAmountCurrencyCode As String = jResp.StringOf("recurringMetadata.amount.currencyCode")
Dim productType As String = jResp.StringOf("productType")
Dim paymentDetailsPaymentIntent As String = jResp.StringOf("paymentDetails.paymentIntent")
Dim paymentDetailsCanHandlePendingAuthorization As Boolean = jResp.BoolOf("paymentDetails.canHandlePendingAuthorization")
Dim paymentDetailsChargeAmount As String = jResp.StringOf("paymentDetails.chargeAmount")
Dim paymentDetailsTotalOrderAmount As String = jResp.StringOf("paymentDetails.totalOrderAmount")
Dim paymentDetailsSoftDescriptor As String = jResp.StringOf("paymentDetails.softDescriptor")
Dim paymentDetailsPresentmentCurrency As String = jResp.StringOf("paymentDetails.presentmentCurrency")
Dim paymentDetailsAllowOvercharge As String = jResp.StringOf("paymentDetails.allowOvercharge")
Dim paymentDetailsExtendExpiration As String = jResp.StringOf("paymentDetails.extendExpiration")
Dim merchantMetadataMerchantReferenceId As String = jResp.StringOf("merchantMetadata.merchantReferenceId")
Dim merchantMetadataMerchantStoreName As String = jResp.StringOf("merchantMetadata.merchantStoreName")
Dim merchantMetadataNoteToBuyer As String = jResp.StringOf("merchantMetadata.noteToBuyer")
Dim merchantMetadataCustomInformation As String = jResp.StringOf("merchantMetadata.customInformation")
Dim supplementaryData As String = jResp.StringOf("supplementaryData")
Dim buyerBuyerId As String = jResp.StringOf("buyer.buyerId")
Dim buyerName As String = jResp.StringOf("buyer.name")
Dim buyerEmail As String = jResp.StringOf("buyer.email")
Dim buyerPhoneNumber As String = jResp.StringOf("buyer.phoneNumber")
Dim buyerPrimeMembershipTypes As String = jResp.StringOf("buyer.primeMembershipTypes")
Dim billingAddressName As String = jResp.StringOf("billingAddress.name")
Dim billingAddressAddressLine1 As String = jResp.StringOf("billingAddress.addressLine1")
Dim billingAddressAddressLine2 As String = jResp.StringOf("billingAddress.addressLine2")
Dim billingAddressAddressLine3 As String = jResp.StringOf("billingAddress.addressLine3")
Dim billingAddressCity As String = jResp.StringOf("billingAddress.city")
Dim billingAddressCounty As String = jResp.StringOf("billingAddress.county")
Dim billingAddressDistrict As String = jResp.StringOf("billingAddress.district")
Dim billingAddressStateOrRegion As String = jResp.StringOf("billingAddress.stateOrRegion")
Dim billingAddressPostalCode As String = jResp.StringOf("billingAddress.postalCode")
Dim billingAddressCountryCode As String = jResp.StringOf("billingAddress.countryCode")
Dim statusDetailsState As String = jResp.StringOf("statusDetails.state")
Dim statusDetailsReasonCode As String = jResp.StringOf("statusDetails.reasonCode")
Dim statusDetailsReasonDescription As String = jResp.StringOf("statusDetails.reasonDescription")
Dim statusDetailsLastUpdatedTimestamp As String = jResp.StringOf("statusDetails.lastUpdatedTimestamp")
Dim shippingAddressName As String = jResp.StringOf("shippingAddress.name")
Dim shippingAddressAddressLine1 As String = jResp.StringOf("shippingAddress.addressLine1")
Dim shippingAddressAddressLine2 As String = jResp.StringOf("shippingAddress.addressLine2")
Dim shippingAddressAddressLine3 As String = jResp.StringOf("shippingAddress.addressLine3")
Dim shippingAddressCity As String = jResp.StringOf("shippingAddress.city")
Dim shippingAddressCounty As String = jResp.StringOf("shippingAddress.county")
Dim shippingAddressDistrict As String = jResp.StringOf("shippingAddress.district")
Dim shippingAddressStateOrRegion As String = jResp.StringOf("shippingAddress.stateOrRegion")
Dim shippingAddressPostalCode As String = jResp.StringOf("shippingAddress.postalCode")
Dim shippingAddressCountryCode As String = jResp.StringOf("shippingAddress.countryCode")
Dim shippingAddressPhoneNumber As String = jResp.StringOf("shippingAddress.phoneNumber")
Dim platformId As String = jResp.StringOf("platformId")
Dim chargePermissionId As String = jResp.StringOf("chargePermissionId")
Dim chargeId As String = jResp.StringOf("chargeId")
Dim creationTimestamp As String = jResp.StringOf("creationTimestamp")
Dim expirationTimestamp As String = jResp.StringOf("expirationTimestamp")
Dim storeId As String = jResp.StringOf("storeId")
Dim deliverySpecificationsAddressRestrictionsType As String = jResp.StringOf("deliverySpecifications.addressRestrictions.type")
Dim providerMetadataProviderReferenceId As String = jResp.StringOf("providerMetadata.providerReferenceId")
Dim releaseEnvironment As String = jResp.StringOf("releaseEnvironment")
Dim i As Int = 0
Dim count_i As Int = jResp.SizeOfArray("paymentPreferences")
Do While i < count_i
jResp.I = i
paymentDescriptor = jResp.StringOf("paymentPreferences[i].paymentDescriptor")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("constraints")
Do While i < count_i
jResp.I = i
constraintId = jResp.StringOf("constraints[i].constraintId")
description = jResp.StringOf("constraints[i].description")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.specialRestrictions")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.specialRestrictions[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]")
i = i + 1
Loop