(Tcl) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

# To refund a particular amount, build JSON such as this:
set jsonPartial [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonPartial 0
CkJsonObject_UpdateString $jsonPartial "amount.total" "2.34"
CkJsonObject_UpdateString $jsonPartial "amount.currency" "USD"
# invoice_number is optional..
CkJsonObject_UpdateString $jsonPartial "invoice_number" "INV-1234567"
puts [CkJsonObject_emit $jsonPartial]

# The JSON for a partial refund:

# 	{ 
# 	  "amount": { 
# 	    "total": "2.34",
# 	    "currency": "USD"
# 	  },
# 	  "invoice_number": "INV-1234567"
# 	}

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

# 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/refund"
set numReplaced [CkStringBuilder_Replace $sbPath "sale_id" "1XC17935MN507400J"]

# Send the POST request containign the JSON in the request body, and get the JSON response.
set sbJsonRequest [new_CkStringBuilder]

CkJsonObject_put_EmitCompact $jsonPartial 1
CkJsonObject_EmitSb $jsonPartial $sbJsonRequest
set sbJsonResponse [new_CkStringBuilder]

set bFullRefund 1
# To send a full refund, send an empty request body:
if {$bFullRefund == 1} then {
    CkStringBuilder_Clear $sbJsonRequest
    CkStringBuilder_Append $sbJsonRequest "{}"
}

set success [CkRest_FullRequestSb $rest "POST" [CkStringBuilder_getAsString $sbPath] $sbJsonRequest $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkJsonObject $jsonPartial
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbJsonRequest
    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 201 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 201} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkJsonObject $jsonPartial
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbJsonRequest
    delete_CkStringBuilder $sbJsonResponse
    delete_CkJsonObject $json
    exit
}

puts [CkJsonObject_emit $json]
puts "Success."

# A successful JSON response:
# The "id" is the refund_id.

# 	{ 
# 	  "id": "7NE550583A133505U",
# 	  "create_time": "2016-11-26T16:38:27Z",
# 	  "update_time": "2016-11-26T16:38:27Z",
# 	  "state": "completed",
# 	  "amount": { 
# 	    "total": "289.00",
# 	    "currency": "USD"
# 	  },
# 	  "sale_id": "1XC17935MN507400J",
# 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
# 	      "rel": "parent_payment",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
# 	      "rel": "sale",
# 	      "method": "GET"
# 	    }
# 	  ]
# 	}

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $jsonPartial
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbJsonRequest
delete_CkStringBuilder $sbJsonResponse
delete_CkJsonObject $json