(Tcl) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

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 captured payments, we list payments and look for those
# containing a "capture" resource.
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 "capture" resources .
# As shown below, we are looking in the "transactions" for "related_resources"
# containing "capture" JSON objects. 

# 	{ 
# 	  "payments": [
# 	    { 
# 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
# 	      "create_time": "2016-11-24T00:33:51Z",
# 	      "update_time": "2016-11-24T00:40:54Z",
# 	      "state": "approved",
# 	      "intent": "authorize",
# 	      "payer": { 
# 	        "payment_method": "credit_card",
# 	        "funding_instruments": [
# 	          { 
# 	            ...
# 	          }
# 	        ]
# 	      },
# 	      "transactions": [
# 	        { 
# 	          "amount": { 
# 	            ...
# 	          },
# 	          "description": "This is the payment transaction description.",
# 	          "related_resources": [
# 	            { 
# 	              "authorization": { 
# 	                ...
# 	              }
# 	            },
# 	            { 
# 	              "capture": { 
# 	                "id": "1LY5310469661362J",
# 	                "create_time": "2016-11-24T00:40:50Z",
# 	                "update_time": "2016-11-24T00:40:54Z",
# 	                "amount": { 
# 	                  "total": "4.54",
# 	                  "currency": "USD"
# 	                },
# 	                "state": "completed",
# 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
# 	                "transaction_fee": { 
# 	                  "value": "0.43",
# 	                  "currency": "USD"
# 	                },
# 			...
# 

# Iterate over the payments and show each capture
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].capture"] == 1} then {
                # jsonCapture is a CkJsonObject
                set jsonCapture [CkJsonObject_ObjectOf $json "payments[i].transactions[j].related_resources[k].capture"]
                puts "capture id: [CkJsonObject_stringOf $jsonCapture id]"
                puts "state: [CkJsonObject_stringOf $jsonCapture state]"
                puts "total: [CkJsonObject_stringOf $jsonCapture amount.total]"
                puts "----"
                delete_CkJsonObject $jsonCapture

            }

            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