(PowerShell) 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 Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# 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 = New-Object Chilkat.JsonObject
$jsonToken.LoadFile("qa_data/tokens/paypal.json")

# Build the Authorization request header field value.
$sbAuth = New-Object 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.
$rest = New-Object Chilkat.Rest
$bAutoReconnect = $true
$success = $rest.Connect("api.sandbox.paypal.com",443,$true,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# ----------------------------------------------------------------------------------------------
# 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.
$sbJsonResponse = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/v1/payments/payment",$sbJsonResponse)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$json = New-Object Chilkat.JsonObject
$json.EmitCompact = $false
$json.LoadSb($sbJsonResponse)

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

$("Response Status Code = " + $rest.ResponseStatusCode)

# Did we get a 200 success response?
if ($rest.ResponseStatusCode -ne 200) {
    $($json.Emit())
    $("Failed.")
    exit
}

# 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.
$numPayments = $json.SizeOfArray("payments")
$i = 0
while ($i -lt $numPayments) {

    $json.I = $i
    $j = 0
    $numTransactions = $json.SizeOfArray("payments[i].transactions")
    while ($j -lt $numTransactions) {
        $json.J = $j
        $numRelatedResources = $json.SizeOfArray("payments[i].transactions[j].related_resources")
        $k = 0
        while ($k -lt $numRelatedResources) {
            $json.K = $k
            if ($json.HasMember("payments[i].transactions[j].related_resources[k].sale") -eq $true) {
                $jsonSale = $json.ObjectOf("payments[i].transactions[j].related_resources[k].sale")
                $("sale id: " + $jsonSale.StringOf("id"))
                $("state: " + $jsonSale.StringOf("state"))
                $("total: " + $jsonSale.StringOf("amount.total"))
                $("----")

            }

            $k = $k + 1
        }

        $j = $j + 1
    }

    $i = $i + 1
}

$("success")