(Perl) 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 Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use 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 = 1;
$success = $rest->Connect("api.sandbox.paypal.com",443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    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 = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/v1/payments/payment",$sbJsonResponse);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$json = chilkat::CkJsonObject->new();
$json->put_EmitCompact(0);
$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",0);

print "Response Status Code = " . $rest->get_ResponseStatusCode() . "\r\n";

# Did we get a 200 success response?
if ($rest->get_ResponseStatusCode() != 200) {
    print $json->emit() . "\r\n";
    print "Failed." . "\r\n";
    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 < $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].sale") == 1) {
                # jsonSale is a JsonObject
                $jsonSale = $json->ObjectOf("payments[i].transactions[j].related_resources[k].sale");
                print "sale id: " . $jsonSale->stringOf("id") . "\r\n";
                print "state: " . $jsonSale->stringOf("state") . "\r\n";
                print "total: " . $jsonSale->stringOf("amount.total") . "\r\n";
                print "----" . "\r\n";

            }

            $k = $k + 1;
        }

        $j = $j + 1;
    }

    $i = $i + 1;
}

print "success" . "\r\n";