(Excel) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

Download Excel Class Modules Chilkat Excel Class Modules

' 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 Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

' Build the Authorization request header field value.
Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
' 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 Chilkat.Rest
Set rest = Chilkat.NewRest

bAutoReconnect = True

success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
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 jsonPartial As Chilkat.JsonObject
Set jsonPartial = Chilkat.NewJsonObject
jsonPartial.EmitCompact = False
success = jsonPartial.UpdateString("amount.total","2.34")
success = jsonPartial.UpdateString("amount.currency","USD")
' invoice_number is optional..
success = jsonPartial.UpdateString("invoice_number","INV-1234567")
Debug.Print jsonPartial.Emit()

' The JSON for a partial refund:

' 	{ 
' 	  "amount": { 
' 	    "total": "2.34",
' 	    "currency": "USD"
' 	  },
' 	  "invoice_number": "INV-1234567"
' 	}

success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddHeader("Content-Type","application/json")

' The sale ID is added to the path.
' The sale ID is obtained from payment records as shown here: Find Completed Sales
Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/v1/payments/sale/sale_id/refund")

numReplaced = sbPath.Replace("sale_id","1XC17935MN507400J")

' Send the POST request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As Chilkat.StringBuilder
Set sbJsonRequest = Chilkat.NewStringBuilder
jsonPartial.EmitCompact = True
success = jsonPartial.EmitSb(sbJsonRequest)
Dim sbJsonResponse As Chilkat.StringBuilder
Set sbJsonResponse = Chilkat.NewStringBuilder


bFullRefund = True
' To send a full refund, send an empty request body:
If (bFullRefund = True) Then
    sbJsonRequest.Clear 
    success = sbJsonRequest.Append("{}")
End If

success = rest.FullRequestSb("POST",sbPath.GetAsString(),sbJsonRequest,sbJsonResponse)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

Debug.Print "Response Status Code = "; rest.ResponseStatusCode

' Did we get a 201 success response?
If (rest.ResponseStatusCode <> 201) Then
    Debug.Print json.Emit()
    Debug.Print "Failed."
    Exit Sub
End If

Debug.Print json.Emit()
Debug.Print "Success."

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

' 	{ 
' 	  "id": "7NE550583A133505U",
' 	  "create_time": "2016-11-26T16:38:27Z",
' 	  "update_time": "2016-11-26T16:38:27Z",
' 	  "state": "completed",
' 	  "amount": { 
' 	    "total": "289.00",
' 	    "currency": "USD"
' 	  },
' 	  "sale_id": "1XC17935MN507400J",
' 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
' 	  "links": [
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
' 	      "rel": "self",
' 	      "method": "GET"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
' 	      "rel": "parent_payment",
' 	      "method": "GET"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
' 	      "rel": "sale",
' 	      "method": "GET"
' 	    }
' 	  ]
' 	}