(Tcl) PayPal - Cancel Sent Invoice

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails.

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 "subject" "Past due"
CkJsonObject_UpdateString $json "note" "Canceling invoice"
CkJsonObject_UpdateBool $json "send_to_merchant" 1
CkJsonObject_UpdateBool $json "send_to_payer" 1
puts [CkJsonObject_emit $json]

# The JSON created by the above code:

# 	{ 
# 	  "subject": "Past due",
# 	  "note": "Canceling invoice",
# 	  "send_to_merchant": true,
# 	  "send_to_payer": true
# 	}

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

CkStringBuilder_Append $sbPath "/v1/invoicing/invoices/invoice_id/cancel"
set numReplacements [CkStringBuilder_Replace $sbPath "invoice_id" "INV2-XPWZ-NUTQ-LNWB-P8NC"]

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_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

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

# In our testing, we received a 204 response, which is a success HTTP response code, but 
# differs from the PayPal REST API reference documentation, which states that a 202 response
# is expected.  I suspect an error in the PayPal documentation, or in the PayPal responder.
# Check for either 202 or 204..
# Did we get a 202 accepted response?
if {expr [[CkRest_get_ResponseStatusCode $rest] != 202]  &&  [[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_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

# The 202/204 response should be empty.  (Again, our experience differs from the online PayPal documentation..)
puts "Success."

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody