Lua Requires Chilkat v11.0.0+
Lua
PayPal - Show Payment Details
See more PayPal Examples
Shows details for a payment by ID.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..
-- ----------------------------------------------------------------------------------------------
-- Clear the REST object of any headers or query params from previous requests.
rest:clear_all_headers()
rest:clear_all_query_params()
rest:add_header("Authorization", sbAuth:get_as_string())
-- The payment ID is added to the path.
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/payments/payment/payment_id")
local numReplaced = sbPath:replace("payment_id", "PAY-62106714J93631829LA44NWI")
-- Send the GET request and get the JSON response.
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", sbPath:get_as_string(), 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 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("----------------------")
-- Show how to get a timestamp, such as update_time.
local dateTime = chilkat.DateTime.new()
success = dateTime:set_from_timestamp(json:string_of("update_time"))
print("utc update_time: " .. dateTime:get_as_timestamp(false))
print("local update_time: " .. dateTime:get_as_timestamp(true))
print("utc rfc822: " .. dateTime:get_as_rfc822(false))
print("local rfc822: " .. dateTime:get_as_rfc822(true))
local dtUtc = chilkat.DtObj.new()
dateTime:to_dt_obj(false, dtUtc)
print(dtUtc.month .. "/" .. dtUtc.day .. "/" .. dtUtc.year)
print("success")
-- ------------------------------------------------
-- A sample JSON response:
-- {
-- "id": "PAY-2CY489250W145633HLA3DK3Y",
-- "create_time": "2016-11-24T00:33:51Z",
-- "update_time": "2016-11-24T00:40:54Z",
-- "state": "approved",
-- "intent": "authorize",
-- "payer": {
-- "payment_method": "credit_card",
-- "funding_instruments": [
-- {
-- "credit_card_token": {
-- "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
-- "payer_id": "user12345",
-- "last4": "9974",
-- "type": "visa",
-- "expire_month": "9",
-- "expire_year": "2021"
-- }
-- }
-- ]
-- },
-- "transactions": [
-- {
-- "amount": {
-- "total": "6.70",
-- "currency": "USD",
-- "details": {
-- "subtotal": "6.70"
-- }
-- },
-- "description": "This is the payment transaction description.",
-- "related_resources": [
-- {
-- "authorization": {
-- "id": "7X8332687A4929542",
-- "create_time": "2016-11-24T00:33:51Z",
-- "update_time": "2016-11-24T00:33:58Z",
-- "amount": {
-- "total": "6.70",
-- "currency": "USD",
-- "details": {
-- "subtotal": "6.70"
-- }
-- },
-- "state": "captured",
-- "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
-- "valid_until": "2016-12-23T00:33:51Z",
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
-- "rel": "parent_payment",
-- "method": "GET"
-- }
-- ]
-- }
-- },
-- {
-- "capture": {
-- "id": "1LY5310469661362J",
-- "create_time": "2016-11-24T00:40:50Z",
-- "update_time": "2016-11-24T00:40:54Z",
-- "amount": {
-- "total": "4.54",
-- "currency": "USD"
-- },
-- "state": "completed",
-- "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
-- "transaction_fee": {
-- "value": "0.43",
-- "currency": "USD"
-- },
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
-- "rel": "refund",
-- "method": "POST"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
-- "rel": "parent_payment",
-- "method": "GET"
-- }
-- ]
-- }
-- }
-- ]
-- }
-- ],
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
-- "rel": "self",
-- "method": "GET"
-- }
-- ]
-- }