Git Product home page Git Product logo

guilhermeasn / react-qrcode-pix Goto Github PK

View Code? Open in Web Editor NEW
12.0 1.0 3.0 1.93 MB

Purpose of this package is to facilitate the receipt of payments with PIX (Brazilian payment method) in React applications. Generating static QRcode for payment. Objetivo deste pacote é a de facilitar o recebimento de pagamentos com PIX (método de pagamento brasileiro) em aplicações React. Gerando o Qrcode estático para pagamento.

Home Page: https://guilhermeasn.github.io/react-qrcode-pix/

License: MIT License

JavaScript 1.08% TypeScript 98.92%
pix pagamento recebimento qrcode-pix react

react-qrcode-pix's Introduction

React QRcode PIX

npm

downloads

Tests

example

Objetivo deste pacote é a de facilitar o recebimento de pagamentos com PIX em aplicações React. Gerando o Qrcode estático para pagamento.

O payload do qrcode foi desenvolvido seguindo os documentos oficiais do BACEN:

🚀 Instalação

Para instalar no seu projeto React com NPM utilize o comando abaixo:

npm install react-qrcode-pix

Ou instale com Yarn:

yarn add react-qrcode-pix

🛠️ Configuração

Propiedade do componente PIX:

  • pixkey <string>: Chave PIX (obrigatório).
  • merchant <string>: Nome do recebedor (obrigatório).
  • city <string>: Cidade do recebedor (obrigatório).
  • cep <string>: CEP do recebedor (opcional).
  • code <string>: Código único para identificação do pagamento (opcional).
  • amount <number>: Valor da transação (opcional).
  • onLoad <function>: Callback para receber o payload (opcional).
  • ignoreErrors <boolean>: Para não validar as informações (opcional).

Veja as propriedades relacionadas ao qrcode aqui.

Formatos válidos de chave PIX (pixkey):

  • EMAIL: [email protected]
  • CPF: 12345678900
  • CNPJ: 00038166000105
  • TELEFONE: +5561912345678
  • ALEATORIA: 123e4567-e12b-12d1-a456-426655440000

🛠️ Exemplos de Uso

Você pode ver os exemplos em funcionamento clicando aqui ou veja em sandbox.

  • Configuração mínima, sem valor definido:
    <PIX
        pixkey='[email protected]'
        merchant='Guilherme Neves'
        city='Paraíba do Sul'
    />
  • Configuração completa:
    <PIX
        pixkey='[email protected]'
        merchant='Guilherme Neves'
        city='Paraíba do Sul'
        cep='25.850-000'
        code={ 'RQP' + now }
        amount={ 100 }

        onLoad={ payload => setViewPIX(payload) }
    />

Resultado

  • QRcode:

QrCodePIX

  • Payload:
00020126470014BR.GOV.BCB.PIX0125guilhermeasn@yahoo.com.br5204000053039865802BR5915Guilherme Neves6014Paraiba do Sul62070503***6304D1F3

✒️ Autor

📄 Licença

Este projeto está sob a licença MIT - veja o arquivo LICENSE para detalhes.

react-qrcode-pix's People

Contributors

guilhermeasn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

react-qrcode-pix's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.