(Delphi DLL) PayPal - Get Sale Details

Shows details for a sale transaction, by ID.

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, DtObj, JsonObject, CkDateTime;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
sbAuth: HCkStringBuilder;
rest: HCkRest;
bAutoReconnect: Boolean;
success: Boolean;
sbPath: HCkStringBuilder;
numReplaced: Integer;
sbJsonResponse: HCkStringBuilder;
json: HCkJsonObject;
dateTime: HCkDateTime;
dtUtc: HCkDtObj;

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

// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
sbPath := CkStringBuilder_Create();
CkStringBuilder_Append(sbPath,'/v1/payments/sale/sale_id');
numReplaced := CkStringBuilder_Replace(sbPath,'sale_id','1XC17935MN507400J');

// Send the GET request and get the JSON response.
sbJsonResponse := CkStringBuilder_Create();
success := CkRest_FullRequestNoBodySb(rest,'GET',CkStringBuilder__getAsString(sbPath),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);

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;

// Sample JSON response is shown below.
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('----------------------');

// Show how to get a timestamp, such as update_time.
dateTime := CkDateTime_Create();
success := CkDateTime_SetFromTimestamp(dateTime,CkJsonObject__stringOf(json,'update_time'));
Memo1.Lines.Add('utc update_time: ' + CkDateTime__getAsTimestamp(dateTime,False));
Memo1.Lines.Add('local update_time: ' + CkDateTime__getAsTimestamp(dateTime,True));
Memo1.Lines.Add('utc rfc822: ' + CkDateTime__getAsRfc822(dateTime,False));
Memo1.Lines.Add('local rfc822: ' + CkDateTime__getAsRfc822(dateTime,True));

dtUtc := CkDateTime_GetDtObj(dateTime,False);
Memo1.Lines.Add(IntToStr(CkDtObj_getMonth(dtUtc)) + '/' + IntToStr(CkDtObj_getDay(dtUtc)) + '/' + IntToStr(CkDtObj_getYear(dtUtc)));
CkDtObj_Dispose(dtUtc);

Memo1.Lines.Add('success');

// ------------------------------------------------
// A sample JSON response:

// 	{ 
// 	  "id": "1XC17935MN507400J",
// 	  "create_time": "2016-11-25T15:42:50Z",
// 	  "update_time": "2016-11-25T15:42:56Z",
// 	  "amount": { 
// 	    "total": "289.00",
// 	    "currency": "USD"
// 	  },
// 	  "payment_mode": "INSTANT_TRANSFER",
// 	  "state": "completed",
// 	  "protection_eligibility": "ELIGIBLE",
// 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
// 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
// 	  "transaction_fee": { 
// 	    "value": "8.68",
// 	    "currency": "USD"
// 	  },
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
// 	      "rel": "refund",
// 	      "method": "POST"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}

CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbPath);
CkStringBuilder_Dispose(sbJsonResponse);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(dateTime);

end;