softcomtecnologia/openboleto

用于生成银行汇票的库。

v1.0 2013-08-04 20:53 UTC

This package is auto-updated.

Last update: 2024-09-11 17:18:35 UTC


README

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

如果这个项目以某种方式帮助了您,您可以财务上支持我,以便我继续开发开源项目。贡献可以是

帮助项目继续发展,通过PIX进行捐赠!

b230c7a8-8743-459f-bae5-541ea46a3533

302100763-dc530122-d9fb-41e4-9edf-dc9c32e74adc

安装

Composer

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

"openboleto/openboleto": "dev-master"

PSR-0 自动加载器

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

独立库

如果您只想下载并包含它,这也非常简单。首先 下载(或克隆)并放置在特定文件夹中。然后,包含 autoloader.php 文件,voilà!

生成汇票

这是最精彩的部分。它不能再简单了,看看以下基本示例

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与以下银行兼容

API Banco Inter

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许可证