Xojo Plugin

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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.65 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..
// ----------------------------------------------------------------------------------------------

// Build the JSON request body containing the reminder information:
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
Dim dtNow As New Chilkat.CkDateTime
success = dtNow.SetFromCurrentSystemTime()
Dim sbDt As New Chilkat.StringBuilder
success = sbDt.Append(dtNow.GetAsTimestamp(False))
Dim numReplaced As Int32
numReplaced = sbDt.Replace("T"," ")
numReplaced = sbDt.Replace("Z"," UTC")
success = json.UpdateString("date",sbDt.GetAsString())
success = json.UpdateString("note","Refunded by credit card!")
success = json.UpdateString("amount.currency","USD")
success = json.UpdateString("amount.value","500.00")
System.DebugLog(json.Emit())

// The JSON created by the above code:

// 	{ 
// 	  "date": "2016-11-28 21:05:38 UTC",
// 	  "note": "Refunded by credit card!",
// 	  "amount": { 
// 	    "currency": "USD",
// 	    "value": "500.00"
// 	  }
// 	}

// Build a path using a previously-sent invoice ID.
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/invoicing/invoices/invoice_id/record-refund")
Dim numReplacements As Int32
numReplacements = sbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

json.EmitCompact = True
Dim sbRequestBody As New Chilkat.StringBuilder
Dim sbResponseBody As New Chilkat.StringBuilder

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

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

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

// Check for a success response.
If (rest.ResponseStatusCode <> 204) Then
    System.DebugLog(sbResponseBody.GetAsString())
    System.DebugLog("Failed.")
    Return
End If

// For a success response, the response body is empty.
System.DebugLog("Success.")