(Delphi ActiveX) Amazon Pay - Create Refund

See more Amazon Pay Examples

Initiate a full or partial refund for a charge.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

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

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;
json: TChilkatJsonObject;
privKey: TPrivateKey;
publicKeyId: WideString;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
refundId: WideString;
chargeId: WideString;
refundAmountAmount: WideString;
refundAmountCurrencyCode: WideString;
softDescriptor: WideString;
creationTimestamp: WideString;
statusDetailsState: WideString;
statusDetailsReasonCode: WideString;
statusDetailsReasonDescription: WideString;
statusDetailsLastUpdatedTimestamp: WideString;
releaseEnvironment: WideString;

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/refunds/" \
// -X POST
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
// -d '{
//     "chargeId": "CHARGE_ID",
//     "refundAmount": {
//         "amount": "14.00",
//         "currencyCode": "USD"
//     },
//     "softDescriptor": "Descriptor"
// }'

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

// {
//     "chargeId": "CHARGE_ID",
//     "refundAmount": {
//         "amount": "14.00",
//         "currencyCode": "USD"
//     },
//     "softDescriptor": "Descriptor"
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('chargeId','CHARGE_ID');
json.UpdateString('refundAmount.amount','14.00');
json.UpdateString('refundAmount.currencyCode','USD');
json.UpdateString('softDescriptor','Descriptor');

// 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
// x-amz-pay-idempotency-key
// Authorization

http.Accept := 'application/json';

// To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
resp := http.PostJson3('https://pay-api.amazon.eu/sandbox/v2/refunds/','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

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

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

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

    Exit;
  end;

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

// {
//      "refundId": "S01-5105180-3221187-R022311",
//      "chargeId": "S01-5105180-3221187-C056351",
//      "refundAmount": {
//          "amount": "14.00",
//          "currencyCode": "USD"
//      },
//      "softDescriptor": "Descriptor",
//      "creationTimestamp": "20190714T155300Z",
//      "statusDetails": {
//          "state": "RefundInitiated",
//          "reasonCode": null,
//          "reasonDescription": null,
//          "lastUpdatedTimestamp": "20190714T155300Z"
//      },
//      "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

refundId := jResp.StringOf('refundId');
chargeId := jResp.StringOf('chargeId');
refundAmountAmount := jResp.StringOf('refundAmount.amount');
refundAmountCurrencyCode := jResp.StringOf('refundAmount.currencyCode');
softDescriptor := jResp.StringOf('softDescriptor');
creationTimestamp := jResp.StringOf('creationTimestamp');
statusDetailsState := jResp.StringOf('statusDetails.state');
statusDetailsReasonCode := jResp.StringOf('statusDetails.reasonCode');
statusDetailsReasonDescription := jResp.StringOf('statusDetails.reasonDescription');
statusDetailsLastUpdatedTimestamp := jResp.StringOf('statusDetails.lastUpdatedTimestamp');
releaseEnvironment := jResp.StringOf('releaseEnvironment');
end;