(Tcl) PayPal - Mark Invoice as Paid

Mark an invoice as paid.

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..
# ----------------------------------------------------------------------------------------------

# Build the JSON request body containing the reminder information:
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_UpdateString $json "method" "CREDIT_CARD"
set dtNow [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dtNow
set sbDt [new_CkStringBuilder]

CkStringBuilder_Append $sbDt [CkDateTime_getAsTimestamp $dtNow 0]
set numReplaced [CkStringBuilder_Replace $sbDt "T" " "]
set numReplaced [CkStringBuilder_Replace $sbDt "Z" " UTC"]
CkJsonObject_UpdateString $json "date" [CkStringBuilder_getAsString $sbDt]
CkJsonObject_UpdateString $json "note" "I got the payment by credit card!"
CkJsonObject_UpdateString $json "amount.currency" "USD"
CkJsonObject_UpdateString $json "amount.value" "500.00"
puts [CkJsonObject_emit $json]

# The JSON created by the above code:

# 	{ 
# 	  "method": "CREDIT_CARD",
# 	  "date": "2016-11-28 21:05:38 UTC",
# 	  "note": "I got the payment by credit card!",
# 	  "amount": { 
# 	    "currency": "USD",
# 	    "value": "500.00"
# 	  }
# 	}

# Build a path using a previously-sent invoice ID.
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/v1/invoicing/invoices/invoice_id/record-payment"
set numReplacements [CkStringBuilder_Replace $sbPath "invoice_id" "INV2-QCHR-QHSD-M2VU-AVXC"]

CkJsonObject_put_EmitCompact $json 1
set sbRequestBody [new_CkStringBuilder]

set sbResponseBody [new_CkStringBuilder]

CkRest_AddHeader $rest "Content-Type" "application/json"
CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]
CkJsonObject_EmitSb $json $sbRequestBody

set success [CkRest_FullRequestSb $rest "POST" [CkStringBuilder_getAsString $sbPath] $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkDateTime $dtNow
    delete_CkStringBuilder $sbDt
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

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

# Check for a success response.
if {[CkRest_get_ResponseStatusCode $rest] != 204} then {
    puts [CkStringBuilder_getAsString $sbResponseBody]
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkDateTime $dtNow
    delete_CkStringBuilder $sbDt
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

# For a success response, the response body is empty.
puts "Success."

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkDateTime $dtNow
delete_CkStringBuilder $sbDt
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody