Lua Requires Chilkat v9.5.0.65+

PayPal - Cancel Sent Invoice

See more PayPal Examples

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails. 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
json:update_string("subject", "Past due")
json:update_string("note", "Canceling invoice")
json:update_bool("send_to_merchant", true)
json:update_bool("send_to_payer", true)
print(json:emit())

-- The JSON created by the above code:

--     {
--       "subject": "Past due",
--       "note": "Canceling invoice",
--       "send_to_merchant": true,
--       "send_to_payer": true
--     }

-- Build a path using a previously-sent invoice ID.
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/invoicing/invoices/invoice_id/cancel")
local numReplacements = sbPath:replace("invoice_id", "INV2-XPWZ-NUTQ-LNWB-P8NC")

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)

-- In our testing, we received a 204 response, which is a success HTTP response code, but
-- differs from the PayPal REST API reference documentation, which states that a 202 response
-- is expected.  I suspect an error in the PayPal documentation, or in the PayPal responder.
-- Check for either 202 or 204..
-- Did we get a 202 accepted response?
if (rest.response_status_code ~= 202) and (rest.response_status_code ~= 204) then
    print(sbResponseBody:get_as_string())
    print("Failed.")
    return
end

-- The 202/204 response should be empty.  (Again, our experience differs from the online PayPal documentation..)
print("Success.")