Lua Requires Chilkat v9.5.0.65+
Lua
PayPal - Execute Approved PayPal Payment
See more PayPal Examples
Executes an approved PayPal payment. (This is for executing an approved PayPal payment, not a credit card payment.)Chilkat Lua Downloads
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 payer_id
local json = chilkat.JsonObject.new()
json.emit_compact = false
json:append_string("payer_id", "RRCYJUTFJGZTA")
print(json:emit())
-- The JSON created by the above code:
-- {
-- "payer_id": "RRCYJUTFJGZTA"
-- }
rest:add_header("Authorization", sbAuth:get_as_string())
rest:add_header("Content-Type", "application/json")
-- The payment ID is passed in the path.
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/payments/payment/payment_id/execute")
local numReplaced = sbPath:replace("payment_id", "PAY-4N746561P0587231SKQQK6MY")
-- 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", sbPath:get_as_string(), 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 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("success")
-- ------------------------------------------------
-- A sample JSON response:
-- {
-- "id": "PAY-4N746561P0587231SKQQK6MY",
-- "create_time": "2014-09-22T23:22:27Z",
-- "update_time": "2014-09-22T23:31:13Z",
-- "state": "approved",
-- "intent": "sale",
-- "payer": {
-- "payment_method": "paypal",
-- "payer_info": {
-- "email": "npurayil-uspr-60@paypal.com",
-- "first_name": "Brian",
-- "last_name": "Robinson",
-- "payer_id": "JMKDKJ4D7DG7G",
-- "shipping_address": {
-- "line1": "4thFloor",
-- "line2": "unit#34",
-- "city": "SAn Jose",
-- "state": "CA",
-- "postal_code": "95131",
-- "country_code": "US",
-- "phone": "011862212345678",
-- "recipient_name": "HelloWorld"
-- }
-- }
-- },
-- "transactions": [
-- {
-- "amount": {
-- "total": "30.11",
-- "currency": "USD",
-- "details": {
-- "subtotal": "30.00",
-- "tax": "0.07",
-- "shipping": "0.03",
-- "handling_fee": "1.00",
-- "insurance": "0.01",
-- "shipping_discount": "-1.00"
-- }
-- },
-- "description": "This is the payment transaction description.",
-- "item_list": {
-- "items": [
-- {
-- "name": "hat",
-- "sku": "1",
-- "price": "3.00",
-- "currency": "USD",
-- "quantity": "5",
-- "description": "Brown color hat",
-- "tax": "0.01"
-- },
-- {
-- "name": "handbag",
-- "sku": "product34",
-- "price": "15.00",
-- "currency": "USD",
-- "quantity": "1",
-- "description": "Black color handbag",
-- "tax": "0.02"
-- }
-- ],
-- "shipping_address": {
-- "recipient_name": "HelloWorld",
-- "line1": "4thFloor",
-- "line2": "unit#34",
-- "city": "SAn Jose",
-- "state": "CA",
-- "phone": "011862212345678",
-- "postal_code": "95131",
-- "country_code": "US"
-- }
-- },
-- "related_resources": [
-- {
-- "sale": {
-- "id": "4XP56210M0797192Y",
-- "create_time": "2014-09-22T23:22:27Z",
-- "update_time": "2014-09-22T23:31:13Z",
-- "amount": {
-- "total": "30.11",
-- "currency": "USD"
-- },
-- "payment_mode": "INSTANT_TRANSFER",
-- "state": "completed",
-- "protection_eligibility": "ELIGIBLE",
-- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
-- "transaction_fee": {
-- "value": "1.75",
-- "currency": "USD"
-- },
-- "parent_payment": "PAY-4N746561P0587231SKQQK6MY",
-- "links": [
-- {
-- "href": "https://api.paypal.com/v1/payments/sale/4XP56210M0797192Y",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.paypal.com/v1/payments/sale/4XP56210M0797192Y/refund",
-- "rel": "refund",
-- "method": "POST"
-- },
-- {
-- "href": "https://api.paypal.com/v1/payments/payment/PAY-4N746561P0587231SKQQK6MY",
-- "rel": "parent_payment",
-- "method": "GET"
-- }
-- ]
-- }
-- }
-- ]
-- }
-- ],
-- "links": [
-- {
-- "href": "https://api.paypal.com/v1/payments/payment/PAY-4N746561P0587231SKQQK6MY",
-- "rel": "self",
-- "method": "GET"
-- }
-- ]
-- }