(Ruby) PayPal - Find Authorizations

Finds previously created authorizations.

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

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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)
jsonToken = Chilkat::CkJsonObject.new()
jsonToken.LoadFile("qa_data/tokens/paypal.json")

# Build the Authorization request header field value.
sbAuth = Chilkat::CkStringBuilder.new()
# 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.
rest = Chilkat::CkRest.new()
bAutoReconnect = true
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# ----------------------------------------------------------------------------------------------
# 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 authoriaztions, we list payments and look for those
# containing "authorization" 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.
sbJsonResponse = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/v1/payments/payment",sbJsonResponse)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.LoadSb(sbJsonResponse)

# (optional) Save the entire JSON response to a file to examine if desired..
sbTemp = Chilkat::CkStringBuilder.new()
json.EmitSb(sbTemp)
sbTemp.WriteFile("qa_output/paypal_payments.json","utf-8",false)

print "Response Status Code = " + rest.get_ResponseStatusCode().to_s() + "\n";

# Did we get a 200 success response?
if (rest.get_ResponseStatusCode() != 200)
    print json.emit() + "\n";
    print "Failed." + "\n";
    exit
end

# 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
numPayments = json.SizeOfArray("payments")
i = 0
while i < numPayments
    json.put_I(i)
    j = 0
    numTransactions = json.SizeOfArray("payments[i].transactions")
    while j < numTransactions
        json.put_J(j)
        numRelatedResources = json.SizeOfArray("payments[i].transactions[j].related_resources")
        k = 0
        while k < numRelatedResources
            json.put_K(k)
            if (json.HasMember("payments[i].transactions[j].related_resources[k].authorization") == true)
                # jsonAuth is a CkJsonObject
                jsonAuth = json.ObjectOf("payments[i].transactions[j].related_resources[k].authorization")
                print "authorization id: " + jsonAuth.stringOf("id") + "\n";
                print "state: " + jsonAuth.stringOf("state") + "\n";
                print "total: " + jsonAuth.stringOf("amount.total") + "\n";
                print "----" + "\n";

            end

            k = k + 1
        end
        j = j + 1
    end
    i = i + 1
end

print "success" + "\n";