(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.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)
set jsonToken [new_CkJsonObject]

CkJsonObject_LoadFile $jsonToken "qa_data/tokens/paypal.json"

# Build the Authorization request header field value.
set sbAuth [new_CkStringBuilder]

# token_type should be "Bearer"
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "token_type"]
CkStringBuilder_Append $sbAuth " "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "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.
set rest [new_CkRest]

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.sandbox.paypal.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    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.
CkRest_ClearAllHeaders $rest
CkRest_ClearAllQueryParams $rest

CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]

# To find sales transactions, we list payments and look for those
# containing "sale" transactions
CkRest_AddQueryParam $rest "count" "100"
CkRest_AddQueryParam $rest "start_index" "0"
CkRest_AddQueryParam $rest "sort_by" "update_time"
CkRest_AddQueryParam $rest "sort_order" "asc"

# Send the GET request and get the JSON response.
set sbJsonResponse [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/v1/payments/payment" $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbJsonResponse
    exit
}

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_LoadSb $json $sbJsonResponse

# (optional) Save the entire JSON response to a file to examine if desired..
set sbTemp [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbTemp
CkStringBuilder_WriteFile $sbTemp "qa_output/paypal_payments.json" "utf-8" 0

puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"

# Did we get a 200 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbJsonResponse
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbTemp
    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.
set numPayments [CkJsonObject_SizeOfArray $json "payments"]
set i 0
while {$i < $numPayments} {

    CkJsonObject_put_I $json $i
    set j 0
    set numTransactions [CkJsonObject_SizeOfArray $json "payments[i].transactions"]
    while {$j < $numTransactions} {
        CkJsonObject_put_J $json $j
        set numRelatedResources [CkJsonObject_SizeOfArray $json "payments[i].transactions[j].related_resources"]
        set k 0
        while {$k < $numRelatedResources} {
            CkJsonObject_put_K $json $k
            if {[CkJsonObject_HasMember $json "payments[i].transactions[j].related_resources[k].sale"] == 1} then {
                # jsonSale is a CkJsonObject
                set jsonSale [CkJsonObject_ObjectOf $json "payments[i].transactions[j].related_resources[k].sale"]
                puts "sale id: [CkJsonObject_stringOf $jsonSale id]"
                puts "state: [CkJsonObject_stringOf $jsonSale state]"
                puts "total: [CkJsonObject_stringOf $jsonSale amount.total]"
                puts "----"
                delete_CkJsonObject $jsonSale

            }

            set k [expr $k + 1]
        }
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

puts "success"

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json
delete_CkStringBuilder $sbTemp