GILVIEIRADEV

Conheça o PixBrasil

pixbrasil disponível na npm

Estou muito empolgado para compartilhar o mais recente projeto que desenvolvi: um pacote NPM incrível feito em TypeScript, com um tamanho surpreendente de apenas 7KB! 📦✨

https://github.com/ogilvieira/pixbrasil

Este pacote permite gerar códigos de PIX de forma eficiente e flexível, oferecendo a liberdade de usar qualquer plugin desejado para a geração do QR Code. Com a crescente popularidade do PIX como meio de pagamento no Brasil, era fundamental criar uma ferramenta que proporcionasse uma maneira ágil e otimizada de gerar esses códigos.

O uso de TypeScript foi fundamental para garantir a tipagem precisa e fornecer uma experiência de desenvolvimento mais segura e produtiva. Além disso, a atenção aos detalhes e otimizações permitiram que o pacote fosse compacto, mantendo-o leve e eficiente.

Fico muito feliz em contribuir para a comunidade de desenvolvedores, e espero que este pacote seja útil para todos que precisam gerar códigos de PIX de forma simples e rápida. O código está disponível no GitHub e aguardo feedbacks valiosos para continuarmos melhorando e expandindo as funcionalidades.

Se você está interessado em conhecer mais sobre este projeto ou colaborar de alguma forma, fique à vontade para entrar em contato. Estamos sempre abertos a colaborações e melhorias para tornar este pacote ainda mais poderoso e eficaz! 💪🌟

Uso

import { PixBR } from 'pixbrasil';
// const { PixBR } = require('pixbrasil');

const pixCode = PixBR({
  key: 'person@email.com', //or any PIX key
  name: 'João da Silva',
  city: 'SAO PAULO',
  transactionId: 'PIXBR_TRANSACTION_ID', //optional, max 25 characters
  message: 'E O Pix, Nada Ainda?', //optional
  amount: 13.37 //optional
})

console.log(pixCode); // '00020126420014BR.GOV.BCB.PIX...'

Opções

OptionDefaultDescription
payloadVersion (optional)"01"Payload Version, string with 2 numbers.
keyundefinedThe pix key, such as: CPF, CNPJ, E-mail or random key
city (optional)undefinedUppercase city name with max 15 characters
nameundefinedThe merchant name
amount (optional)undefinedA positive number or none for open value
transactionId (optional)***A string with 25 characters just including A-Z (uppercase withou accents) and numbers
postalCode (optional)undefinedA string with exact 8 characters (See: CEP the brazilian postal code.)
currencyCode (optional)"986"See ISO-4217
countryCode (optional)"BR"See ISO-3166-1 alfa 2

Especificação

Especificação baseada nos documentos do Bacen: Manual do BR Code e Manual de Padrões para Iniciação do Pix 2.6.3