Sample code for 30+ languages & platforms
B4X

PayPal - Get Capture Details

See more PayPal Examples

Shows details for a captured payment, by capture ID.

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

Chilkat B4X Downloads

B4X
Dim success As Boolean = False

'  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 ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/paypal.json")

'  Build the Authorization request header field value.
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
'  token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"))
sbAuth.Append(" ")
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 ChilkatRest
rest.Initialize("rest")
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com", 443, True, bAutoReconnect)
If success <> True Then
    Log(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..
'  ----------------------------------------------------------------------------------------------

'  Clear the REST object of any headers or query params from previous requests.
rest.ClearAllHeaders
rest.ClearAllQueryParams

'  This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
rest.AddHeader("Authorization", sbAuth.GetAsString)

'  The capture ID is added to the path.
'  To list your captures: Find Captures. 
Dim sbPath As ChilkatStringBuilder
sbPath.Initialize
sbPath.Append("/v1/payments/capture/capture_id")
Dim numReplaced As Int = sbPath.Replace("capture_id", "1LY5310469661362J")

'  Send the GET request and get the JSON response.
Dim sbJsonResponse As ChilkatStringBuilder
sbJsonResponse.Initialize
success = rest.FullRequestNoBodySb("GET", sbPath.GetAsString, sbJsonResponse)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


Dim json As ChilkatJsonObject
json.Initialize
json.EmitCompact = False
json.LoadSb(sbJsonResponse)

Log("Response Status Code = " & rest.ResponseStatusCode)

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


'  Sample JSON response is shown below.
Log(json.Emit)
Log("----------------------")

Log("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"
'  	  },
'  	  "state": "completed",
'  	  "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/payment/PAY-2CY489250W145633HLA3DK3Y",
'  	      "rel": "parent_payment",
'  	      "method": "GET"
'  	    }
'  	  ]
'  	}