Xojo Plugin

PayPal - Refund Captured Payment

See more PayPal Examples

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

Note: This example requires Chilkat v9.5.0.65 or greater.

Xojo Plugin

Dim success As Boolean
success = False

// Note: Requires Chilkat v9.5.0.64 or greater.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = sbAuth.Append(jsonToken.StringOf("access_token"))

// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
Dim rest As New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request.  Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------

// To refund a particular amount, build JSON such as this:
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.UpdateString("amount.total","4.54")
success = json.UpdateString("amount.currency","USD")
success = json.UpdateString("description","Athletic socks")
success = json.UpdateString("reason","Refunding because color was incorrect")
System.DebugLog(json.Emit())

// The JSON:

// 	{ 
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "description": "Athletic socks",
// 	  "reason": "Refunding because color was incorrect"
// 	}
// 
success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddHeader("Content-Type","application/json")

// The capture ID is added to the path.
// To list your captures: Find Captures. 
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/payments/capture/capture_id/refund")
Dim numReplaced As Int32
numReplaced = sbPath.Replace("capture_id","1LY5310469661362J")

// Send the POST request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As New Chilkat.StringBuilder
json.EmitCompact = True
success = json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As New Chilkat.StringBuilder

success = rest.FullRequestSb("POST",sbPath.GetAsString(),sbJsonRequest,sbJsonResponse)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))

// Did we get a 201 success response?
If (rest.ResponseStatusCode <> 201) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

System.DebugLog(json.Emit())
System.DebugLog("Success.")

// A successful JSON response:
// The "id" is the refund_id.

// 	{ 
// 	  "id": "77B77607RR7243500",
// 	  "create_time": "2016-11-27T01:38:25Z",
// 	  "update_time": "2016-11-27T01:38:25Z",
// 	  "state": "completed",
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "capture_id": "1LY5310469661362J",
// 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
// 	      "rel": "capture",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}