Lua Requires Chilkat v11.0.0+

PayPal - Find Completed Sales

See more PayPal Examples

List payments and find completed payments (sales transactions). Get the sales id, state, and total amount for each. 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 sales transactions, we list payments and look for those
-- containing "sale" transactions
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 sales transactions .
-- As shown below, we are looking in the "transactions" for "related_resources"
-- containing "sale" JSON objects.

--     {
--       "payments": [
--         {
--           "id": "PAY-66A12106PU3254228LA3BYKI",
--           "create_time": "2016-11-23T22:46:01Z",
--           "update_time": "2016-11-23T22:46:07Z",
--           "state": "approved",
--           "intent": "sale",
--           "payer": {
--               ...
--               }
--             ]
--           },
--           "transactions": [
--             {
--               ...
--               "related_resources": [
--                 {
--                   "sale": {
--                     "id": "70L88278E6781074B",
--                     "create_time": "2016-11-23T22:46:01Z",
--                     "update_time": "2016-11-23T22:46:07Z",
--                     "amount": {
--                       "total": "7.47",
--                       "currency": "USD"
--                     },
--                     "state": "completed",
--                     "parent_payment": "PAY-66A12106PU3254228LA3BYKI",

-- Iterate over the payments and show each sale transaction.
local jsonSale = 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].sale") then
                json:object_of2("payments[i].transactions[j].related_resources[k].sale", jsonSale)

                print("sale id: " .. jsonSale:string_of("id"))
                print("state: " .. jsonSale:string_of("state"))
                print("total: " .. jsonSale:string_of("amount.total"))
                print("----")
            end

            k = k + 1
        end

        j = j + 1
    end

    i = i + 1
end

print("success")