Lua Requires Chilkat v9.5.0.64+

PayPal Generate QR Code

See more PayPal Examples

Generates a QR code for an invoice, by ID.

The QR code is a PNG image in Base64-encoded format that corresponds to the invoice ID.

Note: A QR code can only be generated for an invoice that has been both created and sent.

See also Generate QR Code

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 a path using an invoice ID.
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/v1/invoicing/invoices/invoice_id/qr-code")
local numReplacements = sbPath:replace("invoice_id", "INV2-ZG2H-HKAW-PMWU-N6ZR")

rest:add_header("Authorization", sbAuth:get_as_string())
-- A 500x500 image results in a PNG file of approx. 4K bytes in size.
rest:add_query_param("width", "500")
rest:add_query_param("height", "500")
rest:add_query_param("action", "pay")

-- Send the GET request and get the PNG image data as base64.
-- A successful JSON response looks like this:
-- {"image":"iVBORw0KGgoAA....AASUVORK5CYII="}
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

-- If the 200 response is received, the response body contains the PNG data.
-- Save the PNG to a file.
local pngData = chilkat.BinData.new()
pngData:append_encoded(json:string_of("image"), "base64")
success = pngData:write_file("qa_output/paypal_qr_code.png")
if not success then
    print("Failed to save PNG file.")
    return
end

print("Success.")