PHPackages fredroo/openboleto - 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. [Utility & Helpers](/categories/utility) 4. / 5. fredroo/openboleto Abandoned → [openboleto/openboleto](/?search=openboleto%2Fopenboleto)Library[Utility & Helpers](/categories/utility) fredroo/openboleto ================== Biblioteca para geração de boletos bancários. v2.0.1(1y ago)60810.1k334[33 issues](https://github.com/openboleto/openboleto/issues)[2 PRs](https://github.com/openboleto/openboleto/pulls)MITPHPPHP >=7.4CI passing Since Jul 28Pushed 3mo ago55 watchersCompare [ Source](https://github.com/openboleto/openboleto)[ Packagist](https://packagist.org/packages/fredroo/openboleto)[ Docs](http://github.com/openboleto/openboleto)[ RSS](/packages/fredroo-openboleto/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (3)Versions (5)Used By (0) [![Pipeline](https://github.com/openboleto/openboleto/actions/workflows/ci.yml/badge.svg)](https://github.com/openboleto/openboleto/actions/workflows/ci.yml) OpenBoleto ========== [](#openboleto) O OpenBoleto é uma biblioteca de código aberto para geração de boletos bancários, um meio de pagamento muito comum no Brasil. O foco é ser simples e ter uma arquitetura compatível com os recursos mais modernos do PHP. Se esse projeto te auxiliou de alguma forma, você pode contribuir financeiramente para que eu possa continuar a desenvolver projetos open source. As contribuições podem ser: Ajude o Projeto a continuar, faça uma doação no PIX! ==================================================== [](#ajude-o-projeto-a-continuar-faça-uma-doação-no-pix) ``` b230c7a8-8743-459f-bae5-541ea46a3533 ``` [![302100763-dc530122-d9fb-41e4-9edf-dc9c32e74adc](https://private-user-images.githubusercontent.com/6863089/302100975-1a6505e5-5039-4609-87af-ba84f03d4b08.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzM4NzcxNzIsIm5iZiI6MTc3Mzg3Njg3MiwicGF0aCI6Ii82ODYzMDg5LzMwMjEwMDk3NS0xYTY1MDVlNS01MDM5LTQ2MDktODdhZi1iYTg0ZjAzZDRiMDgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDMxOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjAzMThUMjMzNDMyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ODk4ZDVjNzFhNzhkMmY5MzRlMjQyNDdjNzVmMjA3NjM2OGNmOTBmNjFhMDJiMjdjZGEwZDFkOTBjZWRiZWEwYiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.6g2XkMuBpbP9zwC1n_JzxOtO-Nqke5DdR-R8znDdZoQ)](https://private-user-images.githubusercontent.com/6863089/302100975-1a6505e5-5039-4609-87af-ba84f03d4b08.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzM4NzcxNzIsIm5iZiI6MTc3Mzg3Njg3MiwicGF0aCI6Ii82ODYzMDg5LzMwMjEwMDk3NS0xYTY1MDVlNS01MDM5LTQ2MDktODdhZi1iYTg0ZjAzZDRiMDgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDMxOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjAzMThUMjMzNDMyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ODk4ZDVjNzFhNzhkMmY5MzRlMjQyNDdjNzVmMjA3NjM2OGNmOTBmNjFhMDJiMjdjZGEwZDFkOTBjZWRiZWEwYiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.6g2XkMuBpbP9zwC1n_JzxOtO-Nqke5DdR-R8znDdZoQ) Instalação ---------- [](#instalação) ### Composer [](#composer) Se você já conhece o **Composer** (o que é extremamente recomendado), simplesmente adicione a dependência abaixo à diretiva *"require"* em seu **composer.json**: ``` "openboleto/openboleto": "dev-master" ``` ### PSR-0 autoloader [](#psr-0-autoloader) Hoje praticamente qualquer framework utiliza deste padrão, então você deve [baixar](https://github.com/fredroo/openboleto/archive/master.zip) o OpenBoleto, colocar em uma pasta específica (geralmente *lib* ou *vendor*) e procurar na documentação do seu framework para fazer com que o seu autoloader aponte o namespace **OpenBoleto** para a pasta **src** do OpenBoleto. ### Stand-alone library [](#stand-alone-library) Se você quer simplesmente baixar e dar um include, também é muito simples. Primeiro [baixe](https://github.com/fredroo/openboleto/archive/master.zip) (ou dê clone no repositório), e coloque em uma pasta específica. Depois, dê um include no arquivo **autoloader.php** e voilà! Gerando boletos --------------- [](#gerando-boletos) Essa é a melhor parte. Não poderia ser mais simples, veja um exemplo básico: ``` use OpenBoleto\Agente; use OpenBoleto\Banco\BancoDoBrasil; $sacado = new Agente('Fernando Maia', '023.434.234-34', 'ABC 302 Bloco N', '72000-000', 'Brasília', 'DF'); $cedente = new Agente('Empresa de cosméticos LTDA', '02.123.123/0001-11', 'CLS 403 Lj 23', '71000-000', 'Brasília', 'DF'); $boleto = new BancoDoBrasil(array( // Parâmetros obrigatórios 'dataVencimento' => new DateTime('2013-01-24'), 'valor' => 23.00, 'sequencial' => 1234567, // Para gerar o nosso número 'sacado' => $sacado, 'cedente' => $cedente, 'agencia' => 1724, // Até 4 dígitos 'carteira' => 18, 'conta' => 10403005, // Até 8 dígitos 'convenio' => 1234, // 4, 6 ou 7 dígitos 'qrCode' => 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net', // Caso o Boleto tenha registro para uso de QrCode Pix )); echo $boleto->getOutput(); ``` Como adiquirir o QrCode Pix --------------------------- [](#como-adiquirir-o-qrcode-pix) O uso padrão do PIX não pode ser usado no boleto, à instituição bancária tem um serviço da qual você passa o boleto registrado e solicita a PIX, o banco vai te retornar uma string na qual é o PIX que identifica o boleto, para quando realizar o pagamento via PIX, tenha referência do boleto para ser baixado. Sim, só isso! Lembre-se de que cada banco possui alguma particularidade, mas em geral são estes parâmetros os obrigatórios. Na pasta **samples** existe um exemplo funcional de cada banco, você pode verificar lá quais são os parâmetros necessários para cada banco. Bancos suportados ----------------- [](#bancos-suportados) Atualmente o OpenBoleto funciona com os bancos abaixo: Banco Situação HTML Situação JasperPHP(PDF) Banco de Brasília (BRB) Beta Beta Banco do Brasil Homologado Homologado Banco do Nordeste Beta Beta Banese Beta Beta Bradesco Homologado Homologado Caixa (SIGCB) Beta Homologado Cecred Beta Beta HSBC Beta Beta Itaú Beta Homologado Santander Beta Beta Sicoob Beta Beta Unicred Homologado Beta Viacredi Beta Beta Sicredi Beta Beta Banrisul Beta Beta C6 Bank Homologado Homologado ABC Homologado Homologado BV -- BETA ### API Banco Inter [](#api-banco-inter) O Banco Inter está disponibilizando uma API para emissão de boletos. O projeto [ctodobom/APInter-PHP](https://github.com/ctodobom/APInter-PHP) implementa funções para facilitar o acesso à essa API. Integração com QuilhaSoft/JasperPHP ----------------------------------- [](#integração-com-quilhasoftjasperphp) QuilhaSoft/JasperPHP é uma biblioteca puro PHP, que gera o boleto no formato PDF sem conversão do HTML, o layout do boleto pode ser editado com o JasperSoft Studio Para ver funcionando abra o exemplo em Toda contribuição é bem vinda. Se você deseja adaptar o OpenBoleto a algum outro banco, fique à vontade para explorar o código, veja como é bastante simples integrar qualquer banco à biblioteca. Remessa e Retorno ----------------- [](#remessa-e-retorno) Licença ------- [](#licença) - MIT License ### Health Score 55 — FairBetter than 98% of packages Maintenance65 Regular maintenance activity Popularity44 Moderate usage in the ecosystem Community37 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~1415 days Total 4 Last Release 426d ago Major Versions v0.1 → v1.02013-08-04 v1.0 → v2.0.02025-02-14 PHP version history (2 changes)v0.1PHP >=5.3.0 v2.0.0PHP >=7.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/34ab341d9312d9ef092adff942810d02cb8613987ead104597af3ceb53c35696?d=identicon)[QuilhaSoft](/maintainers/QuilhaSoft) ![](https://www.gravatar.com/avatar/fe03c63d099e64e38f62fa7478ef68eb5cb9fbe0ce9416acaa3956f0eb89c890?d=identicon)[fredroo](/maintainers/fredroo) --- Top Contributors [![Rctnet](https://avatars.githubusercontent.com/u/17881422?v=4)](https://github.com/Rctnet "Rctnet (104 commits)")[![kriansa](https://avatars.githubusercontent.com/u/962032?v=4)](https://github.com/kriansa "kriansa (63 commits)")[![lucasnpinheiro](https://avatars.githubusercontent.com/u/2411995?v=4)](https://github.com/lucasnpinheiro "lucasnpinheiro (16 commits)")[![gersonfs](https://avatars.githubusercontent.com/u/293154?v=4)](https://github.com/gersonfs "gersonfs (15 commits)")[![vjnrv](https://avatars.githubusercontent.com/u/99794?v=4)](https://github.com/vjnrv "vjnrv (10 commits)")[![fabioginzel](https://avatars.githubusercontent.com/u/7377511?v=4)](https://github.com/fabioginzel "fabioginzel (9 commits)")[![cristianoteles](https://avatars.githubusercontent.com/u/215228?v=4)](https://github.com/cristianoteles "cristianoteles (7 commits)")[![dadeke](https://avatars.githubusercontent.com/u/6050573?v=4)](https://github.com/dadeke "dadeke (6 commits)")[![erickmff](https://avatars.githubusercontent.com/u/5818522?v=4)](https://github.com/erickmff "erickmff (6 commits)")[![rauye](https://avatars.githubusercontent.com/u/8474382?v=4)](https://github.com/rauye "rauye (6 commits)")[![JoaoVictorSarzi](https://avatars.githubusercontent.com/u/11160733?v=4)](https://github.com/JoaoVictorSarzi "JoaoVictorSarzi (6 commits)")[![rodrigofs](https://avatars.githubusercontent.com/u/2329113?v=4)](https://github.com/rodrigofs "rodrigofs (5 commits)")[![vitorccs](https://avatars.githubusercontent.com/u/9891961?v=4)](https://github.com/vitorccs "vitorccs (4 commits)")[![eerison](https://avatars.githubusercontent.com/u/6358755?v=4)](https://github.com/eerison "eerison (4 commits)")[![fresfj](https://avatars.githubusercontent.com/u/1755815?v=4)](https://github.com/fresfj "fresfj (3 commits)")[![chrisbckr](https://avatars.githubusercontent.com/u/23089916?v=4)](https://github.com/chrisbckr "chrisbckr (3 commits)")[![warquia](https://avatars.githubusercontent.com/u/7989959?v=4)](https://github.com/warquia "warquia (3 commits)")[![fabriciolangermt](https://avatars.githubusercontent.com/u/25546389?v=4)](https://github.com/fabriciolangermt "fabriciolangermt (3 commits)")[![PedroRav](https://avatars.githubusercontent.com/u/88684153?v=4)](https://github.com/PedroRav "PedroRav (3 commits)")[![Joao-Bittencourt](https://avatars.githubusercontent.com/u/24395717?v=4)](https://github.com/Joao-Bittencourt "Joao-Bittencourt (3 commits)") --- Tags boletosjasperreportsphpboletoboleto bancario ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/fredroo-openboleto/health.svg) ``` [![Health](https://phpackages.com/badges/fredroo-openboleto/health.svg)](https://phpackages.com/packages/fredroo-openboleto) ``` ### Alternatives [kriansa/openboleto Biblioteca para geração de boletos bancários. 6142.2M2](/packages/kriansa-openboleto)[openboleto/openboleto Biblioteca para geração de boletos bancários. 610205.4k1](/packages/openboleto-openboleto)[andersondanilo/cnab_php Projeto para criar arquivos de remessas e processar arquivos de retorno no formato CNAB 334260.6k2](/packages/andersondanilo-cnab-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)