Tcl
Tcl
PayPal - Find Authorizations
See more PayPal Examples
Finds previously created authorizations.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# 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 == 0} 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 authoriaztions, we list payments and look for those
# containing "authorization" 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 == 0} 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 "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
set jsonAuth [new_CkJsonObject]
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].authorization"] == 1} then {
CkJsonObject_ObjectOf2 $json "payments[i].transactions[j].related_resources[k].authorization" $jsonAuth
puts "authorization id: [CkJsonObject_stringOf $jsonAuth id]"
puts "state: [CkJsonObject_stringOf $jsonAuth state]"
puts "total: [CkJsonObject_stringOf $jsonAuth amount.total]"
puts "----"
}
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
delete_CkJsonObject $jsonAuth