PHPackages                             uoston/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. [Payment Processing](/categories/payments)
4. /
5. uoston/openboleto

ActiveLibrary[Payment Processing](/categories/payments)

uoston/openboleto
=================

Biblioteca para geração de boletos bancários.

v1.2.2(2y ago)02.0kMITPHPPHP &gt;=5.6

Since Dec 5Pushed 2y agoCompare

[ Source](https://github.com/uoston/openboleto)[ Packagist](https://packagist.org/packages/uoston/openboleto)[ Docs](http://github.com/openboleto/openboleto)[ RSS](/packages/uoston-openboleto/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (7)Dependencies (1)Versions (7)Used By (0)

OpenBoleto [![Build Status](https://camo.githubusercontent.com/77d9d00a1c07a2304f36e0910f19c0d37dc93c0e67a00792e8774888480e9386/68747470733a2f2f7472617669732d63692e6f72672f6f70656e626f6c65746f2f6f70656e626f6c65746f2e706e67)](https://travis-ci.org/openboleto/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.

Ajude o Projeto a continuar, faça uma doação!
---------------------------------------------

[](#ajude-o-projeto-a-continuar-faça-uma-doação)

[![Pague com PagSeguro - é rápido, grátis e seguro!](https://camo.githubusercontent.com/946696bf62833f81eb9ccd9739860d21994df3ce02641259d4f4930ea5b0b9dd/68747470733a2f2f7374632e70616773656775726f2e756f6c2e636f6d2e62722f7075626c69632f696d672f626f746f65732f646f61636f65732f3230397834382d646f61722d617373696e612e676966)](https://pag.ae/7UaL6CCHQ)

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\Banco\BancoDoBrasil;
use OpenBoleto\Agente;

$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
));

echo $boleto->getOutput();
```

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

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 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 ~0 days

Total

6

Last Release

883d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e457b7d613f74773849816eb68bcbd1fd284149347078decc0e5fb30f22a5e0d?d=identicon)[uoston](/maintainers/uoston)

---

Top Contributors

[![Rctnet](https://avatars.githubusercontent.com/u/17881422?v=4)](https://github.com/Rctnet "Rctnet (96 commits)")[![kriansa](https://avatars.githubusercontent.com/u/962032?v=4)](https://github.com/kriansa "kriansa (63 commits)")[![vjnrv](https://avatars.githubusercontent.com/u/99794?v=4)](https://github.com/vjnrv "vjnrv (10 commits)")[![uoston](https://avatars.githubusercontent.com/u/9766877?v=4)](https://github.com/uoston "uoston (8 commits)")[![cristianoteles](https://avatars.githubusercontent.com/u/215228?v=4)](https://github.com/cristianoteles "cristianoteles (7 commits)")[![fabioginzel](https://avatars.githubusercontent.com/u/7377511?v=4)](https://github.com/fabioginzel "fabioginzel (7 commits)")[![dadeke](https://avatars.githubusercontent.com/u/6050573?v=4)](https://github.com/dadeke "dadeke (6 commits)")[![rauye](https://avatars.githubusercontent.com/u/8474382?v=4)](https://github.com/rauye "rauye (6 commits)")[![erickmff](https://avatars.githubusercontent.com/u/5818522?v=4)](https://github.com/erickmff "erickmff (6 commits)")[![eerison](https://avatars.githubusercontent.com/u/6358755?v=4)](https://github.com/eerison "eerison (4 commits)")[![warquia](https://avatars.githubusercontent.com/u/7989959?v=4)](https://github.com/warquia "warquia (3 commits)")[![chrisbckr](https://avatars.githubusercontent.com/u/23089916?v=4)](https://github.com/chrisbckr "chrisbckr (3 commits)")[![gildonei](https://avatars.githubusercontent.com/u/1370979?v=4)](https://github.com/gildonei "gildonei (2 commits)")[![wgrafael](https://avatars.githubusercontent.com/u/1341623?v=4)](https://github.com/wgrafael "wgrafael (2 commits)")[![brunoqueiros](https://avatars.githubusercontent.com/u/1280255?v=4)](https://github.com/brunoqueiros "brunoqueiros (2 commits)")[![evaldoprestes](https://avatars.githubusercontent.com/u/5281334?v=4)](https://github.com/evaldoprestes "evaldoprestes (2 commits)")[![rodrigotavio91](https://avatars.githubusercontent.com/u/6095264?v=4)](https://github.com/rodrigotavio91 "rodrigotavio91 (2 commits)")[![JoaoVictorSarzi](https://avatars.githubusercontent.com/u/11160733?v=4)](https://github.com/JoaoVictorSarzi "JoaoVictorSarzi (2 commits)")[![JulioSborchia](https://avatars.githubusercontent.com/u/110607486?v=4)](https://github.com/JulioSborchia "JulioSborchia (2 commits)")[![lucioabrantes](https://avatars.githubusercontent.com/u/2862183?v=4)](https://github.com/lucioabrantes "lucioabrantes (2 commits)")

---

Tags

boletoboleto bancario

### Embed Badge

![Health badge](/badges/uoston-openboleto/health.svg)

```
[![Health](https://phpackages.com/badges/uoston-openboleto/health.svg)](https://phpackages.com/packages/uoston-openboleto)
```

###  Alternatives

[openboleto/openboleto

Biblioteca para geração de boletos bancários.

610205.4k1](/packages/openboleto-openboleto)[openboleto/opencnabphp

Biblioteca multibanco para geração e leitura de arquivos Cnab de remessa e retorno

2097.3k](/packages/openboleto-opencnabphp)[vitorccs/bradesco-api-php

SDK PHP para a API de Registro de Boletos do Bradesco

477.9k](/packages/vitorccs-bradesco-api-php)[mrprompt/cielo

Integration with Cielo gateway.

481.9k1](/packages/mrprompt-cielo)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
