PHPackages climba-commerce/php-pix - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Payment Processing](/categories/payments) 4. / 5. climba-commerce/php-pix ActiveLibrary[Payment Processing](/categories/payments) climba-commerce/php-pix ======================= Uma biblioteca para preparar e gerar o código Pix do Banco Central do Brasil. 2.0.0(4y ago)033.1k↓33.3%MITPHPPHP ^7.2 || ^8.0 Since Dec 20Pushed 4y agoCompare [ Source](https://github.com/Climba-Commerce/php-pix)[ Packagist](https://packagist.org/packages/climba-commerce/php-pix)[ Docs](https://github.com/piggly-dev/php-pix)[ RSS](/packages/climba-commerce-php-pix/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (1)Dependencies (3)Versions (18)Used By (0) Crie/Leia códigos Pix sem complicações com PHP ============================================== [](#crieleia-códigos-pix-sem-complicações-com-php) [![Latest Version on Packagist](https://camo.githubusercontent.com/8506981b698ee18cd704ef704defd5e1cef27be98a0c788ec2287e2711bf6ada/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f706967676c792f7068702d7069782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/piggly/php-pix) [![Packagist Downloads](https://camo.githubusercontent.com/05c05f30c6723ee05ffe9e6488c6813cb7d000e7b63d210f7f63ff18b8cce4cc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f706967676c792f7068702d7069783f7374796c653d666c61742d737175617265)](https://packagist.org/packages/piggly/php-pix) [![Packagist Stars](https://camo.githubusercontent.com/9588bb33c65540f46468ae7ff49579507c6736be12f0ab19622658136ec1c5e8/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f73746172732f706967676c792f7068702d7069783f7374796c653d666c61742d737175617265)](https://packagist.org/packages/piggly/php-pix) [![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE) [![PHP](https://camo.githubusercontent.com/c2d7932a0763b67f2a11c12ea548a40a4540cd014a0cfc567b3f888b2dab5bbe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f706967676c792f7068702d7069783f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/c2d7932a0763b67f2a11c12ea548a40a4540cd014a0cfc567b3f888b2dab5bbe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f706967676c792f7068702d7069783f7374796c653d666c61742d737175617265) [![Versão Atual](https://camo.githubusercontent.com/114464995c50b091fb84a32160b6b7af65c8526f774c75d5143085806043d187/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d322e782e782d677265656e3f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/114464995c50b091fb84a32160b6b7af65c8526f774c75d5143085806043d187/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d322e782e782d677265656e3f7374796c653d666c61742d737175617265) O **Pix** é o mais novo método de pagamento eletrônico criado pelo **Banco Central do Brasil**. Você encontra todos os detalhes na [página oficial](https://www.bcb.gov.br/estabilidadefinanceira/pix) do Pix. Saiba mais como ele funciona e como nossa biblioteca trabalha [clicando aqui](https://github.com/piggly-dev/php-pix/wiki/04.-Pix). Essa biblioteca foi criada para ser utilizada principalmente com o plugin de **Woocommerce** [Pix por Piggly](https://wordpress.org/plugins/pix-por-piggly/). Mas, pode ser utilizada em qualquer sistema onde seja necessário a criação de payloads, códigos e QRCodes Pix. Afinal, ela foi criada para otimizar o processo de trabalho com os códigos Pix. Com ela, você poderá: - Gerar códigos Pix estáticos e dinâmicos; - Criar QR Codes para os códigos pix gerados; - Ler códigos Pix importando os dados Pix; - Criar payloads de Cobranças e Devoluções para interagir com as APIs Pix; - Usar uma base de comunicação com a Api para organizar seus códigos; - Gerar códigos compatíveis com a última versão do Pix. Leia sobre a solução de problemas [clicando aqui](https://github.com/piggly-dev/php-pix/wiki/09.-Solu%C3%A7%C3%A3o-de-Problemas) caso suas chaves Pix sejam inválidas. E, não deixe de conferir nossa [documentação completa](https://github.com/piggly-dev/php-pix/wiki). > Se você apreciar a função desta biblioteca e quiser apoiar este trabalho, sinta-se livre para fazer qualquer doação para a chave aleatória Pix `aae2196f-5f93-46e4-89e6-73bf4138427b` ❤. Atualização para a versão 2.0.0 ------------------------------- [](#atualização-para-a-versão-200) Muitas coisas mudaram, além do suporte ao **PHP 8** os campos EMV foram otimizados e expandidos. Além disso, as requisições para APIs foram removidas e os payloads para as APIs foram reformulados. Recomendamos ler a documentação de mudanças [clicando aqui](https://github.com/piggly-dev/php-pix/wiki/11.-Migrar-para-a-vers%C3%A3o-2.x.x) e verificar as diferenças. A biblioteca `chillerlan/php-qrcode` não pode ser atualizada em `composer.json`, tornando necessário utilizar a `flag` `--ignore-platform-reqs` no **PHP 8**. Veja abaixo: ``` # composer install composer --ignore-platform-req=php install # composer update composer --ignore-platform-req=php update # e todos os demais comandos do composer ``` > Muitos utilizadores dessa biblioteca ainda utilizando a versão `7.2` do PHP e não é o momento ideal para perder esse suporte. A partir da versão `2.1.x` pretendemores remover esse suporte. Para realizar as requisições da api, recomendamos a biblioteca [piggly/php-api-client](https://github.com/piggly-dev/php-api-client), ela foi desenvolvida para ser flexível e muito mais robusta que a solução anterior utilizada na versão 1.x.x. Veja as principais mudanças da versão 2.x.x: - O padrão EMV MPM foi atualizado e remodelado para suportar novos campos que podem ser utilizados nos Pix; - A validação e verificação das chaves Pix foi aprimorada; - A leitura de um código Pix resulta em um objeto de EMVs mais flexível; - Os modificadores do payload foram removidos, sendo que agora, todos os dados preenchidos são automaticamente tratados e cortados respeitando completamente o padrão EMV; - A classe `BaseAPI` foi removida, adotando como sugestão a biblioteca [piggly/php-api-client](https://github.com/piggly-dev/php-api-client) que traz muito mais flexibilidade e segurança; - Os payloads para APIs foram remodelados para serem mais eficientes e flexíveis. Instalação ---------- [](#instalação) ### Composer [](#composer) - No terminal, dentro da sua pasta do projeto, digite `composer require piggly/php-pix`; - Não esqueça de iniciar o composer incluindo o arquivo `require_once('vendor/autoload.php);` na base do código. ### Instalação Manual [](#instalação-manual) - Baixe ou clone esse repositório com `git clone https://github.com/piggly-dev/php-pix.git`; - Depois, vá para a pasta `/path/to/php-pix` e dê o comando `composer install` para instalar todas as dependências. - Adicione o `autoload` do composer na base do seu projeto `require_once('/path/to/php-pix/vendor/autoload.php);`. Dependências ------------ [](#dependências) Essa bibliotecca possuí as seguintes dependências: - [Extensão GD do PHP](https://www.php.net/manual/pt_BR/book.image.php) para gerar QR Codes; - PHP +7.2 ou PHP +8.0. Como utilizar? -------------- [](#como-utilizar) > Recomendamos que leia a documentação completa [clicando aqui](https://github.com/piggly-dev/php-pix/wiki) Em [samples/payload.php](samples/payload.php) e [samples/reader.php](samples/reader.php) você encontra um exemplo de implementação. Esta biblioteca é bem simples de utilizar e tudo que você precisa fazer é solicitar ao usuário ou ter os seguintes dados para gerar o Pix: Obrigatórios: - `$keyType = Parser::KEY_TYPE_RANDOM;` - `$keyValue = 'aae2196f-5f93-46e4-89e6-73bf4138427b';` - `$merchantName = 'STUDIO PIGGLY';` - `$merchantCity = 'Uberaba';` Opcionais: - `$amount = 109.90;` - `$tid = '034593-09';` - `$description = 'Pagamento 01';` - `$reusable = false;` Depois crie o objeto `Payload` e utilize os métodos `getPixCode()` ou `getQRCode()`, conforme as suas necessidades. Você também pode criar o objeto `Reader` para extrair os dados de uma chave pix válida. Testes realizados ----------------- [](#testes-realizados) O código Pix gerado por essa biblioteca, incluindo a função **QR Code** e **Pix Copia & Cola**, foi testado nos seguintes aplicativos de banco: - Banco do Brasil; - Banco Inter; - BMG; - Bradesco; - C6; - Itaú; - Mercado Pago; - Nubank; - PagPank; - Santander. Como o código utiliza o padrão do Pix é possível que funcione em todos os bancos. Alguns bancos ainda estão resilientes em utilizar os padrões determinados. Então, caso encontre problemas ou dificuldades não hesite em abrir uma [Issue](https://github.com/piggly-dev/php-pix/issues) ou enviar um e-mail para . Ao enviar um e-mail ou abrir uma issue, certifique-se de informar: - Versão da Biblioteca: 2.0.0; - Banco Emitente: NuBank; - Banco Pagador: Inter; - Tipo de Erro: O **QR Code** é inválido; - Chave Pix Gerada: `00020101021126740014br.gov.bcb.pix0136aae2196f-5f93-46e4-89e6-73bf4138427b0212Pagamento 0152040000053039865406109.905802BR5913STUDIO PIGGLY6007Uberaba62130509034593-09630444C9`; Changelog --------- [](#changelog) Veja o arquivo [CHANGELOG](CHANGELOG.md) para informações sobre todas as mudanças no código. Testes de Código ---------------- [](#testes-de-código) Essa biblioteca utiliza o [PHPUnit](https://phpunit.de/). Realizamos testes com todas as principais classes dessa aplicação. ``` vendor/bin/phpunit ``` Contribuições ------------- [](#contribuições) Veja o arquivo [CONTRIBUTING](CONTRIBUTING.md) para informações antes de enviar sua contribuição. Segurança --------- [](#segurança) Se você descobrir qualquer issue relacionada a segurança, por favor, envie um e-mail para ao invés de utilizar o rastreador de issues do Github. Créditos -------- [](#créditos) - [Caique Araujo](https://github.com/caiquearaujo) - [Todos os colaboradores](../../contributors) Apoie o projeto --------------- [](#apoie-o-projeto) **Piggly Studio** é uma agência localizada no Rio de Janeiro, Brasil. Se você apreciar a função desta biblioteca e quiser apoiar este trabalho, sinta-se livre para fazer qualquer doação para a chave aleatória Pix `aae2196f-5f93-46e4-89e6-73bf4138427b` ❤. License ------- [](#license) MIT License (MIT). Veja [LICENSE](LICENSE) para mais informações. ### Health Score 34 — LowBetter than 77% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community9 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 84.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~25 days Recently: every ~78 days Total 16 Last Release 1602d ago Major Versions 1.2.6 → 2.0.02021-12-28 PHP version history (3 changes)1.0.0PHP ^7.1 1.1.1PHP ^7.2 2.0.0PHP ^7.2 || ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/ff8feb66a6100d76ca837f8f79304bba3f8435d72660c379a5de9811b7c7856c?d=identicon)[idealizetecnologia](/maintainers/idealizetecnologia) --- Top Contributors [![caiquearaujo](https://avatars.githubusercontent.com/u/23598990?v=4)](https://github.com/caiquearaujo "caiquearaujo (22 commits)")[![willian-rosa](https://avatars.githubusercontent.com/u/17603785?v=4)](https://github.com/willian-rosa "willian-rosa (3 commits)")[![Pr3d4dor](https://avatars.githubusercontent.com/u/13210429?v=4)](https://github.com/Pr3d4dor "Pr3d4dor (1 commits)") --- Tags qrcodepaymentemvpigglypixbcb ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/climba-commerce-php-pix/health.svg) ``` [![Health](https://phpackages.com/badges/climba-commerce-php-pix/health.svg)](https://phpackages.com/packages/climba-commerce-php-pix) ``` ### Alternatives [piggly/php-pix Uma biblioteca para preparar e gerar o código Pix do Banco Central do Brasil. 113136.4k1](/packages/piggly-php-pix)[paypayopa/php-sdk PHP SDK for PayPay Open Payment API 18279.6k3](/packages/paypayopa-php-sdk)[mrprompt/cielo Integration with Cielo gateway. 481.9k1](/packages/mrprompt-cielo)[mjaschen/bezahlcode BezahlCode Generator Library 128.1k](/packages/mjaschen-bezahlcode)[kilylabs/qr-payment-php Генерация QR-кодов для оплаты на базе ГОСТ Р 56042-2014 для PHP 1317.2k](/packages/kilylabs-qr-payment-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)