kriansa / openboleto
银行汇票生成库。
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2024-09-12 19:22:23 UTC
README
OpenBoleto是一个用于生成银行汇票的开源代码库,是巴西非常常见的一种支付方式。其重点在于简单易用,并具备与PHP最新功能相兼容的架构。
如果您通过这个项目获得了一些帮助,您可以通过财务捐赠来支持我继续开发开源项目。捐赠可以是
帮助项目继续发展,通过PIX进行捐赠!
b230c7a8-8743-459f-bae5-541ea46a3533
安装
Composer
如果您已经熟悉Composer(强烈推荐),只需将以下依赖项添加到您的composer.json文件中的"require"指令即可
"openboleto/openboleto": "dev-master"
PSR-0自动加载器
如今,几乎所有的框架都使用这个标准,因此您应该下载OpenBoleto,将其放入特定的文件夹(通常是lib或vendor),并在您的框架文档中查找如何让自动加载器将OpenBoleto的命名空间指向OpenBoleto的src文件夹。
独立库
如果您只想下载并包含,这也很简单。首先下载(或克隆)并放入特定文件夹,然后在autoloader.php文件中包含它!
生成汇票
这是最好的部分。操作非常简单,以下是一个基本示例
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();
如何获取QrCode Pix
Pix的默认使用方式不能用于汇票,银行提供一项服务,您可以将注册的汇票传递并请求Pix,银行会返回一个字符串,其中包含识别汇票的Pix,以便在通过Pix进行支付时,有汇票的参考以便下载。
是的,就是这样!请记住,每个银行都有自己的特性,但通常这些参数是必须的。在samples文件夹中有一个每个银行的示例,您可以查看哪些是每个银行的必需参数。
支持的银行
目前OpenBoleto可以与以下银行一起使用
Inter银行API
Inter银行正在提供一项用于汇票发行的API。项目ctodobom/APInter-PHP实现了简化API访问的功能。
与QuilhaSoft/JasperPHP集成
QuilhaSoft/JasperPHP是一个纯PHP库,可以直接在PDF格式中生成汇票,无需将HTML转换为PDF,汇票的布局可以使用JasperSoft Studio进行编辑。
要查看示例,请打开https://github.com/QuilhaSoft/JasperPHP-OpenBoleto
欢迎任何贡献。如果您想将OpenBoleto适配到其他银行,请随时探索代码,看看如何将任何银行集成到库中是多么简单。
发送和返回
https://github.com/QuilhaSoft/OpenCnabPHP
许可证
- MIT许可证