# PIXQRCODEGEN
## Módulo em Python
Este módulo foi criado para Python com compatiblidade para diversas chaves Pix para gerar a Paylod do Pix.
## O que é Pix?
Pix é um meio de pagamento eletrônico instantâneo e gratuito oferecido pelo [Banco Central do Brasil](https://www.bcb.gov.br/estabilidadefinanceira/pix) a pessoas físicas e jurídicas, sendo o mais recente meio de pagamento do Sistema de Pagamentos Brasileiro.
## O que é Pix Payload?
A Payload do Pix nada mais é que um conjunto de informações necessárias para pagamentos e transferências bancárias que necessita seguir as regras e estar bem formatada para ter sucesso no pagamento ou transferência.
Nesta [API](https://www.bcb.gov.br/content/estabilidadefinanceira/pix/Regulamento_Pix/II_ManualdePadroesparaIniciacaodoPix.pdf), do próprio [Banco Centra do Brasil](https://www.bcb.gov.br/), você poderá olhar com mais detalhes como funciona uma Payload Pix.
# Modo de uso
```
# Importando o módulo
from pixqrcodegen import Payload
# Parâmetros necessários
payload = Payload(nome, chavepix, valor, cidade, txtId)
# Chamando a função responsável para gerar a Payload Pix e o QR Code
payload.gerarPayload()
#####################################################################
"""Exemplo com dados fictícios"""
payload = Payload('Nome Sobrenome', '12345678900', '1.00', 'Cidade Ficticia', 'LOJA01')
payload.gerarPayload()
"""Resultado"""
00020126330014BR.GOV.BCB.PIX01111234567890052040000530398654041.005802BR5914Nome Sobrenome6015Cidade Ficticia62100506LOJA016304C8E4
"""Observação"""
QR Code é gerado após a criação da Payload do Pix e salvo no diretório de desenvolvimento.
```
# Importante
Nenhum dos dados podem ter caracteres especiais como acentos ou "ç" ~~e os valores monetários devem ser dividos por ponto (.) e não vírgula (,).~~
~~Exemplo:~~
~~Valor incorreto: 50,00~~
~~Valor correto: 50.00~~
Os valores monetários podem ser digitados tanto com ponto (.) quanto com vírgula (,).
Exemplo:
Valores corretos: 50.00 ou 50,00
Raw data
{
"_id": null,
"home_page": "https://github.com/Alexsussa/pixqrcodegen",
"name": "pixqrcodegen",
"maintainer": "",
"docs_url": null,
"requires_python": ">= 3.10",
"maintainer_email": "",
"keywords": "qrcode,payload,qrcode-generator,pix,pix-payload-generator",
"author": "Alex Pinheiro",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/19/93/2b1a8854644772d708af17c9a683a61e16378862cbacffed96af9f86e98b/pixqrcodegen-0.9.1.tar.gz",
"platform": null,
"description": "# PIXQRCODEGEN\n\n## M\u00f3dulo em Python\n\nEste m\u00f3dulo foi criado para Python com compatiblidade para diversas chaves Pix para gerar a Paylod do Pix.\n\n## O que \u00e9 Pix?\n\nPix \u00e9 um meio de pagamento eletr\u00f4nico instant\u00e2neo e gratuito oferecido pelo [Banco Central do Brasil](https://www.bcb.gov.br/estabilidadefinanceira/pix) a pessoas f\u00edsicas e jur\u00eddicas, sendo o mais recente meio de pagamento do Sistema de Pagamentos Brasileiro.\n\n## O que \u00e9 Pix Payload?\n\nA Payload do Pix nada mais \u00e9 que um conjunto de informa\u00e7\u00f5es necess\u00e1rias para pagamentos e transfer\u00eancias banc\u00e1rias que necessita seguir as regras e estar bem formatada para ter sucesso no pagamento ou transfer\u00eancia.\n\nNesta [API](https://www.bcb.gov.br/content/estabilidadefinanceira/pix/Regulamento_Pix/II_ManualdePadroesparaIniciacaodoPix.pdf), do pr\u00f3prio [Banco Centra do Brasil](https://www.bcb.gov.br/), voc\u00ea poder\u00e1 olhar com mais detalhes como funciona uma Payload Pix.\n\n# Modo de uso\n\n```\n# Importando o m\u00f3dulo\nfrom pixqrcodegen import Payload\n\n# Par\u00e2metros necess\u00e1rios\npayload = Payload(nome, chavepix, valor, cidade, txtId)\n\n# Chamando a fun\u00e7\u00e3o respons\u00e1vel para gerar a Payload Pix e o QR Code\npayload.gerarPayload()\n\n#####################################################################\n\n\"\"\"Exemplo com dados fict\u00edcios\"\"\"\n\npayload = Payload('Nome Sobrenome', '12345678900', '1.00', 'Cidade Ficticia', 'LOJA01')\n\npayload.gerarPayload()\n\n\"\"\"Resultado\"\"\"\n\n00020126330014BR.GOV.BCB.PIX01111234567890052040000530398654041.005802BR5914Nome Sobrenome6015Cidade Ficticia62100506LOJA016304C8E4\n\n\"\"\"Observa\u00e7\u00e3o\"\"\"\n\nQR Code \u00e9 gerado ap\u00f3s a cria\u00e7\u00e3o da Payload do Pix e salvo no diret\u00f3rio de desenvolvimento.\n\n```\n# Importante\n\nNenhum dos dados podem ter caracteres especiais como acentos ou \"\u00e7\" ~~e os valores monet\u00e1rios devem ser dividos por ponto (.) e n\u00e3o v\u00edrgula (,).~~\n\n~~Exemplo:~~\n\n~~Valor incorreto: 50,00~~\n\n~~Valor correto: 50.00~~\n\nOs valores monet\u00e1rios podem ser digitados tanto com ponto (.) quanto com v\u00edrgula (,).\n\nExemplo:\n\nValores corretos: 50.00 ou 50,00\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Gera a Payload do PIX e o QR Code",
"version": "0.9.1",
"project_urls": {
"Homepage": "https://github.com/Alexsussa/pixqrcodegen"
},
"split_keywords": [
"qrcode",
"payload",
"qrcode-generator",
"pix",
"pix-payload-generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19932b1a8854644772d708af17c9a683a61e16378862cbacffed96af9f86e98b",
"md5": "764382d464bd68799486ae70ee594827",
"sha256": "21db7f875a5d44bc3c249f8377edabbda7f3d593f8953687d0c28b3fbea4115e"
},
"downloads": -1,
"filename": "pixqrcodegen-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "764382d464bd68799486ae70ee594827",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 3.10",
"size": 4126,
"upload_time": "2023-07-02T20:51:31",
"upload_time_iso_8601": "2023-07-02T20:51:31.449899Z",
"url": "https://files.pythonhosted.org/packages/19/93/2b1a8854644772d708af17c9a683a61e16378862cbacffed96af9f86e98b/pixqrcodegen-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-02 20:51:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alexsussa",
"github_project": "pixqrcodegen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pixqrcodegen"
}
JSON
