Sample code for 30+ languages & platforms
CkPython Requires Chilkat v11.0.0+

PayPal: Get a payable invoice link for your own email

See more PayPal Examples

Use a draft dated today or earlier. Make it payable with customer email suppressed, then retrieve the recipient view URL for the merchant's email. Future-dated invoices are scheduled for delivery and should use a different workflow.

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()

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()
parsedResult = result.Load(resp.bodyStr())
if (parsedResult != True):
    print("Expected a JSON response; HTTP " + str(resp.get_StatusCode()))
    sys.exit()

if (result.StringOfEquals("status","DRAFT",True) != True):
    print("Select an unsent draft.")
    sys.exit()

#  Compare the ISO calendar dates at UTC midnight before asking PayPal to send.
now = chilkat.CkDateTime()
now.SetFromCurrentSystemTime()
stamp = chilkat.CkStringBuilder()
stamp.Append(result.stringOf("detail.invoice_date"))
stamp.Append("T00:00:00Z")
issue = chilkat.CkDateTime()
validDate = issue.SetFromTimestamp(stamp.getAsString())
if ((validDate != True) or (now.DiffSeconds(issue) < 0)):
    print("Select a draft with an issue date of today or earlier.")
    sys.exit()

body = chilkat.CkJsonObject()
body.UpdateBool("send_to_recipient",False)
body.UpdateBool("send_to_invoicer",False)
success = http.HttpJson("POST","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/send",body,"application/json",resp)
if (success != True):
    print("No HTTP response: " + http.lastErrorText())
    sys.exit()

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

#  Read back the invoice: acceptance of the send alone does not guarantee it is payable.
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)):
    invoiceError = chilkat.CkJsonObject()
    invoiceError.Load(resp.bodyStr())
    print("HTTP " + str(resp.get_StatusCode()) + " " + invoiceError.stringOf("name") + " " + invoiceError.stringOf("details[0].issue"))
    print("PayPal debug ID: " + invoiceError.stringOf("debug_id"))
    sys.exit()

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

if (((invoice.StringOfEquals("status","SENT",True) == True) or (invoice.StringOfEquals("status","UNPAID",True) == True) or (invoice.StringOfEquals("status","SHARED",True) == True)) and (invoice.HasMember("detail.metadata.recipient_view_url") == True)):
    print("Customer payment page: " + invoice.stringOf("detail.metadata.recipient_view_url"))
    sys.exit()

print("Invoice is " + invoice.stringOf("status") + ". Retrieve it again when payable.")