README

访问 Bankly API 的非官方 PHP 类。

API 文档在此。

JavaScript 版本在此。

使用方法

身份验证和令牌刷新由类本身处理。

首先包含类，并创建一个实例，提供由 Acesso 提供的 client_id 和 client_secret。

composer require jesobreira/bankly

use BanklyPHP\Bankly;
use BanklyPHP\BankAccount;

$bankly = new Bankly('client_id', 'client_secret');

获取账户余额

提供分行和账户号码（不带连字符）以获取余额。

$bankly->getBalance('0001', '1234');

此方法返回一个 JSON 对象。

获取账户对账单

提供

• 分行（字符串）
• 账户号码（字符串）
• 偏移量（数字，从 0 开始）
• 限制（数字，> 0）
• 详细信息（可选，布尔值，默认为 true）
• DetailsLevelBasic（可选，布尔值，默认为 true）

$bankly->getStatement('0001', '1234', 0, 10);

此方法返回一个 JSON 对象。

获取账户事件

提供

• 分行（字符串）
• 账户号码（字符串）
• 页码（数字，从 1 开始）
• 页面大小（数字，> 0）
• IncludeDetails（可选，布尔值，默认为 true）

$bankly->getEvents('0001', '1234', 1, 10);

此方法返回一个 JSON 对象。

执行转账

注意：此方法会导致实际金钱的扣除。

为了指定来源和目的银行账户，您必须创建两个 BankAccount 对象。

创建银行账户实例时必须接收一个具有以下属性的对象

• branch（字符串）：账户分行
• account（字符串）：账户号码（不带连字符）
• document（字符串）：账户持有人的 CPF 或 CNPJ（仅数字）
• name（字符串）：账户持有人姓名
• bankCode（字符串，可选）：银行代码（见下文，默认为 Acesso 的 332）

然后您将使用 transfer() 方法执行实际转账，提供

• 金额（分，1 BRL = 100 分）
• 参考或描述（可读字符串）
• 发送者（一个 BankAccount 对象）
• 接收者（一个 BankAccount 对象）

示例

$from = new BankAccount;
$from->branch = '0001';
$from->account = '1234';
$from->document = '00000000000000';
$from->name = 'Company LTDA';

$to = new BankAccount;
$to->bankCode = '123';
$to->branch = '1234';
$to->account = '12345';
$to->document = '00000000000';
$to->name = 'John Doe';

// transfer BRL 5 (R$ 5)
$bankly->transfer(500, 'test', $from, $to);

此方法返回一个 对象。此对象包含一个 "authenticationCode" 属性，其中包含一个字符串，该字符串是事务的参考代码，您以后将使用该代码检查其状态。

获取转账状态

使用以下方法检索事务的状态。您需要提供

• 来源分行
• 来源账户号码
• AuthenticationId（您从 transfer 方法中接收的 authenticationCode）

$bankly->getTransferStatus('0001', '1234', 'AuthenticationId');

此方法返回一个 JSON 对象。

获取银行列表

您可以从巴西中央银行（Bacen）获取银行和支付机构的列表及其相应的代码。不需要身份验证。您可以从实例调用此获取器

$banks = bankly->bankList;

或直接使用此静态方法（无需创建类实例）

$banks = Bankly::bankList();

这返回一个 JSON 数组。您还可以通过在浏览器中点击此处来执行此请求。

调试

您可以为类实例定义一个函数，该函数接收调试日志（作为字符串）。

$bankly.debug = function ($msg) {
	echo $msg . "\r\n";
};