(Delphi ActiveX) Amazon Pay - Get Checkout Session

See more Amazon Pay Examples

Get Checkout Session details includes buyer info, payment instrument details, and shipping address.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#get-checkout-session

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: TChilkatHttp;
success: Integer;
privKey: TPrivateKey;
publicKeyId: WideString;
respStatusCode: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
paymentDescriptor: WideString;
constraintId: WideString;
description: WideString;
strVal: WideString;
checkoutSessionId: WideString;
webCheckoutDetailsCheckoutReviewReturnUrl: WideString;
webCheckoutDetailsCheckoutResultReturnUrl: WideString;
webCheckoutDetailsCheckoutCancelUrl: WideString;
webCheckoutDetailsAmazonPayRedirectUrl: WideString;
chargePermissionType: WideString;
recurringMetadataFrequencyUnit: WideString;
recurringMetadataFrequencyValue: WideString;
recurringMetadataAmountAmount: WideString;
recurringMetadataAmountCurrencyCode: WideString;
productType: WideString;
paymentDetailsPaymentIntent: WideString;
paymentDetailsCanHandlePendingAuthorization: Integer;
paymentDetailsChargeAmount: WideString;
paymentDetailsTotalOrderAmount: WideString;
paymentDetailsSoftDescriptor: WideString;
paymentDetailsPresentmentCurrency: WideString;
paymentDetailsAllowOvercharge: WideString;
paymentDetailsExtendExpiration: WideString;
merchantMetadataMerchantReferenceId: WideString;
merchantMetadataMerchantStoreName: WideString;
merchantMetadataNoteToBuyer: WideString;
merchantMetadataCustomInformation: WideString;
supplementaryData: WideString;
buyerBuyerId: WideString;
buyerName: WideString;
buyerEmail: WideString;
buyerPhoneNumber: WideString;
buyerPrimeMembershipTypes: WideString;
billingAddressName: WideString;
billingAddressAddressLine1: WideString;
billingAddressAddressLine2: WideString;
billingAddressAddressLine3: WideString;
billingAddressCity: WideString;
billingAddressCounty: WideString;
billingAddressDistrict: WideString;
billingAddressStateOrRegion: WideString;
billingAddressPostalCode: WideString;
billingAddressCountryCode: WideString;
statusDetailsState: WideString;
statusDetailsReasonCode: WideString;
statusDetailsReasonDescription: WideString;
statusDetailsLastUpdatedTimestamp: WideString;
shippingAddressName: WideString;
shippingAddressAddressLine1: WideString;
shippingAddressAddressLine2: WideString;
shippingAddressAddressLine3: WideString;
shippingAddressCity: WideString;
shippingAddressCounty: WideString;
shippingAddressDistrict: WideString;
shippingAddressStateOrRegion: WideString;
shippingAddressPostalCode: WideString;
shippingAddressCountryCode: WideString;
shippingAddressPhoneNumber: WideString;
platformId: WideString;
chargePermissionId: WideString;
chargeId: WideString;
creationTimestamp: WideString;
expirationTimestamp: WideString;
storeId: WideString;
deliverySpecificationsAddressRestrictionsType: WideString;
providerMetadataProviderReferenceId: WideString;
releaseEnvironment: WideString;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

// 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 := TPrivateKey.Create(Self);
success := privKey.LoadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
if (success = 0) then
  begin
    Memo1.Lines.Add(privKey.LastErrorText);
    Exit;
  end;

// 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 := 'SANDBOX-AHEGSJCM3L2S637RBGABLAFW';
success := http.SetAuthPrivateKey(publicKeyId,privKey.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

// 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';

respStatusCode := 0;

sbResponseBody := TChilkatStringBuilder.Create(Self);
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.ControlInterface);
if (success = 0) then
  begin
    // 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
      begin
        Memo1.Lines.Add('Response Status Code = ' + IntToStr(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'"}

        Memo1.Lines.Add('Response body:');
        Memo1.Lines.Add(http.LastResponseBody);
      end
    else
      begin
        Memo1.Lines.Add(http.LastErrorText);
      end;
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(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
  begin
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

checkoutSessionId := jResp.StringOf('checkoutSessionId');
webCheckoutDetailsCheckoutReviewReturnUrl := jResp.StringOf('webCheckoutDetails.checkoutReviewReturnUrl');
webCheckoutDetailsCheckoutResultReturnUrl := jResp.StringOf('webCheckoutDetails.checkoutResultReturnUrl');
webCheckoutDetailsCheckoutCancelUrl := jResp.StringOf('webCheckoutDetails.checkoutCancelUrl');
webCheckoutDetailsAmazonPayRedirectUrl := jResp.StringOf('webCheckoutDetails.amazonPayRedirectUrl');
chargePermissionType := jResp.StringOf('chargePermissionType');
recurringMetadataFrequencyUnit := jResp.StringOf('recurringMetadata.frequency.unit');
recurringMetadataFrequencyValue := jResp.StringOf('recurringMetadata.frequency.value');
recurringMetadataAmountAmount := jResp.StringOf('recurringMetadata.amount.amount');
recurringMetadataAmountCurrencyCode := jResp.StringOf('recurringMetadata.amount.currencyCode');
productType := jResp.StringOf('productType');
paymentDetailsPaymentIntent := jResp.StringOf('paymentDetails.paymentIntent');
paymentDetailsCanHandlePendingAuthorization := jResp.BoolOf('paymentDetails.canHandlePendingAuthorization');
paymentDetailsChargeAmount := jResp.StringOf('paymentDetails.chargeAmount');
paymentDetailsTotalOrderAmount := jResp.StringOf('paymentDetails.totalOrderAmount');
paymentDetailsSoftDescriptor := jResp.StringOf('paymentDetails.softDescriptor');
paymentDetailsPresentmentCurrency := jResp.StringOf('paymentDetails.presentmentCurrency');
paymentDetailsAllowOvercharge := jResp.StringOf('paymentDetails.allowOvercharge');
paymentDetailsExtendExpiration := jResp.StringOf('paymentDetails.extendExpiration');
merchantMetadataMerchantReferenceId := jResp.StringOf('merchantMetadata.merchantReferenceId');
merchantMetadataMerchantStoreName := jResp.StringOf('merchantMetadata.merchantStoreName');
merchantMetadataNoteToBuyer := jResp.StringOf('merchantMetadata.noteToBuyer');
merchantMetadataCustomInformation := jResp.StringOf('merchantMetadata.customInformation');
supplementaryData := jResp.StringOf('supplementaryData');
buyerBuyerId := jResp.StringOf('buyer.buyerId');
buyerName := jResp.StringOf('buyer.name');
buyerEmail := jResp.StringOf('buyer.email');
buyerPhoneNumber := jResp.StringOf('buyer.phoneNumber');
buyerPrimeMembershipTypes := jResp.StringOf('buyer.primeMembershipTypes');
billingAddressName := jResp.StringOf('billingAddress.name');
billingAddressAddressLine1 := jResp.StringOf('billingAddress.addressLine1');
billingAddressAddressLine2 := jResp.StringOf('billingAddress.addressLine2');
billingAddressAddressLine3 := jResp.StringOf('billingAddress.addressLine3');
billingAddressCity := jResp.StringOf('billingAddress.city');
billingAddressCounty := jResp.StringOf('billingAddress.county');
billingAddressDistrict := jResp.StringOf('billingAddress.district');
billingAddressStateOrRegion := jResp.StringOf('billingAddress.stateOrRegion');
billingAddressPostalCode := jResp.StringOf('billingAddress.postalCode');
billingAddressCountryCode := jResp.StringOf('billingAddress.countryCode');
statusDetailsState := jResp.StringOf('statusDetails.state');
statusDetailsReasonCode := jResp.StringOf('statusDetails.reasonCode');
statusDetailsReasonDescription := jResp.StringOf('statusDetails.reasonDescription');
statusDetailsLastUpdatedTimestamp := jResp.StringOf('statusDetails.lastUpdatedTimestamp');
shippingAddressName := jResp.StringOf('shippingAddress.name');
shippingAddressAddressLine1 := jResp.StringOf('shippingAddress.addressLine1');
shippingAddressAddressLine2 := jResp.StringOf('shippingAddress.addressLine2');
shippingAddressAddressLine3 := jResp.StringOf('shippingAddress.addressLine3');
shippingAddressCity := jResp.StringOf('shippingAddress.city');
shippingAddressCounty := jResp.StringOf('shippingAddress.county');
shippingAddressDistrict := jResp.StringOf('shippingAddress.district');
shippingAddressStateOrRegion := jResp.StringOf('shippingAddress.stateOrRegion');
shippingAddressPostalCode := jResp.StringOf('shippingAddress.postalCode');
shippingAddressCountryCode := jResp.StringOf('shippingAddress.countryCode');
shippingAddressPhoneNumber := jResp.StringOf('shippingAddress.phoneNumber');
platformId := jResp.StringOf('platformId');
chargePermissionId := jResp.StringOf('chargePermissionId');
chargeId := jResp.StringOf('chargeId');
creationTimestamp := jResp.StringOf('creationTimestamp');
expirationTimestamp := jResp.StringOf('expirationTimestamp');
storeId := jResp.StringOf('storeId');
deliverySpecificationsAddressRestrictionsType := jResp.StringOf('deliverySpecifications.addressRestrictions.type');
providerMetadataProviderReferenceId := jResp.StringOf('providerMetadata.providerReferenceId');
releaseEnvironment := jResp.StringOf('releaseEnvironment');
i := 0;
count_i := jResp.SizeOfArray('paymentPreferences');
while i < count_i do
  begin
    jResp.I := i;
    paymentDescriptor := jResp.StringOf('paymentPreferences[i].paymentDescriptor');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('constraints');
while i < count_i do
  begin
    jResp.I := i;
    constraintId := jResp.StringOf('constraints[i].constraintId');
    description := jResp.StringOf('constraints[i].description');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('deliverySpecifications.specialRestrictions');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('deliverySpecifications.specialRestrictions[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]');
    i := i + 1;
  end;
end;