2.0.2 • Published 2 years ago
manda-o-pix v2.0.2
Manda o Pix
Gerador de código Pix para scaneamento com qr code;
Qualquer preenchimento incorreto, os aplicativos dos bancos não conseguiram ler o qr code
Instalação:
Se este é um projeto totalmente novo, certifique-se de criar um package.json
primeiro com
o comando npm init
.
$ yarn add manda-o-pix
ou
$ npm i manda-o-pix
Parâmetros obrigatórios ex.
//Parâmetros obrigatórios
import { Pix } from "manda-o-pix";
const chavePix = '123e4567-e12b-12d1-a456-426655440000';
const nomeRecebedor = 'Higor Konig';
const cidadeRecebedor = 'Sao Paulo';
const codigo = new Pix(chavePix, nomeRecebedor, cidadeRecebedor);
codigo.generateCode();
00020126580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5911Higor Konig6009Sao Paulo62070503***6304BA66
Informações dos parâmetros obrigatórios
Nome | Tamanho max |
---|---|
chavePix | 36 |
nomeRecebedor | 13 |
cidadeRecebedor | 08 |
Parâmetros opcionais ex.
import { Pix } from "manda-o-pix";
const chavePix = '123e4567-e12b-12d1-a456-426655440000';
const nomeRecebedor = 'Higor Konig';
const cidadeRecebedor = 'Sao Paulo';
//Parâmetros opcionais
const valor = 75.80;
const descricao: 'produto 2'
const transacaoId: 'PAGAMENTO123ABC'
const codigo = new Pix(chavePix, nomeRecebedor, cidadeRecebedor, valor, descricao, transacaoId);
codigo.generateCode();
00020126700014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-4266554400000208produto2520400005303986540575.805802BR5911Higor Konig6009Sao Paulo62190515PAGAMENTO123ABC6304A82A
Informações dos parâmetros opcionais
Nome | Tamanho max |
---|---|
valor | 06 |
descricao | 18 |
transacaoId | 07 |
Métodos
generateCode() // Método retorna o código gerado para o QrCode
await generateQRCode() // Método assincrono retorna um QrCode em base64
Referências útilizadas:
documentação do pix
;
documentação pix bar
;