Pixjs NPM | npm.io

PixJS

Tool to generate “Copy and Paste” Pix payloads.

🔨 Installation

npm i pixjs
yarn add pixjs

💻 How to use

Copy and Paste Method

const { CopyAndPaste } = require("pixjs");

const copyAndPaste = CopyAndPaste({
  name: "Tiago Dias Laureano", // Receptor name
  key: "e015b7ed-b6bd-4c5a-bcb3-28f67559d716", // The pix key: email, phone, cpf, cnpj or randomkey
  amount: 1.0, // Amount
  city: "Rio De Janeiro", // The city name
  id: "PAGAMENTO", // Payment identifier
});

console.log(copyAndPaste);

/* RESULT
{
  message: 'Your Copy and Paste has been generated',
  payload: '00020126580014BR.GOV.BCB.PIX0136e015b7ed-b6bd-4c5a-bcb3-28f67559d71652040000530398654041.005802BR5919Tiago Dias Laureano6014Rio De Janeiro62130509PAGAMENTO63042F1D',
  data: {
    name: 'Tiago Dias Laureano',
    key: 'e015b7ed-b6bd-4c5a-bcb3-28f67559d716',
    amount: 1,
    city: 'Rio De Janeiro',
    id: 'PAGAMENTO'
  }
}
*/

Generate QRCode Image Method

const { QrCodeImage } = require("pixjs");

const copyAndPaste = QrCodeImage({
  name: "Tiago Dias Laureano", // Receptor name
  key: "e015b7ed-b6bd-4c5a-bcb3-28f67559d716", // The pix key: email, phone, cpf, cnpj or randomkey
  amount: 1.0, // Amount
  city: "Rio De Janeiro", // The city name
  id: "PAGAMENTO", // Payment identifier
  path: "src/qr-images/", // path to save images
});

/*RESULT
{
  message: 'Your QRCode Image has been generated',
  payload: '00020126580014BR.GOV.BCB.PIX0136e015b7ed-b6bd-4c5a-bcb3-28f67559d71652040000530398654041.005802BR5919Tiago Dias Laureano6014Rio De Janeiro62130509PAGAMENTO63042F1D',
  path: 'src/qr-images/e015b7ed-b6bd-4c5a-bcb3-28f67559d716.png',
  image: 'e015b7ed-b6bd-4c5a-bcb3-28f67559d716.png',
  data: {
    name: 'Tiago Dias Laureano',
    key: 'e015b7ed-b6bd-4c5a-bcb3-28f67559d716',
    amount: 1,
    city: 'Rio De Janeiro',
    id: 'PAGAMENTO'
  }
}
*/

Generate QRCode image in Terminal

const { QrCodeTerminal } = require("pixjs");

const copyAndPaste = QrCodeTerminal({
  name: "Tiago Dias Laureano", // Receptor name
  key: "e015b7ed-b6bd-4c5a-bcb3-28f67559d716", // The pix key: email, phone, cpf, cnpj or randomkey
  amount: 1.0, // Amount
  city: "Rio De Janeiro", // The city name
  id: "PAGAMENTO", // Payment identifier
});

console.log(copyAndPaste);

// Result: Show qrcode in terminal.