(PowerBuilder) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
integer li_Success
oleobject loo_SbJsonResponse
oleobject loo_Json
oleobject loo_SbTemp
integer li_NumPayments
integer i
integer j
integer li_NumTransactions
integer li_NumRelatedResources
integer k
oleobject loo_JsonCapture

// 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)
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loo_SbAuth = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")

// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")

li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    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.
loo_Rest.ClearAllHeaders()
loo_Rest.ClearAllQueryParams()

loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())

// To find captured payments, we list payments and look for those
// containing a "capture" resource.
loo_Rest.AddQueryParam("count","100")
loo_Rest.AddQueryParam("start_index","0")
loo_Rest.AddQueryParam("sort_by","update_time")
loo_Rest.AddQueryParam("sort_order","asc")

// Send the GET request and get the JSON response.
loo_SbJsonResponse = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Rest.FullRequestNoBodySb("GET","/v1/payments/payment",loo_SbJsonResponse)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_SbJsonResponse
    return
end if

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.EmitCompact = 0
loo_Json.LoadSb(loo_SbJsonResponse)

// (optional) Save the entire JSON response to a file to examine if desired..
loo_SbTemp = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbTemp.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_SbTemp)
loo_SbTemp.WriteFile("qa_output/paypal_payments.json","utf-8",0)

Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)

// Did we get a 200 success response?
if loo_Rest.ResponseStatusCode <> 200 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_SbJsonResponse
    destroy loo_Json
    destroy loo_SbTemp
    return
end if

// We are looking for "capture" resources .
// As shown below, we are looking in the "transactions" for "related_resources"
// containing "capture" JSON objects. 

// 	{ 
// 	  "payments": [
// 	    { 
// 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
// 	      "create_time": "2016-11-24T00:33:51Z",
// 	      "update_time": "2016-11-24T00:40:54Z",
// 	      "state": "approved",
// 	      "intent": "authorize",
// 	      "payer": { 
// 	        "payment_method": "credit_card",
// 	        "funding_instruments": [
// 	          { 
// 	            ...
// 	          }
// 	        ]
// 	      },
// 	      "transactions": [
// 	        { 
// 	          "amount": { 
// 	            ...
// 	          },
// 	          "description": "This is the payment transaction description.",
// 	          "related_resources": [
// 	            { 
// 	              "authorization": { 
// 	                ...
// 	              }
// 	            },
// 	            { 
// 	              "capture": { 
// 	                "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"
// 	                },
// 			...
// 

// Iterate over the payments and show each capture
li_NumPayments = loo_Json.SizeOfArray("payments")
i = 0
do while i < li_NumPayments
    loo_Json.I = i
    j = 0
    li_NumTransactions = loo_Json.SizeOfArray("payments[i].transactions")
    do while j < li_NumTransactions
        loo_Json.J = j
        li_NumRelatedResources = loo_Json.SizeOfArray("payments[i].transactions[j].related_resources")
        k = 0
        do while k < li_NumRelatedResources
            loo_Json.K = k
            if loo_Json.HasMember("payments[i].transactions[j].related_resources[k].capture") = 1 then
                loo_JsonCapture = loo_Json.ObjectOf("payments[i].transactions[j].related_resources[k].capture")
                Write-Debug "capture id: " + loo_JsonCapture.StringOf("id")
                Write-Debug "state: " + loo_JsonCapture.StringOf("state")
                Write-Debug "total: " + loo_JsonCapture.StringOf("amount.total")
                Write-Debug "----"
                destroy loo_JsonCapture
            end if

            k = k + 1
        loop
        j = j + 1
    loop
    i = i + 1
loop

Write-Debug "success"


destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_SbJsonResponse
destroy loo_Json
destroy loo_SbTemp