Sample code for 30+ languages & platforms
Xojo Plugin 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 Xojo Plugin Downloads

Xojo Plugin
Dim success As Boolean
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.
Dim http As New Chilkat.Http
http.AuthToken = "SANDBOX_ACCESS_TOKEN"
Dim resp As New Chilkat.HttpResponse

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

success = 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.
Dim crypt As New Chilkat.Crypt2
Dim requestId As String
requestId = crypt.GenerateUuid()
http.SetRequestHeader "PayPal-Request-Id",requestId
http.SetRequestHeader "Prefer","return=representation"
Dim body As New Chilkat.JsonObject

success = http.HttpJson("POST","https://api-m.sandbox.paypal.com/v2/payments/captures/{$id}/refund",body,"application/json",resp)
If (success <> True) Then
    System.DebugLog("No HTTP response: " + http.LastErrorText)
    Return
End If

If ((resp.StatusCode < 200) Or (resp.StatusCode >= 300)) Then
    Dim errorInfo As New Chilkat.JsonObject
    success = errorInfo.Load(resp.BodyStr)
    System.DebugLog("HTTP " + Str(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"))
    System.DebugLog("PayPal debug ID: " + errorInfo.StringOf("debug_id"))
    Return
End If

Dim result As New Chilkat.JsonObject
Dim parsed As Boolean
parsed = result.Load(resp.BodyStr)
If (parsed <> True) Then
    System.DebugLog("Expected a JSON response; HTTP " + Str(resp.StatusCode))
    Return
End If

System.DebugLog("ID: " + result.StringOf("id"))
System.DebugLog("Status: " + result.StringOf("status"))
System.DebugLog("Amount: " + result.StringOf("amount.value"))
System.DebugLog("Currency: " + result.StringOf("amount.currency_code"))