Lua Requires Chilkat v9.5.0.65+

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded. 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..
-- ----------------------------------------------------------------------------------------------

-- Build the JSON request body containing the reminder information:
local json = chilkat.JsonObject.new()
json.emit_compact = false
local dtNow = chilkat.DateTime.new()
dtNow:set_from_current_system_time()
local sbDt = chilkat.StringBuilder.new()
sbDt:append(dtNow:get_as_timestamp(false))
local numReplaced = sbDt:replace("T", " ")
numReplaced = sbDt:replace("Z", " UTC")
json:update_string("date", sbDt:get_as_string())
json:update_string("note", "Refunded by credit card!")
json:update_string("amount.currency", "USD")
json:update_string("amount.value", "500.00")
print(json:emit())

-- The JSON created by the above code:

--     {
--       "date": "2016-11-28 21:05:38 UTC",
--       "note": "Refunded by credit card!",
--       "amount": {
--         "currency": "USD",
--         "value": "500.00"
--       }
--     }

-- Build a path using a previously-sent invoice ID.
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/invoicing/invoices/invoice_id/record-refund")
local numReplacements = sbPath:replace("invoice_id", "INV2-QCHR-QHSD-M2VU-AVXC")

json.emit_compact = true
local sbRequestBody = chilkat.StringBuilder.new()
local sbResponseBody = chilkat.StringBuilder.new()

rest:add_header("Content-Type", "application/json")
rest:add_header("Authorization", sbAuth:get_as_string())
json:emit_sb(sbRequestBody)

success = rest:full_request_sb("POST", sbPath:get_as_string(), sbRequestBody, sbResponseBody)
if not success then
    print(rest.last_error_text)
    return
end

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

-- Check for a success response.
if rest.response_status_code ~= 204 then
    print(sbResponseBody:get_as_string())
    print("Failed.")
    return
end

-- For a success response, the response body is empty.
print("Success.")