PureBasic Requires Chilkat v11.0.0+
PureBasic
Amazon Pay - Create Checkout Session
See more Amazon Pay Examples
Create a new Amazon Pay Checkout Session.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/" \
; -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": {}
; }
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"webCheckoutDetails.checkoutReviewReturnUrl","https://a.com/merchant-review-page")
; Make sure to use your storeId here:
CkJsonObject::ckUpdateString(json,"storeId","amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId")
i.i = 0
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"scopes[i]","name")
i = i + 1
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"scopes[i]","email")
i = i + 1
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"scopes[i]","phoneNumber")
i = i + 1
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"scopes[i]","billingAddress")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.specialRestrictions[0]","RestrictPOBoxes")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.type","Allowed")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[0]","WA")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[0]","95050")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[1]","93405")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[0]","72046")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[1]","72047")
CkJsonObject::ckUpdateString(json,"deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[0]","AP")
CkJsonObject::ckUpdateNewObject(json,"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.
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)
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)
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
; x-amz-pay-idempotency-key
; Authorization
CkHttp::setCkAccept(http, "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
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
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 201, 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 <> 201
; 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."
; }
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
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": "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
nullVal.i
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")
productType.s = CkJsonObject::ckStringOf(jResp,"productType")
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")
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")
buyer.s = CkJsonObject::ckStringOf(jResp,"buyer")
billingAddress.s = CkJsonObject::ckStringOf(jResp,"billingAddress")
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")
shippingAddress.s = CkJsonObject::ckStringOf(jResp,"shippingAddress")
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 = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"paymentPreferences")
While i < count_i
CkJsonObject::setCkI(jResp, i)
nullVal = CkJsonObject::ckIsNullOf(jResp,"paymentPreferences[i]")
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)
CkJsonObject::ckDispose(json)
CkPrivateKey::ckDispose(privKey)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure