README

okra-php 是一个用于 Okra 核心产品的 PHP 库。

安装

使用包管理器 composer 安装 okra-php。

composer require horlarmeday/okra-php

用法

okra-php 提供了对 Auth、Balance、Identity、Income 和 Transactions 等Okra核心产品的简单访问。要开始使用，你需要实例化 Okra 类，并传递你的访问令牌。所有方法都以数组形式返回响应。

$okra = new Okra(ACCESS_TOKEN);

1. Auth

Okra 为客户提供了一条成功验证银行账户的路径。客户通过小部件输入他们的凭据，并立即进行身份验证。

i. 获取所有 auth

此操作检索所有 auth 信息，包括与记录当前、储蓄和住宅账户关联的银行账户和路由号。

可选地传递布尔值 true 以获取 .pdf 格式

$okra->getAllAuth();

ii. 通过 ID 获取 auth

此操作通过 ID 检索 auth 信息。

$okra->getAuthById();

iii. 通过客户获取 auth

此操作通过客户 ID 检索 auth 信息。

$okra->getAuthByCustomer();

iv. 通过日期范围获取 auth

此操作通过传递日期范围检索 auth 信息。此方法期望四个（4）参数：startDate（开始日期）、endDate（结束日期）、page（页面）和 limit（限制）。然而，前两个是必需的，而最后两个是可选的。page 表示你希望返回的页面编号，而 limit 是要返回的记录数。

$okra->getAuthByDateRange('2020-05-13', '2020-05-20', 1, 20);

vi. 通过银行 ID 获取 auth

此操作通过银行 ID 检索 auth 信息。此方法期望三个（3）参数：bank_id（银行 ID）、page（页面）和 limit（限制）。然而，page 和 limit 是可选的。

$okra->getAuthByBank();

vi. 通过客户 ID 和日期获取 auth

此操作通过客户 ID 和日期范围检索 auth 信息。customer_id（客户 ID）、startDate（开始日期）和 endDate（结束日期）是必需的。

$okra->getAuthByCustomerDate();

联系方式

Mahmud Ajao - @MahmudAjao1 - ajaomahmud@gmail.com

贡献

欢迎拉取请求。对于重大更改，请先创建一个问题来讨论你想要进行的更改。

请确保根据需要更新测试。

许可证

MIT

horlarmeday / okra-php

维护者

详细信息