(Xojo Plugin) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

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

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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
Dim success As Boolean
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..
// ----------------------------------------------------------------------------------------------

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

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

// To find captured payments, we list payments and look for those
// containing a "capture" resource.
success = rest.AddQueryParam("count","100")
success = rest.AddQueryParam("start_index","0")
success = rest.AddQueryParam("sort_by","update_time")
success = 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
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

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

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

// Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

// We are looking for "capture" resources .
// As shown below, we are looking in the "transactions" for "related_resources"
// containing "capture" JSON objects. 

// 	{ 
// 	  "payments": [
// 	    { 
// 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
// 	      "create_time": "2016-11-24T00:33:51Z",
// 	      "update_time": "2016-11-24T00:40:54Z",
// 	      "state": "approved",
// 	      "intent": "authorize",
// 	      "payer": { 
// 	        "payment_method": "credit_card",
// 	        "funding_instruments": [
// 	          { 
// 	            ...
// 	          }
// 	        ]
// 	      },
// 	      "transactions": [
// 	        { 
// 	          "amount": { 
// 	            ...
// 	          },
// 	          "description": "This is the payment transaction description.",
// 	          "related_resources": [
// 	            { 
// 	              "authorization": { 
// 	                ...
// 	              }
// 	            },
// 	            { 
// 	              "capture": { 
// 	                "id": "1LY5310469661362J",
// 	                "create_time": "2016-11-24T00:40:50Z",
// 	                "update_time": "2016-11-24T00:40:54Z",
// 	                "amount": { 
// 	                  "total": "4.54",
// 	                  "currency": "USD"
// 	                },
// 	                "state": "completed",
// 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	                "transaction_fee": { 
// 	                  "value": "0.43",
// 	                  "currency": "USD"
// 	                },
// 			...
// 

// Iterate over the payments and show each capture
Dim numPayments As Int32
numPayments = json.SizeOfArray("payments")
Dim i As Int32
i = 0
While i < numPayments
    json.I = i
    Dim j As Int32
    j = 0
    Dim numTransactions As Int32
    numTransactions = json.SizeOfArray("payments[i].transactions")
    While j < numTransactions
        json.J = j
        Dim numRelatedResources As Int32
        numRelatedResources = json.SizeOfArray("payments[i].transactions[j].related_resources")
        Dim k As Int32
        k = 0
        While k < numRelatedResources
            json.K = k
            If (json.HasMember("payments[i].transactions[j].related_resources[k].capture") = True) Then
                Dim jsonCapture As Chilkat.JsonObject
                jsonCapture = json.ObjectOf("payments[i].transactions[j].related_resources[k].capture")
                System.DebugLog("capture id: " + jsonCapture.StringOf("id"))
                System.DebugLog("state: " + jsonCapture.StringOf("state"))
                System.DebugLog("total: " + jsonCapture.StringOf("amount.total"))
                System.DebugLog("----")

            End If

            k = k + 1
        Wend
        j = j + 1
    Wend
    i = i + 1
Wend

System.DebugLog("success")