README

Jengahq 是 Equity 的 Jenga API V2 对 Laravel 的包装。

注意： 此软件包仍在积极开发中。要开始贡献，请参阅贡献。

安装 Jengahq

推荐通过 Composer 安装 Jengahq。

composer require ammly/jengahq

如果您尚未安装，请参阅 Composer 安装说明。

需求

此软件包需要以下内容

"php": ">=5.5.0",
"guzzlehttp/guzzle": "~6.0"

设置

在 JengaHq 上注册账户并获得凭证

遵循官方文档指引以生成 SSL 密钥并将您的公钥上传到账户的 API 密钥部分。

将密钥存储在您的 Laravel 项目 storage 文件夹中。

配置

在您的 .env 文件中填写以下配置。

JENGA_USERNAME=
JENGA_PASSWORD=
JENGA_API_KEY=
JENGA_PHONE=
JENGA_BASE_ENDPOINT=https://uat.jengahq.io

用法

将软件包包含到您的文件中

<?php 

use Ammly\Jengahq\Jengahq;

然后您可以创建一个新的实例并发送您的请求。

$jengahq = new Jengahq;
$jengahq->sendMoney($params);

或使用 Jengahq Facade

Jenga::sendMoney($params);

生成 Token

使用 $jengahq->authenticate() 生成一个将被发送为每个请求的 Authorization 标头的令牌。此操作由本软件包中的所有操作自动执行。

账户余额

使用 $jengahq->accountBalance() 检查账户余额。

示例

<?php 

use Ammly\Jengahq\Jengahq;

$params = [
    'account_id' => 1100161816677,
    'country_code' => 'KE',
    'date' => date('Y-m-d'),
];

$jenga = new Jengahq;
$jenga->accountBalance($params);

发送货币

使用 $jengahq->sendMoney() 通过 Pesalink 或 InternalFundsTransfer 为内部 Equity 账户发送货币。

示例

<?php 

use Ammly\Jengahq\Jengahq;

$params = [
    'country_code' => 'KE',
    'date' => date('Y-m-d'),
    'source_name' => 'John Doe',
    'source_accountNumber' => '0001092883',
    'destination_name' => 'Jane Doe',
    'destination_mobileNumber' => '25474738846',
    'destination_bankCode' => 63,
    'destination_accountNumber' => '9200002773',
    'transfer_currencyCode' => 'KES',
    'transfer_amount' => '10',
    'transfer_type' => 'PesaLink', //Or InternalFundsTransfer
    'transfer_reference' => '127364836548',
    'transfer_description' => 'Some description',
];

$jenga = new Jengahq;
$jenga->sendMoney($params);

IPRS 搜索

使用 $jenga->iprsSearch($params) 执行 IPRS 搜索。

示例

<?php 

use Ammly\Jengahq\Jengahq;
$params = [
    'country_code' => 'KE',
    'account_id' => '1100161816677';
    'document_type' => 'ID'; // Or Passport
    'first_name' => 'John';
    'last_name' => 'Doe';
    'document_number' => '28663883';
];

$jenga = new Jengahq;
$jenga->iprsSearch($params);

帮助和文档

变更日志

请参阅变更日志了解最近发生了什么更改。

测试

$ composer test

贡献

请参阅 contributing.md 了解详细信息和工作清单。

安全

如果您发现任何安全相关的问题，请通过电子邮件 ammlyf@gmail.com 而不是使用问题跟踪器。

致谢

许可

MIT。请参阅许可文件了解更多信息。

ammly / jengahq

维护者

详细信息