PHPackages                             umbrella/boleto - 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. umbrella/boleto

ActiveLibrary[Utility & Helpers](/categories/utility)

umbrella/boleto
===============

YaBoleto é uma biblioteca para geração de boletos bancários de forma simples em PHP.

v1.8.0(8y ago)3431.2k11[2 issues](https://github.com/umbrellaTech/ya-boleto-php/issues)[1 PRs](https://github.com/umbrellaTech/ya-boleto-php/pulls)MITPHPPHP >=5.3

Since Nov 11Pushed 7y ago8 watchersCompare

[ Source](https://github.com/umbrellaTech/ya-boleto-php)[ Packagist](https://packagist.org/packages/umbrella/boleto)[ Docs](http://umbrellatech.com/boleto)[ RSS](/packages/umbrella-boleto/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (2)Versions (26)Used By (0)

Yet Another Boleto
==================

[](#yet-another-boleto)

[![Build Status](https://camo.githubusercontent.com/6377d4b37301be8e53de47a20b338c08273ce2e43b7f2ad891f2df3373ea7a0d/68747470733a2f2f7472617669732d63692e6f72672f756d6272656c6c61546563682f79612d626f6c65746f2d7068702e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/umbrellaTech/ya-boleto-php)[![Codacy Badge](https://camo.githubusercontent.com/41033d9506756bf567994d5a37c0b19cf342382713bcc5d84daffc6d7924d67f/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3931376234626266323965613461366139303938373361616135613934333030)](https://www.codacy.com/app/italolelis/ya-boleto-php?utm_source=github.com&utm_medium=referral&utm_content=umbrellaTech/ya-boleto-php&utm_campaign=Badge_Grade)[![Code Coverage](https://camo.githubusercontent.com/7c585944b1185c581cb68521fba0779ac4902283ad949df6732f89c23679e227/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f756d6272656c6c61546563682f79612d626f6c65746f2d7068702f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/umbrellaTech/ya-boleto-php/?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/dc5d122801218f9b5c4f06d58d8a339d11640f180e0a3c09768b0c603b65cbd9/68747470733a2f2f706f7365722e707567782e6f72672f756d6272656c6c612f626f6c65746f2f762f737461626c652e706e67)](https://packagist.org/packages/umbrella/boleto)[![Latest Unstable Version](https://camo.githubusercontent.com/ba33faa7bef37c410cd2a4009dcc621700121cf6701d59eb0a9f45c7485f0b6d/68747470733a2f2f706f7365722e707567782e6f72672f756d6272656c6c612f626f6c65746f2f762f756e737461626c652e706e67)](https://packagist.org/packages/umbrella/boleto)

O YaBoleto e um novo componete de boleto bancario em PHP, mas qual a diferença dos outros? Simples... Ele foi projetado de forma simples e Orientada a Objetos. Seguimos os padrões PSR-0, PSR-1 e PSR-2, utilizamos padrões de projetos onde seria necessário e Voilà. O YaBoleto vai mudar a forma de como você trabalha com boletos bancários.

Quer utilizar o YaBoleto? Leia nossa [documentaçao](https://github.com/umbrellaTech/ya-boleto-php/docs) e veja como é simples.

Instalação
----------

[](#instalação)

### Composer

[](#composer)

Se você já conhece o **Composer** (o que é extremamente recomendado), simplesmente adicione a dependência abaixo à diretiva *"require"* no seu **composer.json**:

```
$ composer require umbrella/boleto
```

Sim, só isso! Lembre-se de que cada banco possui alguma particularidade, mas em geral são estes parâmetros os obrigatórios.

O projeto [umbrellaTech/demo](https://github.com/umbrellaTech/ya-boleto-demo) possui 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 YaBoleto funciona com os bancos abaixo:

**Banco****Carteira/Convenio****Implementado****Testado****Banco do Brasil**17, 18, 21SimSim**Banrisul**xNãoNão**Bradesco**06, 03SimSim**Caixa Economica**SRSimSim**HSBC**CNR, CSBNãoNao**Itau**157NãoNão**Itau**175, 174, 178, 104, 109NãoNão**Real**57SimSim**Santander**101, 102, 201SimSim**BANESE**CESimSim**SICOOB**01SimSimUso
---

[](#uso)

A forma mais simples é utilizar o Builder.

```
use Umbrella\YaBoleto\Builder\BoletoBuilder;
use Umbrella\YaBoleto\Endereco;
use Umbrella\YaBoleto\Cnpj;
use Umbrella\YaBoleto\Cpf;

// sacado...
$nomeSacado      = "John Doe";
$documentoSacado = new Cpf("090.076.684-04");
$enderecoSacado = new Endereco(
    "Setor de Clubes Esportivos Sul (SCES) - Trecho 2 - Conjunto 31 - Lotes 1A/1B",
    "70200-002",
    "Brasília",
    "DF"
);

// cedente...
$nomeCedente      = "ACME Corporation Inc.";
$documentoCedente = new Cnpj("01.122.241/0001-76");
$enderecoCedente = new Endereco(
    "Setor de Clubes Esportivos Sul (SCES) - Trecho 2 - Conjunto 31 - Lotes 1A/1B",
    "70200-002",
    "Brasília",
    "DF"
);

$builder = new BoletoBuilder(BoletoBuilder::BRADESCO);

$boleto  = $builder->sacado(BoletoBuilder::PESSOA_FISICA, $nomeSacado, $documentoSacado, $enderecoSacado)
                   ->cedente($nomeCedente, $documentoCedente, $enderecoCedente)
                   ->banco("0564", "0101888")
                   ->carteira("06")
                   ->convenio("0101888", "77000009017")
                   ->build(250, "77000009017", new \DateTime("2015-03-24"));

echo $boleto->getLinhaDigitavel() // 23790.56407 67700.000903 17010.188807 8 63770000025000
```

A forma Orientada a Objetos é um pouco mais trabalhossa, mas permite maior flexibilidade.

```
use Umbrella\YaBoleto\Bancos\Bradesco\Convenio;
use Umbrella\YaBoleto\Bancos\Bradesco\Bradesco;
use Umbrella\YaBoleto\Bancos\Bradesco\Carteira\Carteira06;
use Umbrella\YaBoleto\Bancos\Bradesco\Boleto\Bradesco as BoletoBradesco;

use Umbrella\YaBoleto\PessoaFisica;
use Umbrella\YaBoleto\Cedente;
use Umbrella\YaBoleto\Sacado;
use Umbrella\YaBoleto\Cnpj;
use Umbrella\YaBoleto\Cpf;

// sacado...
$nomeSacado      = "John Doe";
$documentoSacado = new Cpf("090.076.684-04");
$enderecoSacado = new Endereco(
    "Setor de Clubes Esportivos Sul (SCES) - Trecho 2 - Conjunto 31 - Lotes 1A/1B",
    "70200-002",
    "Brasília",
    "DF"
);

// cedente...
$nomeCedente      = "ACME Corporation Inc.";
$documentoCedente = new Cnpj("01.122.241/0001-76");
$enderecoCedente = new Endereco(
    "Setor de Clubes Esportivos Sul (SCES) - Trecho 2 - Conjunto 31 - Lotes 1A/1B",
    "70200-002",
    "Brasília",
    "DF"
);

$banco        = new Bradesco("0564", "0101888");
$carteira     = new Carteira06();

$convenio     = new Convenio($banco, $carteira, "0101888", "77000009017");
$pessoaFisica = new PessoaFisica($nomeSacado, $documentoSacado, $enderecoSacado);
$sacado       = new Sacado($pessoaFisica);
$cedente      = new Cedente($nomeCedente, $documentoCedente, $enderecoCedente);

$boleto       = new BoletoBradesco($sacado, $cedente, $convenio);

$boleto
    ->setValorDocumento(50)
    ->setNumeroDocumento(2)
    ->setDataVencimento(new \DateTime('2014-09-02'))
    ->gerarCodigoBarraLinhaDigitavel();

echo $boleto->getLinhaDigitavel() // 23790.56407 67700.000903 17010.188807 8 63770000025000
```

Contribua
---------

[](#contribua)

Toda contribuição é bem vinda. Se você deseja adaptar o YaBoleto a algum outro banco, fique à vontade para explorar o código, veja como é bastante simples integrar qualquer banco à biblioteca. Para instalar clone o projeto dentro da pasta **Umbrella/YaBoleto**.

```
git clone https://github.com/umbrellaTech/ya-boleto-php.git ya-boleto-php/Umbrella/YaBoleto

```

Ou usando o composer.

```
php composer.phar create-project umbrella/boleto ya-boleto-php/Umbrella/YaBoleto dev-master

```

Isso se deve por conta do autoloader que segue a [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4.md).

Demo
----

[](#demo)

A aplicação de demonstração está no repositório [YaBoleto Demo](https://github.com/umbrellaTech/ya-boleto-demo)

Licença
-------

[](#licença)

- MIT License

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 73.2% 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 ~77 days

Recently: every ~64 days

Total

22

Last Release

2940d ago

### Community

Maintainers

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

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

---

Top Contributors

[![italolelis](https://avatars.githubusercontent.com/u/1108049?v=4)](https://github.com/italolelis "italolelis (60 commits)")[![AyrtonRicardo](https://avatars.githubusercontent.com/u/3937889?v=4)](https://github.com/AyrtonRicardo "AyrtonRicardo (12 commits)")[![mikhailcavalcanti](https://avatars.githubusercontent.com/u/5747855?v=4)](https://github.com/mikhailcavalcanti "mikhailcavalcanti (4 commits)")[![isaachbn](https://avatars.githubusercontent.com/u/3923258?v=4)](https://github.com/isaachbn "isaachbn (2 commits)")[![KennedyTedesco](https://avatars.githubusercontent.com/u/999232?v=4)](https://github.com/KennedyTedesco "KennedyTedesco (2 commits)")[![genison](https://avatars.githubusercontent.com/u/643166?v=4)](https://github.com/genison "genison (1 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/umbrella-boleto/health.svg)

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

PHPackages © 2026

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