Skip to content

Biblioteca javascript de padronização de gateways de pagamentos PIX

License

Notifications You must be signed in to change notification settings

vhratts/thunderpix

Repository files navigation

logo

⚡️ ThunderPix

version build test

Biblioteca javascript de padronização de gateways de pagamentos PIX

Introdução

Esta biblioteca tem como intuito fornecer uma interface de desenvolvimento de sistemas de pagamento, agregando as principais bibliotecas do mercado.

instalação

Para instalar este pacote em seu projeto, utilize o NPM ou YARN

npm install thunderpix

Inicio Rápido

Para utilizar a biblioteca, é necessario declarar o Provedo de pagamento que você deseja utilizar.

/**
 * Importe o construtor do ThunderPix 
 * e alguns dos provedores de pagamento listados
 */
import ThunderPix, { PixProvider } from 'thunderpix';

No exemplo usaremos um utilitario simples para gerar QrCode de cobrança Pix a partir de chave estática (email, aleatoria, cpf, telefone, cnpj).

(async () => {
  /**
   * Iniciando uma instancia do provedor
   * de pagamentos (no exemplo, uma chave pix aleatória)
   */
  var provider = new PixProvider({
    pixkey: '91b7482c-3ef1-4eff-8d80-9a59c87773a8'
  });
  /**
   * Inicia o construtor do ThunderPix
   * passando a instancia do provedor de pagamento
   */
  var thunder = new ThunderPix(provider);

  /**
   * Gerando um QrCode Pix de cobrança
   */
  var qrcode = await thunder.createQrCode({
    valueCents: 199,
    expires: 3600,
  });

  console.log(qrcode);
})();

O codigo acima é um exeplo basico de uso, onde o retorno da chamada é um objeto contendo os seguntes parametros:

{
  "qrcode": "data:image/png;base64,..",
 "pixkey": "00020126580014BR.GOV.BCB.PIX013691b7482c-3ef1-4eff-8d80-9a59c87773a852040000530398654041.995802BR5909Recebedor6009Sao Paulo62070503***6304E144",
  "value": { "original": 199, "cents": 199, "fixed": "1.99", "float": 1.99 },
  "expires": {
    "timestamp": 1729220402,
    "dateTime": "18/10/2024, 0:00:02",
    "iso": "2024-10-18T03:00:02.000Z"
  },
  "code": "fa99076c-f5d6-49fa-b4d9-51fdd1852fe6"
}

Provedores de pagamento suportados

A tabela abaixo mostra a lista de provedores de pagamento suportados pela biblioteca. De acordo com a atualização do desenvolvimento, esta tabela será modificada.

  • AVISO: Esta tabela é atualizada de acordo com a entrada ou saida de provedores de pagamento do sistema. Caso alguma API fique indisponivel por queda do serviço do provedor, O mesmo será tirado desta biblioteca.
logo/imagem/marca nome/link online/offline Provedor Recuperar Saldo Gerar QrCode Listar QrCodes Buscar QrCode Gerar Saques Listar Saques Buscar Saques
Logo Pix Pix ✅ online PixProvider 🚫 Não ✅ Sim 🚫 Não 🚫 Não 🚫 Não 🚫 Não 🚫 Não
Logo Primepag Banco Primepag ✅ online PrimepagProvider ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim
Logo MercadoPago Mercado Pago ✅ online MercadoPagoProvider ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim
Logo PicPay PicPay ✅ online PicPayProvider 🚫 Não ✅ Sim ✅ Sim ✅ Sim 🚫 Não 🚫 Não 🚫 Não
Logo PicPay Pagar-me ✅ online PagarmeProvider 🚫 Não ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim
Logo OpenPix OpenPix ✅ online OpenPixProvider ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim
Logo EfiPay EfiPay ✅ online EfiPayProvider ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim
Logo Asaas Asaas ✅ online AsaasProvider ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim
Logo Zendry Zendry ✅ online ZendryProvider ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim ✅ Sim

Bugs e reports

Para reportar bugs ou erros, use a aba issues deste repositório.

Contato

Desenvolvedor: Victor Ratts
Email: victor@vratts.com
site: vratts

Me pague um café ☕️ 🙏

Pix: 91b7482c-3ef1-4eff-8d80-9a59c87773a8

About

Biblioteca javascript de padronização de gateways de pagamentos PIX

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published