Lua Requires Chilkat v9.5.0.65+

PayPal - Refund Sale

See more PayPal Examples

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an 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..
-- ----------------------------------------------------------------------------------------------

-- To refund a particular amount, build JSON such as this:
local jsonPartial = chilkat.JsonObject.new()
jsonPartial.emit_compact = false
jsonPartial:update_string("amount.total", "2.34")
jsonPartial:update_string("amount.currency", "USD")
-- invoice_number is optional..
jsonPartial:update_string("invoice_number", "INV-1234567")
print(jsonPartial:emit())

-- The JSON for a partial refund:

--     {
--       "amount": {
--         "total": "2.34",
--         "currency": "USD"
--       },
--       "invoice_number": "INV-1234567"
--     }

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

-- 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/refund")
local numReplaced = sbPath:replace("sale_id", "1XC17935MN507400J")

-- Send the POST request containign the JSON in the request body, and get the JSON response.
local sbJsonRequest = chilkat.StringBuilder.new()
jsonPartial.emit_compact = true
jsonPartial:emit_sb(sbJsonRequest)
local sbJsonResponse = chilkat.StringBuilder.new()

local bFullRefund = true
-- To send a full refund, send an empty request body:
if bFullRefund then
    sbJsonRequest:clear()
    sbJsonRequest:append("{}")
end

success = rest:full_request_sb("POST", sbPath:get_as_string(), sbJsonRequest, 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 201 success response?
if rest.response_status_code ~= 201 then
    print(json:emit())
    print("Failed.")
    return
end

print(json:emit())
print("Success.")

-- A successful JSON response:
-- The "id" is the refund_id.

--     {
--       "id": "7NE550583A133505U",
--       "create_time": "2016-11-26T16:38:27Z",
--       "update_time": "2016-11-26T16:38:27Z",
--       "state": "completed",
--       "amount": {
--         "total": "289.00",
--         "currency": "USD"
--       },
--       "sale_id": "1XC17935MN507400J",
--       "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
--       "links": [
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
--           "rel": "self",
--           "method": "GET"
--         },
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
--           "rel": "parent_payment",
--           "method": "GET"
--         },
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
--           "rel": "sale",
--           "method": "GET"
--         }
--       ]
--     }