Pascal (Lazarus/Delphi)

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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

Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.StringBuilder,
  Chilkat.Rest,
  Chilkat.JsonObject,
  Chilkat.CkDateTime;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  jsonToken: TJsonObject;
  sbAuth: TStringBuilder;
  rest: TRest;
  bAutoReconnect: Boolean;
  json: TJsonObject;
  dtNow: TCkDateTime;
  sbDt: TStringBuilder;
  numReplaced: Integer;
  sbPath: TStringBuilder;
  numReplacements: Integer;
  sbRequestBody: TStringBuilder;
  sbResponseBody: TStringBuilder;

begin
  success := False;

  //  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 := TJsonObject.Create;
  jsonToken.LoadFile('qa_data/tokens/paypal.json');

  //  Build the Authorization request header field value.
  sbAuth := TStringBuilder.Create;
  //  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 := TRest.Create;
  bAutoReconnect := True;
  success := rest.Connect('api.sandbox.paypal.com',443,True,bAutoReconnect);
  if (success <> True) then
    begin
      WriteLn(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..
  //  ----------------------------------------------------------------------------------------------

  //  Build the JSON request body containing the reminder information:
  json := TJsonObject.Create;
  json.EmitCompact := False;
  dtNow := TCkDateTime.Create;
  dtNow.SetFromCurrentSystemTime();
  sbDt := TStringBuilder.Create;
  sbDt.Append(dtNow.GetAsTimestamp(False));
  numReplaced := sbDt.Replace('T',' ');
  numReplaced := sbDt.Replace('Z',' UTC');
  json.UpdateString('date',sbDt.GetAsString());
  json.UpdateString('note','Refunded by credit card!');
  json.UpdateString('amount.currency','USD');
  json.UpdateString('amount.value','500.00');
  WriteLn(json.Emit());

  //  The JSON created by the above code:

  //  	{ 
  //  	  "date": "2016-11-28 21:05:38 UTC",
  //  	  "note": "Refunded by credit card!",
  //  	  "amount": { 
  //  	    "currency": "USD",
  //  	    "value": "500.00"
  //  	  }
  //  	}

  //  Build a path using a previously-sent invoice ID.
  sbPath := TStringBuilder.Create;
  sbPath.Append('/v1/invoicing/invoices/invoice_id/record-refund');
  numReplacements := sbPath.Replace('invoice_id','INV2-QCHR-QHSD-M2VU-AVXC');

  json.EmitCompact := True;
  sbRequestBody := TStringBuilder.Create;
  sbResponseBody := TStringBuilder.Create;

  rest.AddHeader('Content-Type','application/json');
  rest.AddHeader('Authorization',sbAuth.GetAsString());
  json.EmitSb(sbRequestBody);

  success := rest.FullRequestSb('POST',sbPath.GetAsString(),sbRequestBody,sbResponseBody);
  if (success <> True) then
    begin
      WriteLn(rest.LastErrorText);
      Exit;
    end;

  WriteLn('Response Status Code = ' + rest.ResponseStatusCode);

  //  Check for a success response.
  if (rest.ResponseStatusCode <> 204) then
    begin
      WriteLn(sbResponseBody.GetAsString());
      WriteLn('Failed.');
      Exit;
    end;

  //  For a success response, the response body is empty.
  WriteLn('Success.');


  jsonToken.Free;
  sbAuth.Free;
  rest.Free;
  json.Free;
  dtNow.Free;
  sbDt.Free;
  sbPath.Free;
  sbRequestBody.Free;
  sbResponseBody.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.