B4X Requires Chilkat v11.0.0+
B4X
Amazon Pay - Create Checkout Session
See more Amazon Pay Examples
Create a new Amazon Pay Checkout Session.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/" \
' -X POST
' -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
' -H "x-amz-pay-date:20201012T235046Z"
' -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
' -d '{
' "webCheckoutDetails": {
' "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
' },
' "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
' "scopes": ["name", "email", "phoneNumber", "billingAddress"],
' "deliverySpecifications": {
' "specialRestrictions": ["RestrictPOBoxes"],
' "addressRestrictions": {
' "type": "Allowed",
' "restrictions": {
' "US": {
' "statesOrRegions": ["WA"],
' "zipCodes": ["95050", "93405"]
' },
' "GB": {
' "zipCodes": ["72046", "72047"]
' },
' "IN": {
' "statesOrRegions": ["AP"]
' },
' "JP": {}
' }
' }
' }
' }'
' 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": {
' "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
' },
' "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
' "scopes": [
' "name",
' "email",
' "phoneNumber",
' "billingAddress"
' ],
' "deliverySpecifications": {
' "specialRestrictions": [
' "RestrictPOBoxes"
' ],
' "addressRestrictions": {
' "type": "Allowed",
' "restrictions": {
' "US": {
' "statesOrRegions": [
' "WA"
' ],
' "zipCodes": [
' "95050",
' "93405"
' ]
' },
' "GB": {
' "zipCodes": [
' "72046",
' "72047"
' ]
' },
' "IN": {
' "statesOrRegions": [
' "AP"
' ]
' },
' "JP": {}
' }
' }
' }
' }
Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("webCheckoutDetails.checkoutReviewReturnUrl", "https://a.com/merchant-review-page")
' Make sure to use your storeId here:
json.UpdateString("storeId", "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId")
Dim i As Int = 0
json.I = i
json.UpdateString("scopes[i]", "name")
i = i + 1
json.I = i
json.UpdateString("scopes[i]", "email")
i = i + 1
json.I = i
json.UpdateString("scopes[i]", "phoneNumber")
i = i + 1
json.I = i
json.UpdateString("scopes[i]", "billingAddress")
json.UpdateString("deliverySpecifications.specialRestrictions[0]", "RestrictPOBoxes")
json.UpdateString("deliverySpecifications.addressRestrictions.type", "Allowed")
json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]", "WA")
json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]", "95050")
json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]", "93405")
json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]", "72046")
json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]", "72047")
json.UpdateString("deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]", "AP")
json.UpdateNewObject("deliverySpecifications.addressRestrictions.restrictions.JP")
' 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
' x-amz-pay-idempotency-key
' Authorization
http.Accept = "application/json"
' To use the live system, replace "sandbox" with "live" in the URL passed to HttpJson.
' Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/", json, "application/json", resp)
If success = False Then
Log(http.LastErrorText)
Return
End If
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
' If the status code is not equal to 201, this will display error information.
Log("Response Body:")
Log(jResp.Emit)
Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode <> 201 Then
' The jResp would've contained an error message, similar to this:
' {
' "reasonCode": "InvalidHeaderValue",
' "message": "The value AF2EGWREIPHV2S2TUFFBRDGM provided for PublicKeyId is invalid. Please verify that you are using the PublicKeyId in the correct region and environment."
' }
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
' },
' "productType": "PayAndShip",
' "chargePermissionType": "Recurring",
' "recurringMetadata": {
' "frequency": {
' "unit": "Month",
' "value": "1"
' },
' "amount": {
' "amount": "30",
' "currencyCode": "USD"
' }
' },
' "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": null,
' "billingAddress": null,
' "paymentPreferences": [
' null
' ],
' "statusDetails": {
' "state": "Open",
' "reasonCode": null,
' "reasonDescription": null,
' "lastUpdatedTimestamp": "20191015T204327Z"
' },
' "shippingAddress": null,
' "platformId": null,
' "chargePermissionId": null,
' "chargeId": null,
' "constraints": [
' {
' "constraintId": "BuyerNotAssociated",
' "description": "There is no buyer associated with the Checkout Session. Return the checkout session id to the Amazon Pay Button to allow buyer to login."
' },
' {
' "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 nullVal As Boolean
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 productType As String = jResp.StringOf("productType")
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 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 buyer As String = jResp.StringOf("buyer")
Dim billingAddress As String = jResp.StringOf("billingAddress")
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 shippingAddress As String = jResp.StringOf("shippingAddress")
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")
i = 0
Dim count_i As Int = jResp.SizeOfArray("paymentPreferences")
Do While i < count_i
jResp.I = i
nullVal = jResp.IsNullOf("paymentPreferences[i]")
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