fredroo / openboleto
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2024-06-12 18:45:29 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 与以下银行兼容
银行 | HTML 状态 | JasperPHP(PDF) 状态 |
---|---|---|
巴西银行 (BRB) | Beta | Beta |
巴西银行 | Homologated | Homologated |
巴西东北银行 | Beta | Beta |
Banese | Beta | Beta |
布拉德斯科 | Homologated | Homologated |
Caixa (SIGCB) | Beta | Homologated |
Cecred | Beta | Beta |
HSBC | Beta | Beta |
伊塔乌 | Beta | Homologated |
桑坦德 | Beta | Beta |
Sicoob | Beta | Beta |
Unicred | Homologated | Beta |
Viacredi | Beta | Beta |
Sicredi | Beta | Beta |
Bankrisul | Beta | Beta |
C6 Bank | Homologated | Homologated |
ABC | Homologated | Homologated |
BV | -- | BETA |
Inter 银行 API
Inter 银行正在提供用于汇票发行的 API。项目 ctodobom/APInter-PHP 实现了便于访问此 API 的功能。
与 QuilhaSoft/JasperPHP 集成
QuilhaSoft/JasperPHP 是一个纯 PHP 库,可以不转换 HTML 生成 PDF 格式的汇票,汇票布局可以使用 JasperSoft Studio 进行编辑。
要查看功能演示,请打开以下示例:https://github.com/QuilhaSoft/JasperPHP-OpenBoleto
所有贡献都受欢迎。如果您想将OpenBoleto适配到其他银行,请随意探索代码,看看如何非常简单地集成任何银行到库中。
发送和返回
https://github.com/QuilhaSoft/OpenCnabPHP
许可证
- MIT许可证