(Delphi ActiveX) PayPal - Find Completed Sales

List payments and find completed payments (sales transactions). Get the sales id, state, and total amount for each.

Note: This example requires Chilkat v9.5.0.65 or greater.

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
jsonToken: TChilkatJsonObject;
sbAuth: TChilkatStringBuilder;
rest: TChilkatRest;
bAutoReconnect: Integer;
success: Integer;
sbJsonResponse: TChilkatStringBuilder;
json: TChilkatJsonObject;
sbTemp: TChilkatStringBuilder;
numPayments: Integer;
i: Integer;
j: Integer;
numTransactions: Integer;
numRelatedResources: Integer;
k: Integer;
jsonSale: IChilkatJsonObject;

begin
// Note: Requires Chilkat v9.5.0.65 or greater.

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

// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
jsonToken := TChilkatJsonObject.Create(Self);
jsonToken.LoadFile('qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
sbAuth := TChilkatStringBuilder.Create(Self);
// token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf('token_type'));
sbAuth.Append(' ');
sbAuth.Append(jsonToken.StringOf('access_token'));

// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
rest := TChilkatRest.Create(Self);
bAutoReconnect := 1;
success := rest.Connect('api.sandbox.paypal.com',443,1,bAutoReconnect);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request.  Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------

// Clear the REST object of any headers or query params from previous requests.
rest.ClearAllHeaders();
rest.ClearAllQueryParams();

rest.AddHeader('Authorization',sbAuth.GetAsString());

// To find sales transactions, we list payments and look for those
// containing "sale" transactions
rest.AddQueryParam('count','100');
rest.AddQueryParam('start_index','0');
rest.AddQueryParam('sort_by','update_time');
rest.AddQueryParam('sort_order','asc');

// Send the GET request and get the JSON response.
sbJsonResponse := TChilkatStringBuilder.Create(Self);
success := rest.FullRequestNoBodySb('GET','/v1/payments/payment',sbJsonResponse.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;

json := TChilkatJsonObject.Create(Self);
json.EmitCompact := 0;
json.LoadSb(sbJsonResponse.ControlInterface);

// (optional) Save the entire JSON response to a file to examine if desired..
sbTemp := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbTemp.ControlInterface);
sbTemp.WriteFile('qa_output/paypal_payments.json','utf-8',0);

Memo1.Lines.Add('Response Status Code = ' + IntToStr(rest.ResponseStatusCode));

// Did we get a 200 success response?
if (rest.ResponseStatusCode <> 200) then
  begin
    Memo1.Lines.Add(json.Emit());
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// We are looking for sales transactions .
// As shown below, we are looking in the "transactions" for "related_resources"
// containing "sale" JSON objects. 

// 	{ 
// 	  "payments": [
// 	    { 
// 	      "id": "PAY-66A12106PU3254228LA3BYKI",
// 	      "create_time": "2016-11-23T22:46:01Z",
// 	      "update_time": "2016-11-23T22:46:07Z",
// 	      "state": "approved",
// 	      "intent": "sale",
// 	      "payer": { 
// 	          ...
// 	          }
// 	        ]
// 	      },
// 	      "transactions": [
// 	        { 
// 	          ...
// 	          "related_resources": [
// 	            { 
// 	              "sale": { 
// 	                "id": "70L88278E6781074B",
// 	                "create_time": "2016-11-23T22:46:01Z",
// 	                "update_time": "2016-11-23T22:46:07Z",
// 	                "amount": { 
// 	                  "total": "7.47",
// 	                  "currency": "USD"
// 	                },
// 	                "state": "completed",
// 	                "parent_payment": "PAY-66A12106PU3254228LA3BYKI",

// Iterate over the payments and show each sale transaction.
numPayments := json.SizeOfArray('payments');
i := 0;
while i < numPayments do
  begin

    json.I := i;
    j := 0;
    numTransactions := json.SizeOfArray('payments[i].transactions');
    while j < numTransactions do
      begin
        json.J := j;
        numRelatedResources := json.SizeOfArray('payments[i].transactions[j].related_resources');
        k := 0;
        while k < numRelatedResources do
          begin
            json.K := k;
            if (json.HasMember('payments[i].transactions[j].related_resources[k].sale') = 1) then
              begin
                jsonSale := json.ObjectOf('payments[i].transactions[j].related_resources[k].sale');
                Memo1.Lines.Add('sale id: ' + jsonSale.StringOf('id'));
                Memo1.Lines.Add('state: ' + jsonSale.StringOf('state'));
                Memo1.Lines.Add('total: ' + jsonSale.StringOf('amount.total'));
                Memo1.Lines.Add('----');

              end;
            k := k + 1;
          end;

        j := j + 1;
      end;

    i := i + 1;
  end;

Memo1.Lines.Add('success');
end;