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

PayPal: Fully refund a capture

See more PayPal Examples

For a completed capture with no prior refunds, omit amount to request the full refund. A retry of the same refund must use its original request ID.

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

#  An empty JSON object requests a full refund. This example assumes no prior partial
#  refunds.

http.SetUrlVar("id","CAPTURE_ID")
#  Create and persist this key once per business operation. On a timeout,
#  retry the same request with its saved key, not a newly generated one.
crypt = chilkat.CkCrypt2()
requestId = crypt.generateUuid()
http.SetRequestHeader("PayPal-Request-Id",requestId)
http.SetRequestHeader("Prefer","return=representation")
body = chilkat.CkJsonObject()

success = http.HttpJson("POST","https://api-m.sandbox.paypal.com/v2/payments/captures/{$id}/refund",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("ID: " + result.stringOf("id"))
print("Status: " + result.stringOf("status"))
print("Amount: " + result.stringOf("amount.value"))
print("Currency: " + result.stringOf("amount.currency_code"))