(Tcl) PayPal - Get Sale Details

Shows details for a sale transaction, by ID.

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]

# The sale ID is added to the path.
# The sale ID is obtained from payment records as shown here: Find Completed Sales
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/v1/payments/sale/sale_id"
set numReplaced [CkStringBuilder_Replace $sbPath "sale_id" "1XC17935MN507400J"]

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

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

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_LoadSb $json $sbJsonResponse

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 $sbPath
    delete_CkStringBuilder $sbJsonResponse
    delete_CkJsonObject $json
    exit
}

# Sample JSON response is shown below.
puts [CkJsonObject_emit $json]
puts "----------------------"

# Show how to get a timestamp, such as update_time.
set dateTime [new_CkDateTime]

set success [CkDateTime_SetFromTimestamp $dateTime [CkJsonObject_stringOf $json "update_time"]]
puts "utc update_time: [CkDateTime_getAsTimestamp $dateTime 0]"
puts "local update_time: [CkDateTime_getAsTimestamp $dateTime 1]"
puts "utc rfc822: [CkDateTime_getAsRfc822 $dateTime 0]"
puts "local rfc822: [CkDateTime_getAsRfc822 $dateTime 1]"

# dtUtc is a CkDtObj
set dtUtc [CkDateTime_GetDtObj $dateTime 0]
puts [CkDtObj_get_Month $dtUtc]/[CkDtObj_get_Day $dtUtc]/[CkDtObj_get_Year $dtUtc]
delete_CkDtObj $dtUtc

puts "success"

# ------------------------------------------------
# A sample JSON response:

# 	{ 
# 	  "id": "1XC17935MN507400J",
# 	  "create_time": "2016-11-25T15:42:50Z",
# 	  "update_time": "2016-11-25T15:42:56Z",
# 	  "amount": { 
# 	    "total": "289.00",
# 	    "currency": "USD"
# 	  },
# 	  "payment_mode": "INSTANT_TRANSFER",
# 	  "state": "completed",
# 	  "protection_eligibility": "ELIGIBLE",
# 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
# 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
# 	  "transaction_fee": { 
# 	    "value": "8.68",
# 	    "currency": "USD"
# 	  },
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
# 	      "rel": "refund",
# 	      "method": "POST"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
# 	      "rel": "parent_payment",
# 	      "method": "GET"
# 	    }
# 	  ]
# 	}

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json
delete_CkDateTime $dateTime