(Delphi DLL) Amazon Pay - Close Charge Permission

See more Amazon Pay Examples

Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#close-charge-permission

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;
reasonCode: PWideChar;
reasonDescription: PWideChar;
chargePermissionId: PWideChar;
chargePermissionReferenceId: PWideChar;
buyerBuyerId: PWideChar;
buyerName: PWideChar;
buyerEmail: PWideChar;
buyerPhoneNumber: PWideChar;
buyerPrimeMembershipTypes: PWideChar;
releaseEnvironment: PWideChar;
shippingAddressName: PWideChar;
shippingAddressAddressLine1: PWideChar;
shippingAddressAddressLine2: PWideChar;
shippingAddressAddressLine3: PWideChar;
shippingAddressCity: PWideChar;
shippingAddressCounty: PWideChar;
shippingAddressDistrict: PWideChar;
shippingAddressStateOrRegion: PWideChar;
shippingAddressPostalCode: PWideChar;
shippingAddressCountryCode: PWideChar;
shippingAddressPhoneNumber: PWideChar;
billingAddressName: PWideChar;
billingAddressAddressLine1: PWideChar;
billingAddressAddressLine2: PWideChar;
billingAddressAddressLine3: PWideChar;
billingAddressCity: PWideChar;
billingAddressCounty: PWideChar;
billingAddressDistrict: PWideChar;
billingAddressStateOrRegion: PWideChar;
billingAddressPostalCode: PWideChar;
billingAddressCountryCode: PWideChar;
billingAddressPhoneNumber: PWideChar;
statusDetailsState: PWideChar;
statusDetailsLastUpdatedTimestamp: PWideChar;
creationTimestamp: PWideChar;
expirationTimestamp: PWideChar;
merchantMetadataMerchantReferenceId: PWideChar;
merchantMetadataMerchantStoreName: PWideChar;
merchantMetadataNoteToBuyer: PWideChar;
merchantMetadataCustomInformation: PWideChar;
platformId: PWideChar;
limitsAmountLimitAmount: PWideChar;
limitsAmountLimitCurrencyCode: PWideChar;
limitsAmountBalanceAmount: PWideChar;
limitsAmountBalanceCurrencyCode: PWideChar;
presentmentCurrency: 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/chargePermissions/:chargePermissionId/close" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
//     "closureReason": "No more charges required",
//     "cancelPendingCharges": false
// }'

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

// {
//     "closureReason": "No more charges required",
//     "cancelPendingCharges": false
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'closureReason','No more charges required');
CkJsonObject_UpdateBool(json,'cancelPendingCharges',False);

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

// Use the actual chargePermissionId here:
success := CkHttp_SetUrlVar(http,'chargePermissionId','CHARGE_PERMISSION_ID');
// 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,'DELETE','https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close',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
    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)

// {
//     "chargePermissionId": "chargePermission-1",
//     "chargePermissionReferenceId": null,
//     "buyer": {
//         "buyerId": "buyerId",
//         "name": "name-1",
//         "email": "name@amazon.com",
//         "phoneNumber": "800-000-0000",
//         "primeMembershipTypes": null
//     },
//     "releaseEnvironment": "Live",
//     "shippingAddress": {  // Null for PayOnly product type
//         "name": "Work",
//         "addressLine1": "440 Terry Ave",
//         "addressLine2": "",
//         "addressLine3": "",
//         "city": "Seattle",
//         "county": "King",
//         "district": "Seattle",
//         "stateOrRegion": "WA",
//         "postalCode": "98121",
//         "countryCode": "US",
//         "phoneNumber": "800-000-0000"
//     },
//     "billingAddress": {  // Only available in EU or for PayOnly product type
//         "name": "Work",
//         "addressLine1": "440 Terry Ave",
//         "addressLine2": "",
//         "addressLine3": "",
//         "city": "Seattle",
//         "county": "King",
//         "district": "Seattle",
//         "stateOrRegion": "WA",
//         "postalCode": "98121",
//         "countryCode": "US",
//         "phoneNumber": "800-000-0000"
//     },
//     "paymentPreferences": [
//     {
//         "paymentDescriptor": null
//     }],
//     "statusDetails": {
//         "state": "Closed",
//         "reasons":
//         [{
//             "reasonCode": null,
//             "reasonDescription": null
//         }],
//         "lastUpdatedTimestamp": "20190714T155300Z"
//     },
//     "creationTimestamp": "20190714T155300Z",
//     "expirationTimestamp": "20190715T155300Z",
//     "merchantMetadata":{
//         "merchantReferenceId": "123-77-876", 
//         "merchantStoreName": "AmazonTestStoreFront",
//         "noteToBuyer": "merchantNoteForBuyer",
//         "customInformation": "This is custom information" 
//     },
//     "platformId": "SPId",
//     "limits": {
//         "amountLimit": {
//             "amount": "14.00",
//             "currencyCode": "USD"
//         },
//         "amountBalance": {
//             "amount": "14.00",
//             "currencyCode": "USD"
//         }
//     },
//     "presentmentCurrency": "USD"
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

chargePermissionId := CkJsonObject__stringOf(jResp,'chargePermissionId');
chargePermissionReferenceId := CkJsonObject__stringOf(jResp,'chargePermissionReferenceId');
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');
releaseEnvironment := CkJsonObject__stringOf(jResp,'releaseEnvironment');
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');
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');
billingAddressPhoneNumber := CkJsonObject__stringOf(jResp,'billingAddress.phoneNumber');
statusDetailsState := CkJsonObject__stringOf(jResp,'statusDetails.state');
statusDetailsLastUpdatedTimestamp := CkJsonObject__stringOf(jResp,'statusDetails.lastUpdatedTimestamp');
creationTimestamp := CkJsonObject__stringOf(jResp,'creationTimestamp');
expirationTimestamp := CkJsonObject__stringOf(jResp,'expirationTimestamp');
merchantMetadataMerchantReferenceId := CkJsonObject__stringOf(jResp,'merchantMetadata.merchantReferenceId');
merchantMetadataMerchantStoreName := CkJsonObject__stringOf(jResp,'merchantMetadata.merchantStoreName');
merchantMetadataNoteToBuyer := CkJsonObject__stringOf(jResp,'merchantMetadata.noteToBuyer');
merchantMetadataCustomInformation := CkJsonObject__stringOf(jResp,'merchantMetadata.customInformation');
platformId := CkJsonObject__stringOf(jResp,'platformId');
limitsAmountLimitAmount := CkJsonObject__stringOf(jResp,'limits.amountLimit.amount');
limitsAmountLimitCurrencyCode := CkJsonObject__stringOf(jResp,'limits.amountLimit.currencyCode');
limitsAmountBalanceAmount := CkJsonObject__stringOf(jResp,'limits.amountBalance.amount');
limitsAmountBalanceCurrencyCode := CkJsonObject__stringOf(jResp,'limits.amountBalance.currencyCode');
presentmentCurrency := CkJsonObject__stringOf(jResp,'presentmentCurrency');
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,'statusDetails.reasons');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    reasonCode := CkJsonObject__stringOf(jResp,'statusDetails.reasons[i].reasonCode');
    reasonDescription := CkJsonObject__stringOf(jResp,'statusDetails.reasons[i].reasonDescription');
    i := i + 1;
  end;

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

end;