(Excel) PayPal - Authorize a Payment

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.

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 transaction information.
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False
success = json.UpdateString("intent","authorize")
success = json.UpdateString("payer.payment_method","credit_card")
success = json.UpdateString("payer.funding_instruments[0].credit_card_token.credit_card_id","CARD-52W84623JH8043102LA3CLGA")
success = json.UpdateString("payer.funding_instruments[0].credit_card_token.payer_id","user12345")
success = json.UpdateString("transactions[0].amount.total","6.70")
success = json.UpdateString("transactions[0].amount.currency","USD")
success = json.UpdateString("transactions[0].description","This is the payment transaction description.")

Debug.Print json.Emit()

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

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/payments/payment",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

' Sample JSON response is shown below.
Debug.Print json.Emit()
' The authorization ID found in the related_resources is used to capture the payment at a later time.
Debug.Print "authorization id: "; json.StringOf("transactions[0].related_resources[0].authorization.id")
Debug.Print "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"
' 	    }
' 	  ]
' 	}