README

此项目是为了封装bankstatements.com.au的json端点而创建的，目的是使与您的银行账户/报表的接口更加容易。

安装

此项目可以通过composer安装

$ composer require gl3nda85/bank-statements-wrapper

基本用法

### 登录并检索账户信息

要使用此API，您必须联系bankstatements.com.au并从他们那里购买一个API密钥。

要创建bankstatement API的实例，您必须使用以下函数调用它。布尔值是第二个参数，用于指定是否连接到他们的实时服务器或测试服务器。下面连接到测试服务器，将其设置为false或无以连接到实时服务器。

$bankStatement = new BankStatement('YOUR_API_KEY', true);

要登录，您必须将登录类的实例传递给上述bankStatement对象。这必须包含银行的slug，例如，澳大利亚联邦银行是cba，客户端编号/用户名，以及密码。

$loginCreds = new Login('bank_of_statements', '12345678', 'TestMyMoney');
$loginResponse = $bankStatement->login($loginCreds);

上面的响应包含两个东西：一个账户数组和一个访问令牌，您必须将其本地存储以进一步使用此API。

$userToken = $loginResponse['userToken'];
$accountCollection = $loginResponse['accounts'];

账户集合是所有账户的集合，要获取堆栈中的第一个账户，您可以调用

$firstAccount = $accountCollection->first();

使用此第一个账户对象，您可以执行许多任务，例如获取账户号码、bsb、当前余额和账户持有人。

$accountBalance = $firstAccount->getBalance(); // $52.80
$accountBSB = $firstAccount->getBsb(); // 063-997
$accountNumber = $firstAccount->getAccountNumber(); // 1015 8077
$accountName = $firstAccount->getName(); // Main Account
$accountType = $firstAccount->getAccountType(); // Savings

要注销并结束会话，将您的userToken传递给注销对象，此函数将返回true表示成功注销。

$bankStatement->logout(new Logout($userToken));

### 检索报表数据

登录后，您可以以下方式检索每个账户的报表数据。

首先收集您想要获取报表数据的账户ID。其次，使用账户的bank slug创建一个新的StatementDataRequest。最后，调用getStatementData，传入登录用户会话中的userToken和报表请求。

$accountIds = array($firstAccount->getId(), $secondAccount->getId);

$statementRequest = new StatementDataRequest($firstAccount->getSlug(), $accountIds);

$statements = $bank->getStatementData($userToken, $statementRequest);

StatementDataRequest有高级选项可供使用，例如报表的天数和创建原始文件。

$statementRequest->setRequestNumDays(90);

阅读完整的API文档以获取更多信息。

从调用上面的statement函数，您将获得每个输入账户ID的报表数据集合。要获取第一个账户的交易列表，请使用以下函数

$transactions = $statements->first()->getTransactionCollection()->all();

获取日终余额

$endofDayBalance = $statements->first()->getDayEndBalanceCollection()->all();

Bankstatements.com.au扫描您的银行报表并将交易分类到多个集合中

他们有

$incomeCollection;
$benefitCollection;
$dishonourColection;
$loanCollection;
$gamblingCollection;
$otherDebtsCollection;

要调用这些数据集之一，请使用此类函数

$otherDebtsCollecton = $statements->first()->getOtherDebtsCollection()->all();

贡献

Dylan Aird

历史记录

16/01/2017 版本 1.0

致谢

Dylan Aird

许可证

Bankstatements API在MIT许可证下发布。有关详细信息，请参阅捆绑的LICENSE文件。