Tcl
Tcl
PayPal - Authorize a Payment
See more PayPal Examples
Creates an authorization for a payment. This is for the case where the payment will first be authorized, and then captured at a later date. (In other words, the buyer is providing his/her credit card information now, and the actual charge (capture) will take place at a later time.)Creating the authorization is the same as creating "sale" payment, except the intent is set to "authorize" instead of "sale".
This example requests an authorization for a credit card payment (using a credit card ID previoulsy stored in the PayPal vault).
Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# 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" "authorize"
CkJsonObject_UpdateString $json "payer.payment_method" "credit_card"
CkJsonObject_UpdateString $json "payer.funding_instruments[0].credit_card_token.credit_card_id" "CARD-52W84623JH8043102LA3CLGA"
CkJsonObject_UpdateString $json "payer.funding_instruments[0].credit_card_token.payer_id" "user12345"
CkJsonObject_UpdateString $json "transactions[0].amount.total" "6.70"
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": "authorize",
# "payer": {
# "payment_method": "credit_card",
# "funding_instruments": [
# {
# "credit_card_token": {
# "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
# "payer_id": "user12345"
# }
# }
# ]
# },
# "transactions": [
# {
# "amount": {
# "total": "6.70",
# "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]
# The authorization ID found in the related_resources is used to capture the payment at a later time.
puts "authorization id: [CkJsonObject_stringOf $json {transactions[0].related_resources[0].authorization.id}]"
puts "success"
# ------------------------------------------------
# A sample JSON response:
# {
# "id": "PAY-2CY489250W145633HLA3DK3Y",
# "create_time": "2016-11-24T00:33:51Z",
# "update_time": "2016-11-24T00:33:58Z",
# "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": "authorized",
# "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/authorization/7X8332687A4929542/capture",
# "rel": "capture",
# "method": "POST"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542/void",
# "rel": "void",
# "method": "POST"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ],
# "processor_response": {
# "avs_code": "X",
# "cvv_code": "M"
# },
# "fmf_details": {}
# }
# }
# ]
# }
# ],
# "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_CkJsonObject $json
delete_CkStringBuilder $sbJsonRequest
delete_CkStringBuilder $sbJsonResponse