Python Requires Chilkat v11.0.0+

PayPal: Record an external refund against an invoice

See more PayPal Examples

Record USD 5 already returned by bank transfer for a paid invoice. This call does not move money. To refund a PayPal capture, use the Payments v2 capture refund example instead.

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

# Record only money already returned outside PayPal. Reconcile first if a previous
# attempt timed out.

http.SetUrlVar("id","INVOICE_ID")
body = chilkat2.JsonObject()
body.UpdateString("method","BANK_TRANSFER")
body.UpdateString("amount.currency_code","USD")
body.UpdateString("amount.value","5.00")

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

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