(Excel) PayPal - Mark Invoice as Paid

Mark an invoice as paid.

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.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 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..
' ----------------------------------------------------------------------------------------------

' Build the JSON request body containing the reminder information:
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False
success = json.UpdateString("method","CREDIT_CARD")
Dim dtNow As Chilkat.CkDateTime
Set dtNow = Chilkat.NewCkDateTime
success = dtNow.SetFromCurrentSystemTime()
Dim sbDt As Chilkat.StringBuilder
Set sbDt = Chilkat.NewStringBuilder
success = sbDt.Append(dtNow.GetAsTimestamp(False))

numReplaced = sbDt.Replace("T"," ")
numReplaced = sbDt.Replace("Z"," UTC")
success = json.UpdateString("date",sbDt.GetAsString())
success = json.UpdateString("note","I got the payment by credit card!")
success = json.UpdateString("amount.currency","USD")
success = json.UpdateString("amount.value","500.00")
Debug.Print json.Emit()

' The JSON created by the above code:

' 	{ 
' 	  "method": "CREDIT_CARD",
' 	  "date": "2016-11-28 21:05:38 UTC",
' 	  "note": "I got the payment by credit card!",
' 	  "amount": { 
' 	    "currency": "USD",
' 	    "value": "500.00"
' 	  }
' 	}

' Build a path using a previously-sent invoice ID.
Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/v1/invoicing/invoices/invoice_id/record-payment")

numReplacements = sbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

json.EmitCompact = True
Dim sbRequestBody As Chilkat.StringBuilder
Set sbRequestBody = Chilkat.NewStringBuilder
Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder

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
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

' Check for a success response.
If (rest.ResponseStatusCode <> 204) Then
    Debug.Print sbResponseBody.GetAsString()
    Debug.Print "Failed."
    Exit Sub
End If

' For a success response, the response body is empty.
Debug.Print "Success."