Python Requires Chilkat v11.0.0+

PayPal: Partially refund a capture

See more PayPal Examples

Return USD 5 against a specific capture. Use its original currency and check the refundable amount. Store the returned refund ID and inspect its status.

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

# Use the capture ID and currency of the original transaction, even if the order has
# several captures.

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 = chilkat2.Crypt2()
requestId = crypt.GenerateUuid()
http.SetRequestHeader("PayPal-Request-Id",requestId)
http.SetRequestHeader("Prefer","return=representation")
body = chilkat2.JsonObject()
body.UpdateString("amount.currency_code","USD")
body.UpdateString("amount.value","5.00")

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.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("ID: " + result.StringOf("id"))
print("Status: " + result.StringOf("status"))
print("Amount: " + result.StringOf("amount.value"))
print("Currency: " + result.StringOf("amount.currency_code"))