Lua Requires Chilkat v9.5.0.65+

PayPal - Create a PayPal Payment

See more PayPal Examples

Creates a payment to be paid from a PayPal account (as opposed to being funded by a credit card). 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 containing the transaction information.
local json = chilkat.JsonObject.new()
json.emit_compact = false
json:update_string("intent", "sale")
json:update_string("redirect_urls.return_url", "http://www.example.com/return_url")
json:update_string("redirect_urls.cancel_url", "http://www.example.com/cancel_url")
json:update_string("payer.payment_method", "paypal")
json:update_string("transactions[0].amount.total", "7.47")
json:update_string("transactions[0].amount.currency", "USD")
json:update_string("transactions[0].description", "This is the payment transaction description.")

print(json:emit())

-- The JSON created by the above code is this:

--     {
--       "intent": "sale",
--       "redirect_urls": {
--         "return_url": "http://www.example.com/return_url",
--         "cancel_url": "http://www.example.com/cancel_url"
--       },
--       "payer": {
--         "payment_method": "paypal"
--       },
--       "transactions": [
--         {
--           "amount": {
--             "total": "7.47",
--             "currency": "USD"
--           },
--           "description": "This is the payment transaction description."
--         }
--       ]
--     }

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

-- Send the POST request containign the JSON in the request body, and get the JSON response.
local sbJsonRequest = chilkat.StringBuilder.new()
json.emit_compact = true
json:emit_sb(sbJsonRequest)
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_sb("POST", "/v1/payments/payment", sbJsonRequest, sbJsonResponse)
if not success then
    print(rest.last_error_text)
    return
end

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

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

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

--     {
--       "id": "PAY-1XK50350XV338620BLA3CZGI",
--       "intent": "sale",
--       "state": "created",
--       "payer": {
--         "payment_method": "paypal",
--         "use_vendor_currency_conversion": false
--       },
--       "transactions": [
--         {
--           "amount": {
--             "total": "7.47",
--             "currency": "USD"
--           },
--           "description": "This is the payment transaction description.",
--           "related_resources": [
--           ]
--         }
--       ],
--       "create_time": "2016-11-23T23:56:09Z",
--       "links": [
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI",
--           "rel": "self",
--           "method": "GET"
--         },
--         {
--           "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0BG932459F977083J",
--           "rel": "approval_url",
--           "method": "REDIRECT"
--         },
--         {
--           "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI/execute",
--           "rel": "execute",
--           "method": "POST"
--         }
--       ]
--     }