Tcl Requires Chilkat v11.0.0+
Tcl
PayPal - Show Payment Details
See more PayPal Examples
Shows details for a payment by ID.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]
# The payment ID is added to the path.
set sbPath [new_CkStringBuilder]
CkStringBuilder_Append $sbPath "/v1/payments/payment/payment_id"
set numReplaced [CkStringBuilder_Replace $sbPath "payment_id" "PAY-62106714J93631829LA44NWI"]
# 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 == 0} 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]"
set dtUtc [new_CkDtObj]
CkDateTime_ToDtObj $dateTime 0 $dtUtc
puts [CkDtObj_get_Month $dtUtc]/[CkDtObj_get_Day $dtUtc]/[CkDtObj_get_Year $dtUtc]
puts "success"
# ------------------------------------------------
# A sample JSON response:
# {
# "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": [
# {
# "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": "7X8332687A4929542",
# "create_time": "2016-11-24T00:33:51Z",
# "update_time": "2016-11-24T00:33:58Z",
# "amount": {
# "total": "6.70",
# "currency": "USD",
# "details": {
# "subtotal": "6.70"
# }
# },
# "state": "captured",
# "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
# "valid_until": "2016-12-23T00:33:51Z",
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
# "rel": "self",
# "method": "GET"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ]
# }
# },
# {
# "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"
# },
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
# "rel": "self",
# "method": "GET"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
# "rel": "refund",
# "method": "POST"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ]
# }
# }
# ]
# }
# ],
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "self",
# "method": "GET"
# }
# ]
# }
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json
delete_CkDateTime $dateTime
delete_CkDtObj $dtUtc