(Delphi DLL) Amazon Pay - Update Checkout Session

See more Amazon Pay Examples

Update the Checkout Session with transaction details.

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

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

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, PrivateKey, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
privKey: HCkPrivateKey;
publicKeyId: PWideChar;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
paymentDescriptor: PWideChar;
strVal: PWideChar;
checkoutSessionId: PWideChar;
webCheckoutDetailsCheckoutReviewReturnUrl: PWideChar;
webCheckoutDetailsCheckoutResultReturnUrl: PWideChar;
webCheckoutDetailsCheckoutCancelUrl: PWideChar;
webCheckoutDetailsAmazonPayRedirectUrl: PWideChar;
productType: PWideChar;
paymentDetailsPaymentIntent: PWideChar;
paymentDetailsCanHandlePendingAuthorization: Boolean;
paymentDetailsChargeAmountAmount: PWideChar;
paymentDetailsChargeAmountCurrencyCode: PWideChar;
paymentDetailsTotalOrderAmount: PWideChar;
paymentDetailsSoftDescriptor: PWideChar;
paymentDetailsPresentmentCurrency: PWideChar;
paymentDetailsAllowOvercharge: PWideChar;
paymentDetailsExtendExpiration: PWideChar;
merchantMetadataMerchantReferenceId: PWideChar;
merchantMetadataMerchantStoreName: PWideChar;
merchantMetadataNoteToBuyer: PWideChar;
merchantMetadataCustomInformation: PWideChar;
supplementaryData: PWideChar;
buyerBuyerId: PWideChar;
buyerName: PWideChar;
buyerEmail: PWideChar;
buyerPhoneNumber: PWideChar;
buyerPrimeMembershipTypes: PWideChar;
billingAddressName: PWideChar;
billingAddressAddressLine1: PWideChar;
billingAddressAddressLine2: PWideChar;
billingAddressAddressLine3: PWideChar;
billingAddressCity: PWideChar;
billingAddressCounty: PWideChar;
billingAddressDistrict: PWideChar;
billingAddressStateOrRegion: PWideChar;
billingAddressPostalCode: PWideChar;
billingAddressCountryCode: PWideChar;
statusDetailsState: PWideChar;
statusDetailsReasonCode: PWideChar;
statusDetailsReasonDescription: PWideChar;
statusDetailsLastUpdatedTimestamp: PWideChar;
shippingAddressName: PWideChar;
shippingAddressAddressLine1: PWideChar;
shippingAddressAddressLine2: PWideChar;
shippingAddressAddressLine3: PWideChar;
shippingAddressCity: PWideChar;
shippingAddressCounty: PWideChar;
shippingAddressDistrict: PWideChar;
shippingAddressStateOrRegion: PWideChar;
shippingAddressPostalCode: PWideChar;
shippingAddressCountryCode: PWideChar;
shippingAddressPhoneNumber: PWideChar;
platformId: PWideChar;
chargePermissionId: PWideChar;
chargeId: PWideChar;
creationTimestamp: PWideChar;
expirationTimestamp: PWideChar;
storeId: PWideChar;
deliverySpecificationsAddressRestrictionsType: PWideChar;
providerMetadataProviderReferenceId: PWideChar;
releaseEnvironment: PWideChar;
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 := CkHttp_Create();

// Implements the following CURL command:

// curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId" \
// -X PATCH
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
//     "webCheckoutDetails": {
//         "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
//     },
//     "paymentDetails": {
//         "paymentIntent": "AuthorizeWithCapture",
//         "canHandlePendingAuthorization":false,
//         "softDescriptor": "Descriptor",
//         "chargeAmount": {
//             "amount": "1",
//             "currencyCode": "USD"
//         }
//      },
//     "merchantMetadata": {
//         "merchantReferenceId": "Merchant reference ID",
//         "merchantStoreName": "Merchant store name",
//         "noteToBuyer": "Note to buyer",
//         "customInformation": "Custom information"
//     }
// }'

// 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": {
//     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
//   },
//   "paymentDetails": {
//     "paymentIntent": "AuthorizeWithCapture",
//     "canHandlePendingAuthorization": false,
//     "softDescriptor": "Descriptor",
//     "chargeAmount": {
//       "amount": "1",
//       "currencyCode": "USD"
//     }
//   },
//   "merchantMetadata": {
//     "merchantReferenceId": "Merchant reference ID",
//     "merchantStoreName": "Merchant store name",
//     "noteToBuyer": "Note to buyer",
//     "customInformation": "Custom information"
//   }
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'webCheckoutDetails.checkoutResultReturnUrl','https://a.com/merchant-confirm-page');
CkJsonObject_UpdateString(json,'paymentDetails.paymentIntent','AuthorizeWithCapture');
CkJsonObject_UpdateBool(json,'paymentDetails.canHandlePendingAuthorization',False);
CkJsonObject_UpdateString(json,'paymentDetails.softDescriptor','Descriptor');
CkJsonObject_UpdateString(json,'paymentDetails.chargeAmount.amount','1');
CkJsonObject_UpdateString(json,'paymentDetails.chargeAmount.currencyCode','USD');
CkJsonObject_UpdateString(json,'merchantMetadata.merchantReferenceId','Merchant reference ID');
CkJsonObject_UpdateString(json,'merchantMetadata.merchantStoreName','Merchant store name');
CkJsonObject_UpdateString(json,'merchantMetadata.noteToBuyer','Note to buyer');
CkJsonObject_UpdateString(json,'merchantMetadata.customInformation','Custom information');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

// 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 := CkPrivateKey_Create();
success := CkPrivateKey_LoadPemFile(privKey,'C:/someDir/myAmazonPayPrivateKey.pem');
if (success = False) then
  begin
    Memo1.Lines.Add(CkPrivateKey__lastErrorText(privKey));
    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 := CkHttp_SetAuthPrivateKey(http,publicKeyId,privKey);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    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

CkHttp_putAccept(http,'application/json');

success := CkHttp_SetUrlVar(http,'sessionId','62b7d028-6c7c-4a43-b077-3897dff27c5b');
// To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
resp := CkHttp_PTextSb(http,'PATCH','https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{$sessionId}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

// If the status code is not equal to 200, this will display error information.
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode <> 200) then
  begin

    // 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('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
//   "webCheckoutDetails": {
//     "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
//     "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
//     "checkoutCancelUrl": null,
//     "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
//   },
//   "productType": "PayAndShip",
//   "paymentDetails": {
//     "paymentIntent": "AuthorizeWithCapture",
//     "canHandlePendingAuthorization": false,
//     "chargeAmount": {
//       "amount": "1",
//       "currencyCode": "USD"
//     },
//     "totalOrderAmount": null,
//     "softDescriptor": "Descriptor",
//     "presentmentCurrency": "USD",
//     "allowOvercharge": null,
//     "extendExpiration": null
//   },
//   "merchantMetadata": {
//     "merchantReferenceId": "Merchant reference ID",
//     "merchantStoreName": "Merchant store name",
//     "noteToBuyer": "Note to buyer",
//     "customInformation": "Custom information"
//   },
//   "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": "20191015T195703Z"
//   },
//   "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": [
//   ],
//   "creationTimestamp": "20191015T195655Z",
//   "expirationTimestamp": "20191016T195655Z",
//   "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 := CkJsonObject__stringOf(jResp,'checkoutSessionId');
webCheckoutDetailsCheckoutReviewReturnUrl := CkJsonObject__stringOf(jResp,'webCheckoutDetails.checkoutReviewReturnUrl');
webCheckoutDetailsCheckoutResultReturnUrl := CkJsonObject__stringOf(jResp,'webCheckoutDetails.checkoutResultReturnUrl');
webCheckoutDetailsCheckoutCancelUrl := CkJsonObject__stringOf(jResp,'webCheckoutDetails.checkoutCancelUrl');
webCheckoutDetailsAmazonPayRedirectUrl := CkJsonObject__stringOf(jResp,'webCheckoutDetails.amazonPayRedirectUrl');
productType := CkJsonObject__stringOf(jResp,'productType');
paymentDetailsPaymentIntent := CkJsonObject__stringOf(jResp,'paymentDetails.paymentIntent');
paymentDetailsCanHandlePendingAuthorization := CkJsonObject_BoolOf(jResp,'paymentDetails.canHandlePendingAuthorization');
paymentDetailsChargeAmountAmount := CkJsonObject__stringOf(jResp,'paymentDetails.chargeAmount.amount');
paymentDetailsChargeAmountCurrencyCode := CkJsonObject__stringOf(jResp,'paymentDetails.chargeAmount.currencyCode');
paymentDetailsTotalOrderAmount := CkJsonObject__stringOf(jResp,'paymentDetails.totalOrderAmount');
paymentDetailsSoftDescriptor := CkJsonObject__stringOf(jResp,'paymentDetails.softDescriptor');
paymentDetailsPresentmentCurrency := CkJsonObject__stringOf(jResp,'paymentDetails.presentmentCurrency');
paymentDetailsAllowOvercharge := CkJsonObject__stringOf(jResp,'paymentDetails.allowOvercharge');
paymentDetailsExtendExpiration := CkJsonObject__stringOf(jResp,'paymentDetails.extendExpiration');
merchantMetadataMerchantReferenceId := CkJsonObject__stringOf(jResp,'merchantMetadata.merchantReferenceId');
merchantMetadataMerchantStoreName := CkJsonObject__stringOf(jResp,'merchantMetadata.merchantStoreName');
merchantMetadataNoteToBuyer := CkJsonObject__stringOf(jResp,'merchantMetadata.noteToBuyer');
merchantMetadataCustomInformation := CkJsonObject__stringOf(jResp,'merchantMetadata.customInformation');
supplementaryData := CkJsonObject__stringOf(jResp,'supplementaryData');
buyerBuyerId := CkJsonObject__stringOf(jResp,'buyer.buyerId');
buyerName := CkJsonObject__stringOf(jResp,'buyer.name');
buyerEmail := CkJsonObject__stringOf(jResp,'buyer.email');
buyerPhoneNumber := CkJsonObject__stringOf(jResp,'buyer.phoneNumber');
buyerPrimeMembershipTypes := CkJsonObject__stringOf(jResp,'buyer.primeMembershipTypes');
billingAddressName := CkJsonObject__stringOf(jResp,'billingAddress.name');
billingAddressAddressLine1 := CkJsonObject__stringOf(jResp,'billingAddress.addressLine1');
billingAddressAddressLine2 := CkJsonObject__stringOf(jResp,'billingAddress.addressLine2');
billingAddressAddressLine3 := CkJsonObject__stringOf(jResp,'billingAddress.addressLine3');
billingAddressCity := CkJsonObject__stringOf(jResp,'billingAddress.city');
billingAddressCounty := CkJsonObject__stringOf(jResp,'billingAddress.county');
billingAddressDistrict := CkJsonObject__stringOf(jResp,'billingAddress.district');
billingAddressStateOrRegion := CkJsonObject__stringOf(jResp,'billingAddress.stateOrRegion');
billingAddressPostalCode := CkJsonObject__stringOf(jResp,'billingAddress.postalCode');
billingAddressCountryCode := CkJsonObject__stringOf(jResp,'billingAddress.countryCode');
statusDetailsState := CkJsonObject__stringOf(jResp,'statusDetails.state');
statusDetailsReasonCode := CkJsonObject__stringOf(jResp,'statusDetails.reasonCode');
statusDetailsReasonDescription := CkJsonObject__stringOf(jResp,'statusDetails.reasonDescription');
statusDetailsLastUpdatedTimestamp := CkJsonObject__stringOf(jResp,'statusDetails.lastUpdatedTimestamp');
shippingAddressName := CkJsonObject__stringOf(jResp,'shippingAddress.name');
shippingAddressAddressLine1 := CkJsonObject__stringOf(jResp,'shippingAddress.addressLine1');
shippingAddressAddressLine2 := CkJsonObject__stringOf(jResp,'shippingAddress.addressLine2');
shippingAddressAddressLine3 := CkJsonObject__stringOf(jResp,'shippingAddress.addressLine3');
shippingAddressCity := CkJsonObject__stringOf(jResp,'shippingAddress.city');
shippingAddressCounty := CkJsonObject__stringOf(jResp,'shippingAddress.county');
shippingAddressDistrict := CkJsonObject__stringOf(jResp,'shippingAddress.district');
shippingAddressStateOrRegion := CkJsonObject__stringOf(jResp,'shippingAddress.stateOrRegion');
shippingAddressPostalCode := CkJsonObject__stringOf(jResp,'shippingAddress.postalCode');
shippingAddressCountryCode := CkJsonObject__stringOf(jResp,'shippingAddress.countryCode');
shippingAddressPhoneNumber := CkJsonObject__stringOf(jResp,'shippingAddress.phoneNumber');
platformId := CkJsonObject__stringOf(jResp,'platformId');
chargePermissionId := CkJsonObject__stringOf(jResp,'chargePermissionId');
chargeId := CkJsonObject__stringOf(jResp,'chargeId');
creationTimestamp := CkJsonObject__stringOf(jResp,'creationTimestamp');
expirationTimestamp := CkJsonObject__stringOf(jResp,'expirationTimestamp');
storeId := CkJsonObject__stringOf(jResp,'storeId');
deliverySpecificationsAddressRestrictionsType := CkJsonObject__stringOf(jResp,'deliverySpecifications.addressRestrictions.type');
providerMetadataProviderReferenceId := CkJsonObject__stringOf(jResp,'providerMetadata.providerReferenceId');
releaseEnvironment := CkJsonObject__stringOf(jResp,'releaseEnvironment');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'paymentPreferences');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    paymentDescriptor := CkJsonObject__stringOf(jResp,'paymentPreferences[i].paymentDescriptor');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'constraints');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'deliverySpecifications.specialRestrictions');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'deliverySpecifications.specialRestrictions[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'deliverySpecifications.addressRestrictions.restrictions.US.zipCodes');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkPrivateKey_Dispose(privKey);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;