(Delphi DLL) 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 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, StringBuilder, Rest, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
sbAuth: HCkStringBuilder;
rest: HCkRest;
bAutoReconnect: Boolean;
success: Boolean;
sbJsonResponse: HCkStringBuilder;
json: HCkJsonObject;
sbTemp: HCkStringBuilder;
numPayments: Integer;
i: Integer;
j: Integer;
numTransactions: Integer;
numRelatedResources: Integer;
k: Integer;
jsonSale: HCkJsonObject;

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 := CkJsonObject_Create();
CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
sbAuth := CkStringBuilder_Create();
// token_type should be "Bearer"
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(jsonToken,'token_type'));
CkStringBuilder_Append(sbAuth,' ');
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(jsonToken,'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 := CkRest_Create();
bAutoReconnect := True;
success := CkRest_Connect(rest,'api.sandbox.paypal.com',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    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.
CkRest_ClearAllHeaders(rest);
CkRest_ClearAllQueryParams(rest);

CkRest_AddHeader(rest,'Authorization',CkStringBuilder__getAsString(sbAuth));

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

// Send the GET request and get the JSON response.
sbJsonResponse := CkStringBuilder_Create();
success := CkRest_FullRequestNoBodySb(rest,'GET','/v1/payments/payment',sbJsonResponse);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);
CkJsonObject_LoadSb(json,sbJsonResponse);

// (optional) Save the entire JSON response to a file to examine if desired..
sbTemp := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbTemp);
CkStringBuilder_WriteFile(sbTemp,'qa_output/paypal_payments.json','utf-8',False);

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

// Did we get a 200 success response?
if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add(CkJsonObject__emit(json));
    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 := CkJsonObject_SizeOfArray(json,'payments');
i := 0;
while i < numPayments do
  begin

    CkJsonObject_putI(json,i);
    j := 0;
    numTransactions := CkJsonObject_SizeOfArray(json,'payments[i].transactions');
    while j < numTransactions do
      begin
        CkJsonObject_putJ(json,j);
        numRelatedResources := CkJsonObject_SizeOfArray(json,'payments[i].transactions[j].related_resources');
        k := 0;
        while k < numRelatedResources do
          begin
            CkJsonObject_putK(json,k);
            if (CkJsonObject_HasMember(json,'payments[i].transactions[j].related_resources[k].sale') = True) then
              begin
                jsonSale := CkJsonObject_ObjectOf(json,'payments[i].transactions[j].related_resources[k].sale');
                Memo1.Lines.Add('sale id: ' + CkJsonObject__stringOf(jsonSale,'id'));
                Memo1.Lines.Add('state: ' + CkJsonObject__stringOf(jsonSale,'state'));
                Memo1.Lines.Add('total: ' + CkJsonObject__stringOf(jsonSale,'amount.total'));
                Memo1.Lines.Add('----');
                CkJsonObject_Dispose(jsonSale);
              end;
            k := k + 1;
          end;

        j := j + 1;
      end;

    i := i + 1;
  end;

Memo1.Lines.Add('success');

CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbJsonResponse);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbTemp);

end;