Python 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

Python

import sys
import chilkat2

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 = chilkat2.Http()
http.AuthToken = "SANDBOX_ACCESS_TOKEN"
resp = chilkat2.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):
    print("No HTTP response: " + http.LastErrorText)
    sys.exit()

if ((resp.StatusCode < 200) or (resp.StatusCode >= 300)):
    errorInfo = chilkat2.JsonObject()
    errorInfo.Load(resp.BodyStr)
    print("HTTP " + str(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"))
    print("PayPal debug ID: " + errorInfo.StringOf("debug_id"))
    sys.exit()

result = chilkat2.JsonObject()
parsed = result.Load(resp.BodyStr)
if (parsed != True):
    print("Expected a JSON response; HTTP " + str(resp.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"))