README

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!

b230c7a8-8743-459f-bae5-541ea46a3533

Instalação

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

Hoje praticamente qualquer framework utiliza deste padrão, então você deve baixar 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

Se você quer simplesmente baixar e dar um include, também é muito simples. Primeiro baixe (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

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

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

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

O Banco Inter está disponibilizando uma API para emissão de boletos. O projeto ctodobom/APInter-PHP implementa funções para facilitar o acesso à essa API.

Integração com QuilhaSoft/JasperPHP

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 https://github.com/QuilhaSoft/JasperPHP-OpenBoleto

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

https://github.com/QuilhaSoft/OpenCnabPHP

Licença

MIT License

kriansa / openboleto

Maintainers

Details