faz-um-pix
A Forma mais Fácil e Simples de Receber Pagamentos 💵
Biblioteca em JavaScript para gerar transações utilizando o sistema PIX do BACEN.
Demonstração
https://enssureit.github.io/faz-um-pix/example
Instalação
npm install faz-um-pix --save
ou
yarn add faz-um-pix
Uso
Typescript
import { Pix } from "faz-um-pix"
const code = Pix("123456789", "SILVA SILVA", "RIO DE JANEIRO", "0.10", "Pedido #123456");
// return "00020126490014br.gov.bcb.pix01091234567890214Pedid…1SILVA SILVA6014RIO DE JANEIRO62070503***6304E92D"
Or if you want it to return a qrcode
const code = Pix("123456789", "SILVA SILVA", "RIO DE JANEIRO", "0.10", "Pedido #123456", true);
// return "data:image/gif;base64,R0lGODdhkAGQAYAAAAAAAP///ywAAAAAkAGQAQAC/4yPqcvtD6OctNqLs968+w+G4kiW5omm6sq27gvH8kzX9o3n+s4z..."
Vanilla JS
var _pix = require('faz-um-pix');
var code = _pix.Pix("123456789", "SILVA SILVA", "RIO DE JANEIRO", "0.10", "Pedido #123456");
// return "00020126490014br.gov.bcb.pix01091234567890214Pedid…1SILVA SILVA6014RIO DE JANEIRO62070503***6304E92D"
Or if you want it to return a qrcode
const code = _pix.Pix("123456789", "SILVA SILVA", "RIO DE JANEIRO", "0.10", "Pedido #123456", true);
// return "data:image/gif;base64,R0lGODdhkAGQAYAAAAAAAP///ywAAAAAkAGQAQAC/4yPqcvtD6OctNqLs968+w+G4kiW5omm6sq27gvH8kzX9o3n+s4z..."
Browser
<script src="lib/faz-um-pix.js"></script>
var code = _pix.Pix("123456789", "SILVA SILVA", "RIO DE JANEIRO", "0.10", "Pedido #123456");
// return "00020126490014br.gov.bcb.pix01091234567890214Pedid…1SILVA SILVA6014RIO DE JANEIRO62070503***6304E92D"
Or if you want it to return a qrcode
const code = _pix.Pix("123456789", "SILVA SILVA", "RIO DE JANEIRO", "0.10", "Pedido #123456", true);
// return "data:image/gif;base64,R0lGODdhkAGQAYAAAAAAAP///ywAAAAAkAGQAQAC/4yPqcvtD6OctNqLs968+w+G4kiW5omm6sq27gvH8kzX9o3n+s4z..."
Screenshot
Como contribuir
- Faça um Fork desse repositório,
- Faça um clone do respositório criado a partir do fork:
git clone https://github.com/<seu username>/faz-um-pix.git - Crie uma branch com a sua feature:
git checkout -b feat/minha-feature-de-examplo - Commit suas mudanças:
git commit -m "feat: Minha nova feature"(Ver regras para commits) - Faça o push da sua branch:
git push origin feat/minha-feature-de-examplo - Ir em pull requests do projeto original e crie uma pull request com o seu commit.
Regras para commits
- Para cada commit siga a padronização do commitlint
- evite commits acima de 70 caracteres
Contribuidores
Adriano Laureano |
Celso Inácio |
License
MIT © Enssure Softwares