(Xojo Plugin) PayPal - Capture Authorization

Capture and process a previously created authorization. The original payment call must have the intent set to authorize.

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// Note: Requires Chilkat v9.5.0.64 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 New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// 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 New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
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..
// ----------------------------------------------------------------------------------------------

// To capture a particular amount, build JSON such as this:
Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.UpdateString("amount.currency","USD")
success = json.UpdateString("amount.total","6.70")
// is_final_capture is optional and indicates whether to release all remaining funds that the authorization holds in the funding instrument.
success = json.UpdateBool("is_final_capture",True)
System.DebugLog(json.Emit())

// The JSON created by the above code:

// 	{ 
// 	  "amount": { 
// 	    "currency": "USD",
// 	    "total": "6.70"
// 	  },
// 	  "is_final_capture": true
// 	}

// This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
success = rest.AddHeader("Authorization",sbAuth.GetAsString())
success = rest.AddHeader("Content-Type","application/json")

// The authorization ID is added to the path.
// The authorization ID is obtained from payment records as shown here: Find Authorizations
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/payments/authorization/authorization_id/capture")
Dim numReplaced As Int32
numReplaced = sbPath.Replace("authorization_id","6HG91590AX913463C")

// Send the POST request containing the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As New Chilkat.StringBuilder
json.EmitCompact = True
success = json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As New Chilkat.StringBuilder

success = rest.FullRequestSb("POST",sbPath.GetAsString(),sbJsonRequest,sbJsonResponse)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))

// Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

System.DebugLog(json.Emit())
System.DebugLog("Success.")

// A successful JSON response:

// 	{ 
// 	  "id": "87S70321AE222860G",
// 	  "create_time": "2016-11-26T17:27:46Z",
// 	  "update_time": "2016-11-26T17:27:50Z",
// 	  "amount": { 
// 	    "total": "6.70",
// 	    "currency": "USD"
// 	  },
// 	  "is_final_capture": true,
// 	  "state": "completed",
// 	  "reasonCode": "None",
// 	  "parent_payment": "PAY-3SL8976592063093RLA3DMAY",
// 	  "transaction_fee": { 
// 	    "value": "0.49",
// 	    "currency": "USD"
// 	  },
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/87S70321AE222860G",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/87S70321AE222860G/refund",
// 	      "rel": "refund",
// 	      "method": "POST"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/6HG91590AX913463C",
// 	      "rel": "authorization",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-3SL8976592063093RLA3DMAY",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}
//