Python Requires Chilkat v11.0.0+

PayPal: Remove an external payment recorded on the wrong invoice

See more PayPal Examples

Use the saved external payment record ID. Verify that it belongs to the selected invoice, then remove the bookkeeping entry. The bank transfer itself is unaffected. Record it on the correct invoice as a separate step.

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

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

paymentId = "EXTERNAL_PAYMENT_ID"
matched = False
i = 0
while (i < result.SizeOfArray("payments.transactions")) :
    result.I = i
    if ((result.StringOfEquals("payments.transactions[i].payment_id",paymentId,True) == True) and (result.StringOfEquals("payments.transactions[i].type","EXTERNAL",True) == True)):
        matched = True

    i = i + 1

if (matched != True):
    print("This invoice has no matching external payment record.")
    sys.exit()

http.SetUrlVar("paymentId",paymentId)
success = http.HttpNoBody("DELETE","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/payments/{$paymentId}",resp)
if (success != True):
    print("No HTTP response: " + http.LastErrorText)
    sys.exit()

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

print("External payment entry removed.")