Xojo Plugin

PayPal Send Invoice

See more PayPal Examples

Sends a PayPal invoice to a customer.

See also Send Invoice

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

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

success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddQueryParam("notify_merchant","true")

Dim responseBody As String
responseBody = rest.FullRequestFormUrlEncoded("POST",sbPath.GetAsString())
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

// Did we get a 202 accepted response?
If (rest.ResponseStatusCode <> 202) Then
    System.DebugLog(responseBody)
    System.DebugLog("Failed.")
    Return
End If

// If the 202 response is received, the response body would be empty...
System.DebugLog("Success.")