Delphi ActiveX Requires Chilkat v11.0.0+

PayPal: Read an invoice and its outstanding balance

See more PayPal Examples

Use the PayPal invoice ID to retrieve its number, status, total and balance due. A partial external payment can reduce the balance without settling the whole invoice.

PayPal documentation

Delphi ActiveX

var
success: Integer;
http: TChilkatHttp;
resp: TChilkatHttpResponse;
errorInfo: TChilkatJsonObject;
result: TChilkatJsonObject;
parsed: Integer;

begin
success := 0;

//  See Unlock Chilkat before making requests.
//  For the merchant's internal backoffice application. Load the sandbox token
//  from the merchant's credential store. Keep it out of publicly distributed apps.
//  See Get a PayPal access token.
http := TChilkatHttp.Create(Self);
http.AuthToken := 'SANDBOX_ACCESS_TOKEN';
resp := TChilkatHttpResponse.Create(Self);

//  The original total and the balance still due may differ after a payment.

http.SetUrlVar('id','INVOICE_ID');

success := http.HttpNoBody('GET','https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}',resp.ControlInterface);
if (success <> 1) then
  begin
    Memo1.Lines.Add('No HTTP response: ' + http.LastErrorText);
    Exit;
  end;
if ((resp.StatusCode < 200) or (resp.StatusCode >= 300)) then
  begin
    errorInfo := TChilkatJsonObject.Create(Self);
    errorInfo.Load(resp.BodyStr);
    Memo1.Lines.Add('HTTP ' + IntToStr(resp.StatusCode) + ' ' + errorInfo.StringOf('name') + ' ' + errorInfo.StringOf('details[0].issue'));
    Memo1.Lines.Add('PayPal debug ID: ' + errorInfo.StringOf('debug_id'));
    Exit;
  end;

result := TChilkatJsonObject.Create(Self);
parsed := result.Load(resp.BodyStr);
if (parsed <> 1) then
  begin
    Memo1.Lines.Add('Expected a JSON response; HTTP ' + IntToStr(resp.StatusCode));
    Exit;
  end;
Memo1.Lines.Add('ID: ' + result.StringOf('id'));
Memo1.Lines.Add('Status: ' + result.StringOf('status'));
Memo1.Lines.Add('Number: ' + result.StringOf('detail.invoice_number'));
Memo1.Lines.Add('Total: ' + result.StringOf('amount.value'));
Memo1.Lines.Add('Currency: ' + result.StringOf('amount.currency_code'));
Memo1.Lines.Add('Balance due: ' + result.StringOf('due_amount.value'));