Lua Requires Chilkat v11.0.0+

PayPal - Get Sale Details

See more PayPal Examples

Shows details for a sale transaction, by ID. 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())

-- The sale ID is added to the path.
-- The sale ID is obtained from payment records as shown here: Find Completed Sales
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/payments/sale/sale_id")
local numReplaced = sbPath:replace("sale_id", "1XC17935MN507400J")

-- Send the GET request and get the JSON response.
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", sbPath:get_as_string(), 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)

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

-- Sample JSON response is shown below.
print(json:emit())
print("----------------------")

-- Show how to get a timestamp, such as update_time.
local dateTime = chilkat.DateTime.new()
success = dateTime:set_from_timestamp(json:string_of("update_time"))
print("utc update_time: " .. dateTime:get_as_timestamp(false))
print("local update_time: " .. dateTime:get_as_timestamp(true))
print("utc rfc822: " .. dateTime:get_as_rfc822(false))
print("local rfc822: " .. dateTime:get_as_rfc822(true))

local dtUtc = chilkat.DtObj.new()
dateTime:to_dt_obj(false, dtUtc)

print(dtUtc.month .. "/" .. dtUtc.day .. "/" .. dtUtc.year)

print("success")

-- ------------------------------------------------
-- A sample JSON response:

--     {
--       "id": "1XC17935MN507400J",
--       "create_time": "2016-11-25T15:42:50Z",
--       "update_time": "2016-11-25T15:42:56Z",
--       "amount": {
--         "total": "289.00",
--         "currency": "USD"
--       },
--       "payment_mode": "INSTANT_TRANSFER",
--       "state": "completed",
--       "protection_eligibility": "ELIGIBLE",
--       "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
--       "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
--       "transaction_fee": {
--         "value": "8.68",
--         "currency": "USD"
--       },
--       "links": [
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
--           "rel": "self",
--           "method": "GET"
--         },
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
--           "rel": "refund",
--           "method": "POST"
--         },
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
--           "rel": "parent_payment",
--           "method": "GET"
--         }
--       ]
--     }