Xojo Plugin Requires Chilkat v11.0.0+

PayPal - Find Authorizations

See more PayPal Examples

Finds previously created authorizations. Xojo Plugin

Dim success As Boolean
success = False

//  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 = False) 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 authoriaztions, we list payments and look for those
//  containing "authorization" transactions
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 = False) 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 "authorization" transactions .
//  As shown below, we are looking in the "transactions" for "related_resources"
//  containing "authorization" JSON objects. 

//  	{ 
//  	  "payments": [
//  	    { 
//  	      "id": "PAY-3SL8976592063093RLA3DMAY",
//  	      "create_time": "2016-11-24T00:36:19Z",
//  	      "update_time": "2016-11-24T00:36:24Z",
//  	      "state": "approved",
//  	      "intent": "authorize",
//  	      "payer": { 
//  	        "payment_method": "credit_card",
//  	        "funding_instruments": [
//  	          { 
//  	            "credit_card_token": { 
//  	              "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
//  	              "payer_id": "user12345",
//  	              "last4": "9974",
//  	              "type": "visa",
//  	              "expire_month": "9",
//  	              "expire_year": "2021"
//  	            }
//  	          }
//  	        ]
//  	      },
//  	      "transactions": [
//  	        { 
//  	          "amount": { 
//  	            "total": "6.70",
//  	            "currency": "USD",
//  	            "details": { 
//  	              "subtotal": "6.70"
//  	            }
//  	          },
//  	          "description": "This is the payment transaction description.",
//  	          "related_resources": [
//  	            { 
//  	              "authorization": { 
//  	                "id": "6HG91590AX913463C",
//  	                "create_time": "2016-11-24T00:36:19Z",
//  	                "update_time": "2016-11-24T00:36:24Z",
//  	                "amount": { 
//  	                  ...
//  	                  }
//  	                },
//  	                "state": "authorized",
//  	                "parent_payment": "PAY-3SL8976592063093RLA3DMAY",
//  	                "valid_until": "2016-12-23T00:36:19Z",
//  			...
//  

//  Iterate over the payments and show each authorization
Dim jsonAuth As New Chilkat.JsonObject
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].authorization") = True) Then

                success = json.ObjectOf2("payments[i].transactions[j].related_resources[k].authorization",jsonAuth)

                System.DebugLog("authorization id: " + jsonAuth.StringOf("id"))
                System.DebugLog("state: " + jsonAuth.StringOf("state"))
                System.DebugLog("total: " + jsonAuth.StringOf("amount.total"))
                System.DebugLog("----")
            End If

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

System.DebugLog("success")