Lua Requires Chilkat v11.0.0+

PayPal - Find Captures

See more PayPal Examples

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.) Lua

local chilkat = require("chilkat")

-- 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)
local jsonToken = chilkat.JsonObject.new()
jsonToken:load_file("qa_data/tokens/paypal.json")

-- Build the Authorization request header field value.
local sbAuth = chilkat.StringBuilder.new()
-- token_type should be "Bearer"
sbAuth:append(jsonToken:string_of("token_type"))
sbAuth:append(" ")
sbAuth:append(jsonToken:string_of("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.
local rest = chilkat.Rest.new()
local bAutoReconnect = true
local success = rest:connect("api.sandbox.paypal.com", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- ----------------------------------------------------------------------------------------------
-- 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:clear_all_headers()
rest:clear_all_query_params()

rest:add_header("Authorization", sbAuth:get_as_string())

-- To find captured payments, we list payments and look for those
-- containing a "capture" resource.
rest:add_query_param("count", "100")
rest:add_query_param("start_index", "0")
rest:add_query_param("sort_by", "update_time")
rest:add_query_param("sort_order", "asc")

-- Send the GET request and get the JSON response.
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", "/v1/payments/payment", sbJsonResponse)
if not success then
    print(rest.last_error_text)
    return
end

local json = chilkat.JsonObject.new()
json.emit_compact = false
json:load_sb(sbJsonResponse)

-- (optional) Save the entire JSON response to a file to examine if desired..
local sbTemp = chilkat.StringBuilder.new()
json:emit_sb(sbTemp)
sbTemp:write_file("qa_output/paypal_payments.json", "utf-8", false)

print("Response Status Code = " .. rest.response_status_code)

-- Did we get a 200 success response?
if rest.response_status_code ~= 200 then
    print(json:emit())
    print("Failed.")
    return
end

-- 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
local jsonCapture = chilkat.JsonObject.new()
local numPayments = json:size_of_array("payments")
local i = 0
while i < numPayments do
    json.i = i
    local j = 0
    local numTransactions = json:size_of_array("payments[i].transactions")
    while j < numTransactions do
        json.j = j
        local numRelatedResources = json:size_of_array("payments[i].transactions[j].related_resources")
        local k = 0
        while k < numRelatedResources do
            json.k = k
            if json:has_member("payments[i].transactions[j].related_resources[k].capture") then
                json:object_of2("payments[i].transactions[j].related_resources[k].capture", jsonCapture)

                print("capture id: " .. jsonCapture:string_of("id"))
                print("state: " .. jsonCapture:string_of("state"))
                print("total: " .. jsonCapture:string_of("amount.total"))
                print("----")
            end

            k = k + 1
        end

        j = j + 1
    end

    i = i + 1
end

print("success")