(VB.NET) PayPal - Find Completed Sales

List payments and find completed payments (sales transactions). Get the sales id, state, and total amount for each.

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

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

' 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
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"
sbAuth.Append(jsonToken.StringOf("token_type"))
sbAuth.Append(" ")
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 = True
Dim success As Boolean = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.WriteLine(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..
' ----------------------------------------------------------------------------------------------

' Clear the REST object of any headers or query params from previous requests.
rest.ClearAllHeaders()
rest.ClearAllQueryParams()

rest.AddHeader("Authorization",sbAuth.GetAsString())

' To find sales transactions, we list payments and look for those
' containing "sale" transactions
rest.AddQueryParam("count","100")
rest.AddQueryParam("start_index","0")
rest.AddQueryParam("sort_by","update_time")
rest.AddQueryParam("sort_order","asc")

' Send the GET request and get the JSON response.
Dim sbJsonResponse As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/v1/payments/payment",sbJsonResponse)
If (success <> True) Then
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If


Dim json As New Chilkat.JsonObject
json.EmitCompact = False
json.LoadSb(sbJsonResponse)

' (optional) Save the entire JSON response to a file to examine if desired..
Dim sbTemp As New Chilkat.StringBuilder
json.EmitSb(sbTemp)
sbTemp.WriteFile("qa_output/paypal_payments.json","utf-8",False)

Debug.WriteLine("Response Status Code = " & rest.ResponseStatusCode)

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


' We are looking for sales transactions .
' As shown below, we are looking in the "transactions" for "related_resources"
' containing "sale" JSON objects. 

' 	{ 
' 	  "payments": [
' 	    { 
' 	      "id": "PAY-66A12106PU3254228LA3BYKI",
' 	      "create_time": "2016-11-23T22:46:01Z",
' 	      "update_time": "2016-11-23T22:46:07Z",
' 	      "state": "approved",
' 	      "intent": "sale",
' 	      "payer": { 
' 	          ...
' 	          }
' 	        ]
' 	      },
' 	      "transactions": [
' 	        { 
' 	          ...
' 	          "related_resources": [
' 	            { 
' 	              "sale": { 
' 	                "id": "70L88278E6781074B",
' 	                "create_time": "2016-11-23T22:46:01Z",
' 	                "update_time": "2016-11-23T22:46:07Z",
' 	                "amount": { 
' 	                  "total": "7.47",
' 	                  "currency": "USD"
' 	                },
' 	                "state": "completed",
' 	                "parent_payment": "PAY-66A12106PU3254228LA3BYKI",

' Iterate over the payments and show each sale transaction.
Dim numPayments As Integer = json.SizeOfArray("payments")
Dim i As Integer = 0
While i < numPayments

    json.I = i
    Dim j As Integer = 0
    Dim numTransactions As Integer = json.SizeOfArray("payments[i].transactions")
    While j < numTransactions
        json.J = j
        Dim numRelatedResources As Integer = json.SizeOfArray("payments[i].transactions[j].related_resources")
        Dim k As Integer = 0
        While k < numRelatedResources
            json.K = k
            If (json.HasMember("payments[i].transactions[j].related_resources[k].sale") = True) Then
                Dim jsonSale As Chilkat.JsonObject = json.ObjectOf("payments[i].transactions[j].related_resources[k].sale")
                Debug.WriteLine("sale id: " & jsonSale.StringOf("id"))
                Debug.WriteLine("state: " & jsonSale.StringOf("state"))
                Debug.WriteLine("total: " & jsonSale.StringOf("amount.total"))
                Debug.WriteLine("----")

            End If

            k = k + 1
        End While
        j = j + 1
    End While
    i = i + 1
End While


Debug.WriteLine("success")