kryptonpay / openboleto

银行汇票生成库。

2.0 2022-06-20 20:52 UTC

This package is not auto-updated.

Last update: 2024-09-17 01:01:33 UTC


README

OpenBoleto 是一个用于生成银行汇票的开源代码库,这是在巴西非常常见的支付方式。其重点在于简单易用,并且具有与 PHP 最现代功能兼容的架构。

帮助项目继续发展,请进行捐赠!

Pague com PagSeguro - é rápido, grátis e seguro!

安装

Composer

如果您已经熟悉 Composer(强烈推荐),只需将以下依赖项添加到您的 composer.json 文件中的 "require" 指令即可。

"openboleto/openboleto": "dev-master"

PSR-0 自动加载器

如今,几乎所有框架都使用此标准,因此您应该 下载 OpenBoleto,将其放入特定文件夹(通常为 libvendor),然后查阅您框架的文档,以便让您的自动加载器将 OpenBoleto 命名空间指向 OpenBoleto 的 src 文件夹。

独立库

如果您只是想下载并包含,这也很简单。首先 下载(或从存储库克隆),然后将其放入特定文件夹。接着,包含 autoloader.php 文件,Voilà!

生成汇票

这是最有趣的部分。这太过简单了,看看以下基本示例

use OpenBoleto\Banco\BancoDoBrasil;
use OpenBoleto\Agente;

$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
));

echo $boleto->getOutput();

是的,就这么简单!请注意,每个银行都有自己的特定之处,但通常以下参数是必需的。在 samples 文件夹中,存在每个银行的完整示例,您可以查看哪些是每个银行必需的参数。

支持的银行

目前 OpenBoleto 与以下银行兼容

Inter 银行 API

Inter 银行正在提供用于汇票生成的 API。项目 ctodobom/APInter-PHP 实现了方便访问该 API 的功能。

与 QuilhaSoft/JasperPHP 的集成

QuilhaSoft/JasperPHP 是一个纯 PHP 库,可以生成 PDF 格式的汇票,而不进行 HTML 转换,汇票布局可以使用 JasperSoft Studio 进行编辑。

要查看示例,请打开 https://github.com/QuilhaSoft/JasperPHP-OpenBoleto

欢迎所有贡献。如果您希望将 OpenBoleto 适配到其他银行,请自由探索代码,了解如何轻松地将任何银行集成到库中。

付款和返回

https://github.com/QuilhaSoft/OpenCnabPHP

许可证

  • MIT 许可证