Lua Requires Chilkat v9.5.0.65+
Lua
PayPal - List Payments
See more PayPal Examples
Lists payments that were created by the create payment call and are in any state. The list shows the payments that are made to the merchant who makes the call.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())
-- Add query parameters.
rest:add_query_param("count", "3")
rest:add_query_param("start_index", "0")
rest:add_query_param("sort_by", "create_time")
rest:add_query_param("sort_order", "desc")
-- Send the GET request and get the JSON response.
local sbJsonResponse = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("GET", "/v1/payments/payment", 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("----------------------")
-- Iterate over the payments and show some information from each..
local numPayments = json:size_of_array("payments")
local i = 0
while i < numPayments do
json.i = i
print("id: " .. json:string_of("payments[i].id"))
print("state: " .. json:string_of("payments[i].state"))
print("intent: " .. json:string_of("payments[i].intent"))
local j = 0
local numTransactions = json:size_of_array("payments[i].transactions")
while j < numTransactions do
json.j = j
print("amount: " .. json:string_of("payments[i].transactions[j].amount.total"))
print("description: " .. json:string_of("payments[i].transactions[j].description"))
j = j + 1
end
print("----")
i = i + 1
end
print("success")
-- ------------------------------------------------
-- A sample JSON response:
-- {
-- "payments": [
-- {
-- "id": "PAY-66A12106PU3254228LA3BYKI",
-- "create_time": "2016-11-23T22:46:01Z",
-- "update_time": "2016-11-23T22:46:07Z",
-- "state": "approved",
-- "intent": "sale",
-- "payer": {
-- "payment_method": "credit_card",
-- "funding_instruments": [
-- {
-- "credit_card": {
-- "type": "visa",
-- "number": "xxxxxxxxxxxx9974",
-- "expire_month": "9",
-- "expire_year": "2021",
-- "first_name": "Joe",
-- "last_name": "Buyer"
-- }
-- }
-- ]
-- },
-- "transactions": [
-- {
-- "amount": {
-- "total": "7.47",
-- "currency": "USD",
-- "details": {
-- "subtotal": "7.47"
-- }
-- },
-- "description": "This is the payment transaction description.",
-- "related_resources": [
-- {
-- "sale": {
-- "id": "70L88278E6781074B",
-- "create_time": "2016-11-23T22:46:01Z",
-- "update_time": "2016-11-23T22:46:07Z",
-- "amount": {
-- "total": "7.47",
-- "currency": "USD"
-- },
-- "state": "completed",
-- "parent_payment": "PAY-66A12106PU3254228LA3BYKI",
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B/refund",
-- "rel": "refund",
-- "method": "POST"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
-- "rel": "parent_payment",
-- "method": "GET"
-- }
-- ]
-- }
-- }
-- ]
-- }
-- ],
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
-- "rel": "self",
-- "method": "GET"
-- }
-- ]
-- },
-- {
-- "id": "PAY-65M1278399433341ALA3B4JY",
-- "create_time": "2016-11-23T22:54:31Z",
-- "update_time": "2016-11-23T22:54:35Z",
-- "state": "approved",
-- "intent": "sale",
-- "payer": {
-- "payment_method": "credit_card",
-- "funding_instruments": [
-- {
-- "credit_card": {
-- "type": "visa",
-- "number": "xxxxxxxxxxxx9974",
-- "expire_month": "9",
-- "expire_year": "2021",
-- "first_name": "Joe",
-- "last_name": "Buyer"
-- }
-- }
-- ]
-- },
-- "transactions": [
-- {
-- "amount": {
-- "total": "7.47",
-- "currency": "USD",
-- "details": {
-- "subtotal": "7.47"
-- }
-- },
-- "description": "This is the payment transaction description.",
-- "related_resources": [
-- {
-- "sale": {
-- "id": "1CP21441CY030683B",
-- "create_time": "2016-11-23T22:54:31Z",
-- "update_time": "2016-11-23T22:54:35Z",
-- "amount": {
-- "total": "7.47",
-- "currency": "USD"
-- },
-- "state": "completed",
-- "parent_payment": "PAY-65M1278399433341ALA3B4JY",
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B/refund",
-- "rel": "refund",
-- "method": "POST"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
-- "rel": "parent_payment",
-- "method": "GET"
-- }
-- ]
-- }
-- }
-- ]
-- }
-- ],
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
-- "rel": "self",
-- "method": "GET"
-- }
-- ]
-- },
-- {
-- "id": "PAY-12T35751GS725073SLA3CQNQ",
-- "create_time": "2016-11-23T23:37:26Z",
-- "update_time": "2016-11-23T23:37:31Z",
-- "state": "approved",
-- "intent": "sale",
-- "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": [
-- {
-- "sale": {
-- "id": "4F194018A1618453G",
-- "create_time": "2016-11-23T23:37:26Z",
-- "update_time": "2016-11-23T23:37:31Z",
-- "amount": {
-- "total": "6.70",
-- "currency": "USD"
-- },
-- "state": "completed",
-- "parent_payment": "PAY-12T35751GS725073SLA3CQNQ",
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G",
-- "rel": "self",
-- "method": "GET"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G/refund",
-- "rel": "refund",
-- "method": "POST"
-- },
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
-- "rel": "parent_payment",
-- "method": "GET"
-- }
-- ]
-- }
-- }
-- ]
-- }
-- ],
-- "links": [
-- {
-- "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
-- "rel": "self",
-- "method": "GET"
-- }
-- ]
-- }
-- ],
-- "count": 3,
-- "next_id": "PAY-2005552565085590VLA3CR5Q"
-- }