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

ActiveLibrary

allanmcarvalho/php-boleto
=========================

Ferramenta para gerar boletos, emitir remessas e ler retornos

0.1.0(6y ago)6692↓100%3MITPHPPHP &gt;=7.1.0CI failing

Since Oct 2Pushed 6y ago1 watchersCompare

[ Source](https://github.com/allanmcarvalho/php-boleto)[ Packagist](https://packagist.org/packages/allanmcarvalho/php-boleto)[ Docs](https://github.com/allanmcarvalho/php-boleto)[ RSS](/packages/allanmcarvalho-php-boleto/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

Boleto PHP
==========

[](#boleto-php)

Ferramenta para gerar boletos, remessas e fazer leitura de retornos. Projeto iniciado em cima do fork de [newerton/yii2-boleto-remessa](https://github.com/newerton/yii2-boleto-remessa).

Agradecimentos a [Newerton](https://github.com/newerton) por todo o trabalho feito até o momento do fork.

Requerimentos
-------------

[](#requerimentos)

- [PHP Extensão Intl](http://php.net/manual/pt_BR/book.intl.php)
- [PHP Extensão Multibyte String (MbString)](https://www.php.net/manual/pt_BR/book.mbstring.php)
- [PHP &gt;=7.1.0](https://www.php.net/releases/7_1_0.php)

Links
-----

[](#links)

- [Documentação da API](http://newerton.github.io/yii2-boleto-remessa/)
- [Documentos Oficiais para gerar Boleto e Remessa](https://github.com/newerton/docs-boleto-remessa)

Bancos suportados
-----------------

[](#bancos-suportados)

BancoBoletoRemessa 400Remessa 240Retorno 400Retorno 240Banco do Brasil✅✅✅Bancoob (Sicoob)✅✅✅✴️✴️Banrisul✅✅✅Bradesco✅✅✅Caixa✅✅✅Hsbc✅✅✅Itau✅✅✅Santander✅✅✅✅✅Sicredi✅✅✅Banco do Nordeste✴️✴️**✴️ necessita de homologação**

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

[](#instalação)

Via composer:

```
composer require allanmcarvalho/php-boleto

```

Ou adicione manualmente ao seu composer.json:

```
"allanmcarvalho/php-boleto": "dev-master"

```

Gerar boleto
------------

[](#gerar-boleto)

### Criando o beneficiário ou pagador

[](#criando-o-beneficiário-ou-pagador)

```
$beneficiario = new \PhpBoleto\Pessoa([
    'nome' => 'ACME',
    'endereco' => 'Rua um, 123',
    'cep' => '99999-999',
    'uf' => 'UF',
    'cidade' => 'CIDADE',
    'documento' => '99.999.999/9999-99',
]);

$pagador = new \PhpBoleto\Pessoa([
    'nome' => 'Cliente',
    'endereco' => 'Rua um, 123',
    'bairro' => 'Bairro',
    'cep' => '99999-999',
    'uf' => 'UF',
    'cidade' => 'CIDADE',
    'documento' => '999.999.999-99',
]);
```

### Criando o objeto boleto

[](#criando-o-objeto-boleto)

#### Campos númericos e suas funções

[](#campos-númericos-e-suas-funções)

- **numero**: campo numérico utilizado para a criação do nosso numero. (identificação do título no banco)\*
- **numeroControle**: campo de livre utilização. até 25 caracteres. *(identificação do título na empresa)*
- **numeroDocumento**: campo utilizado para informar ao que o documento se referente *(duplicata, nf, np, ns, etc...)*

```
$boletoArray = [
	'logo' => 'path/para/o/logo', // Logo da empresa
	'dataVencimento' => new \Carbon\Carbon('1790-01-01'),
	'valor' => 100.00,
	'multa' => 10.00, // porcento
	'juros' => 2.00, // porcento ao mes
	'juros_apos' =>  1, // juros e multa após
	'diasProtesto' => false, // protestar após, se for necessário
	'numero' => 1,
	'numeroDocumento' => 1,
	'pagador' => $pagador, // Objeto PessoaContract
	'beneficiario' => $beneficiario, // Objeto PessoaContract
	'agencia' => 9999, // BB, Bradesco, CEF, HSBC, Itáu
	'agenciaDv' => 9, // se possuir
	'conta' => 99999, // BB, Bradesco, CEF, HSBC, Itáu, Santander
	'contaDv' => 9, // Bradesco, HSBC, Itáu
	'carteira' => 99, // BB, Bradesco, CEF, HSBC, Itáu, Santander
	'convenio' => 9999999, // BB
	'variacaoCarteira' => 99, // BB
	'range' => 99999, // HSBC
	'codigoCliente' => 99999, // Bradesco, CEF, Santander
	'ios' => 0, // Santander
	'descricaoDemonstrativo' => ['msg1', 'msg2', 'msg3'], // máximo de 5
	'instrucoes' =>  ['inst1', 'inst2'], // máximo de 5
	'aceite' => 1,
	'especieDoc' => 'DM',
];

$boleto = new \PhpBoleto\Boleto\Banco\Bb($boletoArray);
```

### Gerando o boleto

[](#gerando-o-boleto)

**Gerando o boleto a partir da instância do objeto (somente um boleto)**

```
$boleto->renderPDF();
// ou
$boleto->renderHTML();

// Os dois métodos aceitam como parâmetro dois booleanos.
// 1º Se True, após renderizado, irá mostrar a janela de impressão. O Valor default é false.
// 2º Se False, irá esconder as instruções de impressão. O valor default é true.
$boleto->renderPDF(true, false); // mostra a janela de impressão e esconde as instruções de impressão
```

```
/*
 * O comportamento padrão para os métodos renderPDF() e renderHTML() é retornar uma string pura.
 * Para gerar um retorno no controller do yii2, utilize da seguinte forma:
 */

// PDF
Yii::$app->response->format = \yii\web\Response::FORMAT_RAW;
$headers = Yii::$app->response->headers;
$headers->add('Content-Type', 'application/pdf');
$headers->add('Content-Disposition', 'nline; boleto.pdf');
return $boleto->renderPDF();

// HTML
return $boleto->renderHTML();
```

**Gerando boleto a partir da instância do render**

```
// Gerar em PDF
$pdf = new \PhpBoleto\Boleto\Render\Pdf();

$pdf->addBoleto($boleto);
// Ou, para adicionar um array de boletos
$pdf->addBoletos($boletos);

// Quando não informado parâmetros ele se comportará como Pdf::OUTPUT_STANDARD, enviando o buffer do pdf com os headers apropriados.
$pdf->gerarBoleto();

// Para mostrar a janela de impressão no load do PDF
$pdf->showPrint();

// Para remover as intruções de impressão
$pdf->hideInstrucoes();

// Para incluir Comprovante de entrega do boleto
$pdf->showComprovante();

// O método gerarBoleto() da classe PDF aceita como parâmetro:
//	1º destino: constante com os destinos disponíveis. Ex: Pdf::OUTPUT_SAVE.
//	2º path: caminho absoluto para salvar o pdf quando o destino for Pdf::OUTPUT_SAVE.
//Ex:
$pdf->gerarBoleto(Pdf::OUTPUT_SAVE, Yii::getAlias('@webroot/boletos/meu_boleto.pdf')); // salva o boleto na pasta.
$pdf_inline = $pdf->gerarBoleto(Pdf::OUTPUT_STRING); // retorna o boleto em formato string.
$pdf->gerarBoleto(Pdf::OUTPUT_DOWNLOAD); // força o download pelo navegador.

// Gerar em HTML
$html = new \PhpBoleto\Boleto\Render\Html();
$html->addBoleto($boleto);
// Ou para adicionar um array de boletos
$html->addBoletos($boletos);

// Para mostrar a janela de impressão no load da página
$html->showPrint();

// Para remover as intruções de impressão
$html->hideInstrucoes();

$html->gerarBoleto();
```

Gerar remessa
-------------

[](#gerar-remessa)

```
$remessaArray = [
	'agencia' => 9999,
	'agenciaDv' => 9, // se possuir
	'conta' => 99999,
	'contaDv' => 9, // se possuir
	'carteira' => 99,
	'convenio' => 9999999, // se possuir
	'range' => 99999, // se possuir
	'codigoCliente' => 99999, // se possuir
	'variacaoCarteira' => 99, // se possuir
	'beneficiario' => $beneficiario,
];

$remessa = new \PhpBoleto\Cnab\Remessa\Cnab400\Banco\Bb($remessaArray);

// Adicionar um boleto
$remessa->addBoleto($boleto);

// Ou para adicionar um array de boletos
$boletos = [];
$boletos[] = $boleto1;
$boletos[] = $boleto2;
$boletos[] = $boleto3;
$remessa->addBoletos($boletos);

echo $remessa->gerar();
```

Tratar retorno
--------------

[](#tratar-retorno)

```
$retorno = \PhpBoleto\Cnab\Retorno\Factory::make('full_path_arquivo_retorno');
$retorno->processar();
echo $retorno->getBancoNome();

// Retorno implementa \SeekableIterator, sendo assim, podemos utilizar o foreach da seguinte forma:
foreach($retorno as $registro) {
	var_dump($registro->toArray());
}

// Ou também podemos:
$detalheCollection = $retorno->getDetalhes();
foreach($detalheCollection as $detalhe) {
	var_dump($detalhe->toArray());
}

// Ou até mesmo do jeito laravel
$detalheCollection->each(function ($detalhe, $index) {
    var_dump($detalhe->toArray())
});
```

**Métodos disponíveis:**

```
$retorno->getDetalhes();

$retorno->getHeader();

$retorno->getTrailer();
```

###  Health Score

26

—

LowBetter than 46% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

2365d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2f933258a2b9bfecc0be13f8e6786c5c937e288fed34fea37054563da4bf02e8?d=identicon)[allanivp](/maintainers/allanivp)

---

Top Contributors

[![allanmcarvalho](https://avatars.githubusercontent.com/u/12012197?v=4)](https://github.com/allanmcarvalho "allanmcarvalho (8 commits)")

---

Tags

phpcakephpallanmcarvalho

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[atgp/factur-x

PHP library to manage your Factur-X / ZUGFeRD 2.0 PDF invoices files

137802.5k3](/packages/atgp-factur-x)[fotografde/cakephp-sms

SMS Plugin for CakePHP

1273.2k](/packages/fotografde-cakephp-sms)[cakedc/cakephp-phppm

PHP PM bridge for CakePHP

221.6k](/packages/cakedc-cakephp-phppm)

PHPackages © 2026

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