(Excel) PayPal - Capture a Previously Authorized Payment

Captures a previously authorized payment.

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("amount.currency","USD")
success = json.UpdateString("amount.total","4.54")
success = json.UpdateBool("is_final_capture",True)
Debug.Print json.Emit()

' The JSON created by the above code:

' 	{ 
' 	  "amount": { 
' 	    "currency": "USD",
' 	    "total": "4.54"
' 	  },
' 	  "is_final_capture": true
' 	}

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

' To capture payment, make a call to /v1/payments/authorization/[authorization_id]/capture with the authorization ID in the URI.
' See PayPal Authorize Payment for sample code to create the authorization.
' The "7X8332687A4929542" comes from the "transactions[0].related_resources[0].authorization.id" part of the authorization response.

Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/v1/payments/authorization/[authorization_id]/capture")

numReplacements = sbPath.Replace("[authorization_id]","7X8332687A4929542")

' 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",sbPath.GetAsString(),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

' IMPORTANT: In most PayPal examples, the return status code is 201.
' For this particular call, PayPal returns status code 200.

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

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

Debug.Print "success"

' ------------------------------------------------
' A sample JSON response:

' 	{ 
' 	  "id": "1LY5310469661362J",
' 	  "create_time": "2016-11-24T00:40:50Z",
' 	  "update_time": "2016-11-24T00:40:54Z",
' 	  "amount": { 
' 	    "total": "4.54",
' 	    "currency": "USD"
' 	  },
' 	  "is_final_capture": true,
' 	  "state": "completed",
' 	  "reasonCode": "None",
' 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
' 	  "transaction_fee": { 
' 	    "value": "0.43",
' 	    "currency": "USD"
' 	  },
' 	  "links": [
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
' 	      "rel": "self",
' 	      "method": "GET"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
' 	      "rel": "refund",
' 	      "method": "POST"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
' 	      "rel": "authorization",
' 	      "method": "GET"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
' 	      "rel": "parent_payment",
' 	      "method": "GET"
' 	    }
' 	  ]
'