(Tcl) PayPal - Create a PayPal Payment

See more PayPal Examples

Creates a payment to be paid from a PayPal account (as opposed to being funded by a credit card).

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 containing the transaction information.
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_UpdateString $json "intent" "sale"
CkJsonObject_UpdateString $json "redirect_urls.return_url" "http://www.example.com/return_url"
CkJsonObject_UpdateString $json "redirect_urls.cancel_url" "http://www.example.com/cancel_url"
CkJsonObject_UpdateString $json "payer.payment_method" "paypal"
CkJsonObject_UpdateString $json "transactions[0].amount.total" "7.47"
CkJsonObject_UpdateString $json "transactions[0].amount.currency" "USD"
CkJsonObject_UpdateString $json "transactions[0].description" "This is the payment transaction description."

puts [CkJsonObject_emit $json]

# The JSON created by the above code is this:

# 	{ 
# 	  "intent": "sale",
# 	  "redirect_urls": { 
# 	    "return_url": "http://www.example.com/return_url",
# 	    "cancel_url": "http://www.example.com/cancel_url"
# 	  },
# 	  "payer": { 
# 	    "payment_method": "paypal"
# 	  },
# 	  "transactions": [
# 	    { 
# 	      "amount": { 
# 	        "total": "7.47",
# 	        "currency": "USD"
# 	      },
# 	      "description": "This is the payment transaction description."
# 	    }
# 	  ]
# 	}

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

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

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

set success [CkRest_FullRequestSb $rest "POST" "/v1/payments/payment" $sbJsonRequest $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbJsonRequest
    delete_CkStringBuilder $sbJsonResponse
    exit
}

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

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

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

# 	{ 
# 	  "id": "PAY-1XK50350XV338620BLA3CZGI",
# 	  "intent": "sale",
# 	  "state": "created",
# 	  "payer": { 
# 	    "payment_method": "paypal",
# 	    "use_vendor_currency_conversion": false
# 	  },
# 	  "transactions": [
# 	    { 
# 	      "amount": { 
# 	        "total": "7.47",
# 	        "currency": "USD"
# 	      },
# 	      "description": "This is the payment transaction description.",
# 	      "related_resources": [
# 	      ]
# 	    }
# 	  ],
# 	  "create_time": "2016-11-23T23:56:09Z",
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0BG932459F977083J",
# 	      "rel": "approval_url",
# 	      "method": "REDIRECT"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI/execute",
# 	      "rel": "execute",
# 	      "method": "POST"
# 	    }
# 	  ]
# 	}

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