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

PayPal: Record a bank transfer against an invoice

See more PayPal Examples

Record USD 45 already received by bank transfer. The invoice may still have a balance. This makes a bookkeeping entry; it does not debit the customer. Save payment_id for reconciliation.

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

#  Record only a bank transfer you have already received. Reconcile first if a previous
#  attempt timed out.

http.SetUrlVar("id","INVOICE_ID")
body = chilkat.CkJsonObject()
body.UpdateString("method","BANK_TRANSFER")
body.UpdateString("amount.currency_code","USD")
body.UpdateString("amount.value","45.00")

#  Use the actual date of the transfer; this example records one made today.
date = chilkat.CkDateTime()
date.SetFromCurrentSystemTime()
body.UpdateString("payment_date",date.getAsIso8601("YYYY-MM-DD",False))

success = http.HttpJson("POST","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/payments",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)):
    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("Record ID: " + result.stringOf("payment_id"))