(Tcl) PayPal - Store Credit Card in Vault

Saves the buyer's credit card information to PayPal's vault. This avoids storing credit card details on your server and thus PCI compliance is no longer an issue.

Note: For sandbox calls, you can use the credit card numbers provided in your sandbox test accounts.

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 credit card data.
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_UpdateString $json "payer_id" "user12345"
CkJsonObject_UpdateString $json "type" "visa"
CkJsonObject_UpdateString $json "number" "4032031087659974"
CkJsonObject_UpdateString $json "expire_month" "9"
CkJsonObject_UpdateString $json "expire_year" "2021"
CkJsonObject_UpdateString $json "first_name" "Joe"
CkJsonObject_UpdateString $json "last_name" "Shopper"

puts [CkJsonObject_emit $json]

# The JSON created by the above code is this:

# 	{ 
# 	  "payer_id": "user12345",
# 	  "type": "visa",
# 	  "number": "4032031087659974",
# 	  "expire_month": "9",
# 	  "expire_year": "2021",
# 	  "first_name": "Joe",
# 	  "last_name": "Shopper"
# 	}

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/vault/credit-card" $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
}

# a sample JSON response is shown below.
puts [CkJsonObject_emit $json]

# // The "id" is what will be used to create a payment with the stored credit card.
puts "card ID: [CkJsonObject_stringOf $json id]"
puts "success."

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

# 	{ 
# 	  "id": "CARD-52W84623JH8043102LA3CLGA",
# 	  "state": "ok",
# 	  "payer_id": "user12345",
# 	  "type": "visa",
# 	  "number": "xxxxxxxxxxxx9974",
# 	  "expire_month": "9",
# 	  "expire_year": "2021",
# 	  "first_name": "Joe",
# 	  "last_name": "Shopper",
# 	  "valid_until": "2019-11-23T00:00:00Z",
# 	  "create_time": "2016-11-23T23:26:16Z",
# 	  "update_time": "2016-11-23T23:26:16Z",
# 	  "links": [
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/vault/credit-card/CARD-52W84623JH8043102LA3CLGA",
# 	      "rel": "self",
# 	      "method": "GET"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/vault/credit-card/CARD-52W84623JH8043102LA3CLGA",
# 	      "rel": "delete",
# 	      "method": "DELETE"
# 	    },
# 	    { 
# 	      "href": "https://api.sandbox.paypal.com/v1/vault/credit-card/CARD-52W84623JH8043102LA3CLGA",
# 	      "rel": "patch",
# 	      "method": "PATCH"
# 	    }
# 	  ]
# 	

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