C# 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

C#

bool success = false;

//  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.
Chilkat.Http http = new Chilkat.Http();
http.AuthToken = "SANDBOX_ACCESS_TOKEN";
Chilkat.HttpResponse resp = new Chilkat.HttpResponse();

//  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);
if (success != true) {
    Debug.WriteLine("No HTTP response: " + http.LastErrorText);
    return;
}

if ((resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
    Chilkat.JsonObject errorInfo = new Chilkat.JsonObject();
    errorInfo.Load(resp.BodyStr);
    Debug.WriteLine("HTTP " + Convert.ToString(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"));
    Debug.WriteLine("PayPal debug ID: " + errorInfo.StringOf("debug_id"));
    return;
}

Chilkat.JsonObject result = new Chilkat.JsonObject();
bool parsed = result.Load(resp.BodyStr);
if (parsed != true) {
    Debug.WriteLine("Expected a JSON response; HTTP " + Convert.ToString(resp.StatusCode));
    return;
}

Debug.WriteLine("ID: " + result.StringOf("id"));
Debug.WriteLine("Status: " + result.StringOf("status"));
Debug.WriteLine("Number: " + result.StringOf("detail.invoice_number"));
Debug.WriteLine("Total: " + result.StringOf("amount.value"));
Debug.WriteLine("Currency: " + result.StringOf("amount.currency_code"));
Debug.WriteLine("Balance due: " + result.StringOf("due_amount.value"));