Sample code for 30+ languages & platforms
CkPython 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

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

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.
http = chilkat.CkHttp()
http.put_AuthToken("SANDBOX_ACCESS_TOKEN")
resp = chilkat.CkHttpResponse()

#  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):
    print("No HTTP response: " + http.lastErrorText())
    sys.exit()

if ((resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    errorInfo = chilkat.CkJsonObject()
    errorInfo.Load(resp.bodyStr())
    print("HTTP " + str(resp.get_StatusCode()) + " " + errorInfo.stringOf("name") + " " + errorInfo.stringOf("details[0].issue"))
    print("PayPal debug ID: " + errorInfo.stringOf("debug_id"))
    sys.exit()

result = chilkat.CkJsonObject()
parsed = result.Load(resp.bodyStr())
if (parsed != True):
    print("Expected a JSON response; HTTP " + str(resp.get_StatusCode()))
    sys.exit()

print("ID: " + result.stringOf("id"))
print("Status: " + result.stringOf("status"))
print("Number: " + result.stringOf("detail.invoice_number"))
print("Total: " + result.stringOf("amount.value"))
print("Currency: " + result.stringOf("amount.currency_code"))
print("Balance due: " + result.stringOf("due_amount.value"))