(Delphi DLL) Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments.

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

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;
chargeId: PWideChar;
chargePermissionId: PWideChar;
chargeAmountAmount: PWideChar;
chargeAmountCurrencyCode: PWideChar;
captureAmountAmount: PWideChar;
captureAmountCurrencyCode: PWideChar;
refundedAmountAmount: PWideChar;
refundedAmountCurrencyCode: PWideChar;
convertedAmount: PWideChar;
conversionRate: PWideChar;
softDescriptor: PWideChar;
merchantMetadata: PWideChar;
providerMetadataProviderReferenceId: PWideChar;
statusDetailsState: PWideChar;
statusDetailsReasonCode: PWideChar;
statusDetailsReasonDescription: PWideChar;
statusDetailsLastUpdatedTimestamp: PWideChar;
creationTimestamp: PWideChar;
expirationTimestamp: PWideChar;
releaseEnvironment: PWideChar;

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/charges/:chargeId/cancel" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
//     "cancellationReason": "REASON DESCRIPTION"
// }'

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

// {
//   "cancellationReason": "REASON DESCRIPTION"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'cancellationReason','REASON DESCRIPTION');

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 chargeId here:
success := CkHttp_SetUrlVar(http,'chargeId','bd504926-f659-4ad7-a1a9-9a747aaf5275');
// 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/charges/{$chargeId}/cancel',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)

// {
//   "chargeId": "P21-1111111-1111111-C111111",
//   "chargePermissionId": "P21-1111111-1111111",
//   "chargeAmount": {
//     "amount": "14.00",
//     "currencyCode": "USD"
//   },
//   "captureAmount": {
//     "amount": "14.00",
//     "currencyCode": "USD"
//   },
//   "refundedAmount": {
//     "amount": "0.00",
//     "currencyCode": "USD"
//   },
//   "convertedAmount": "14.00",
//   "conversionRate": "1.00",
//   "softDescriptor": "SOFT DESCRIPTOR",
//   "merchantMetadata": null,
//   "providerMetadata": {
//     "providerReferenceId": null
//   },
//   "statusDetails": {
//     "state": "Canceled",
//     "reasonCode": null,
//     "reasonDescription": null,
//     "lastUpdatedTimestamp": "20190714T155300Z"
//   },
//   "creationTimestamp": "20190714T155300Z",
//   "expirationTimestamp": "20190715T155300Z",
//   "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

chargeId := CkJsonObject__stringOf(jResp,'chargeId');
chargePermissionId := CkJsonObject__stringOf(jResp,'chargePermissionId');
chargeAmountAmount := CkJsonObject__stringOf(jResp,'chargeAmount.amount');
chargeAmountCurrencyCode := CkJsonObject__stringOf(jResp,'chargeAmount.currencyCode');
captureAmountAmount := CkJsonObject__stringOf(jResp,'captureAmount.amount');
captureAmountCurrencyCode := CkJsonObject__stringOf(jResp,'captureAmount.currencyCode');
refundedAmountAmount := CkJsonObject__stringOf(jResp,'refundedAmount.amount');
refundedAmountCurrencyCode := CkJsonObject__stringOf(jResp,'refundedAmount.currencyCode');
convertedAmount := CkJsonObject__stringOf(jResp,'convertedAmount');
conversionRate := CkJsonObject__stringOf(jResp,'conversionRate');
softDescriptor := CkJsonObject__stringOf(jResp,'softDescriptor');
merchantMetadata := CkJsonObject__stringOf(jResp,'merchantMetadata');
providerMetadataProviderReferenceId := CkJsonObject__stringOf(jResp,'providerMetadata.providerReferenceId');
statusDetailsState := CkJsonObject__stringOf(jResp,'statusDetails.state');
statusDetailsReasonCode := CkJsonObject__stringOf(jResp,'statusDetails.reasonCode');
statusDetailsReasonDescription := CkJsonObject__stringOf(jResp,'statusDetails.reasonDescription');
statusDetailsLastUpdatedTimestamp := CkJsonObject__stringOf(jResp,'statusDetails.lastUpdatedTimestamp');
creationTimestamp := CkJsonObject__stringOf(jResp,'creationTimestamp');
expirationTimestamp := CkJsonObject__stringOf(jResp,'expirationTimestamp');
releaseEnvironment := CkJsonObject__stringOf(jResp,'releaseEnvironment');

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

end;