(JavaScript) PayPal Generate QR Code

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

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

// Build the Authorization request header field value.
var sbAuth = new CkStringBuilder();
// 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.
var rest = new CkRest();
var bAutoReconnect = true;
success = rest.Connect("api.sandbox.paypal.com",443,true,bAutoReconnect);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

// ----------------------------------------------------------------------------------------------
// 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.
var sbPath = new CkStringBuilder();
sbPath.Append("/v1/invoicing/invoices/invoice_id/qr-code");
var 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="}
var sbJsonResponse = new CkStringBuilder();
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

var json = new CkJsonObject();
json.EmitCompact = false;
json.LoadSb(sbJsonResponse);

console.log("Response Status Code = " + rest.ResponseStatusCode);

// Did we get a 200 success response?
if (rest.ResponseStatusCode !== 200) {
    console.log(json.Emit());
    console.log("Failed.");
    return;
}

// If the 200 response is received, the response body contains the PNG data.
// Save the PNG to a file.
var pngData = new CkBinData();
pngData.AppendEncoded(json.StringOf("image"),"base64");
success = pngData.WriteFile("qa_output/paypal_qr_code.png");
if (success == false) {
    console.log("Failed to save PNG file.");
    return;
}

console.log("Success.");