(Excel) 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.

Download Excel Class Modules Chilkat Excel Class Modules

' 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)
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

' Build the Authorization request header field value.
Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
' token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = sbAuth.Append(jsonToken.StringOf("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.
Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

bAutoReconnect = True

success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' ----------------------------------------------------------------------------------------------
' 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.
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False
success = json.UpdateString("payer_id","user12345")
success = json.UpdateString("type","visa")
success = json.UpdateString("number","4032031087659974")
success = json.UpdateString("expire_month","9")
success = json.UpdateString("expire_year","2021")
success = json.UpdateString("first_name","Joe")
success = json.UpdateString("last_name","Shopper")

Debug.Print json.Emit()

' 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"
' 	}

success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddHeader("Content-Type","application/json")

' Send the POST request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As Chilkat.StringBuilder
Set sbJsonRequest = Chilkat.NewStringBuilder
json.EmitCompact = True
success = json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As Chilkat.StringBuilder
Set sbJsonResponse = Chilkat.NewStringBuilder
success = rest.FullRequestSb("POST","/v1/vault/credit-card",sbJsonRequest,sbJsonResponse)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

Debug.Print "Response Status Code = "; rest.ResponseStatusCode

' Did we get a 201 success response?
If (rest.ResponseStatusCode <> 201) Then
    Debug.Print json.Emit()
    Debug.Print "Failed."
    Exit Sub
End If

' a sample JSON response is shown below.
Debug.Print json.Emit()

' // The "id" is what will be used to create a payment with the stored credit card.
Debug.Print "card ID: "; json.StringOf("id")
Debug.Print "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"
' 	    }
' 	  ]
'