Ruby

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

Ruby

require 'chilkat'

success = false

# Note: Requires Chilkat v9.5.0.64 or greater.

# 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)
jsonToken = Chilkat::CkJsonObject.new()
jsonToken.LoadFile("qa_data/tokens/paypal.json")

# Build the Authorization request header field value.
sbAuth = Chilkat::CkStringBuilder.new()
# token_type should be "Bearer"
sbAuth.Append(jsonToken.stringOf("token_type"))
sbAuth.Append(" ")
sbAuth.Append(jsonToken.stringOf("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.
rest = Chilkat::CkRest.new()
bAutoReconnect = true
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
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.
sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/v1/invoicing/invoices/invoice_id/qr-code")
numReplacements = sbPath.Replace("invoice_id","INV2-ZG2H-HKAW-PMWU-N6ZR")

rest.AddHeader("Authorization",sbAuth.getAsString())
# A 500x500 image results in a PNG file of approx. 4K bytes in size.
rest.AddQueryParam("width","500")
rest.AddQueryParam("height","500")
rest.AddQueryParam("action","pay")

# Send the GET request and get the PNG image data as base64.
# A successful JSON response looks like this:
# {"image":"iVBORw0KGgoAA....AASUVORK5CYII="}
sbJsonResponse = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET",sbPath.getAsString(),sbJsonResponse)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.LoadSb(sbJsonResponse)

print "Response Status Code = " + rest.get_ResponseStatusCode().to_s() + "\n";

# Did we get a 200 success response?
if (rest.get_ResponseStatusCode() != 200)
    print json.emit() + "\n";
    print "Failed." + "\n";
    exit
end

# If the 200 response is received, the response body contains the PNG data.
# Save the PNG to a file.
pngData = Chilkat::CkBinData.new()
pngData.AppendEncoded(json.stringOf("image"),"base64")
success = pngData.WriteFile("qa_output/paypal_qr_code.png")
if (success == false)
    print "Failed to save PNG file." + "\n";
    exit
end

print "Success." + "\n";