README

肯尼亚合作银行直观PHP SDK API

先决条件

创建应用程序

在 https://developer.co-opbank.co.ke:9443/store/ 上创建或登录您的账户

在左侧面板中，您可以看到菜单列表。点击“应用程序”以访问可用应用程序列表，您可以选择使用默认应用程序或创建自己的应用程序。

订阅API

• 选择应用程序或使用前面的步骤创建自己的应用程序。
• 点击“订阅”。将出现一个弹出消息，如下所示

生成密钥

• 在左侧面板中点击“应用程序”。
• 选择您想生成密钥的应用程序
• 从选项卡中选择适当的环境（生产或沙盒）。
• 指定回调URL，然后点击“生成密钥”。其他字段保留默认值；

安装

通过在终端中输入以下命令使用composer安装

composer require osenco/co-op

如果您不使用composer，您可以直接从发行版中下载此库，将其解压缩到您的项目中，并在您的项目中包含autoload.php文件。

require_once('path/to/autoload.php');

设置

使用coopSetup辅助函数配置和实例化我们的对象

    $config = array(
        "env"                 => "sandbox",
        "consumerKey"         => "ss0sD2ANhjvhx_rHU0a6Xf8ROdYa",
        "consumerSecret"      => "zOfReXCIwn1TfnEYJJJGNP6l3Tka",
        "accountNumber"       => "54321987654321",
        "bankCode"            => "011",
        "branchCode"          => "00011001",
        "callbackURL"         => "/coop/callback",
        "transactionCurrency" => "KES",
    );
    coopSetup($config);

用法

我们建议使用以下辅助函数

检查账户余额

账户余额查询API将允许您查询指定账户号的账户当前余额

    $response = coopAccountBalance(
        $messageReference, 
        $accountNumber = null, 
        $callback = null
    );

检查账户交易

账户交易查询API将允许您查询指定账户号的最新交易以及要返回的交易数量

    $response = coopAccountTransactions(
        $messageReference, 
        $accountNumber, 
        $NoOfTransactions = '1', 
        $callback = null
    );

获取汇率

汇率查询API将允许您查询指定货币的当前即期汇率

    $response = coopExchangeRate(
        $messageReference, 
        $fromCurrencyCode = 'KES', 
        $toCurrencyCode = 'USD', 
        $callback = null
    );

内部账户间转账

内部资金转账账户到账户API将允许您将您的合作银行账户中的资金转账到其他合作银行账户

    $response = coopIFTAccountToAccount(
        $messageReference, 
        $accountNumber, 
        $amount, 
        $transactionCurrency = 'KES', 
        $narration = 'Payment', 
        $destinations = array(), 
        $callback = null
    );

PesaLink 发送到账户

PesaLink 发送到账户资金转账API将允许您将您的合作银行账户中的资金转账到IPSL参与银行的银行账户

    $response = coopPesaLinkSendToAccount(
        $messageReference, 
        $accountNumber, 
        $amount, 
        $transactionCurrency = 'KES', 
        $narration = 'Payment', 
        $destinations = array(), 
        $callback = null
    );

检查交易状态

这是一个交易状态查询请求接口，由API消费者调用APIM以查询先前请求的交易状态。

    $response = coopTransactionStatus(
        $messageReference, 
        $callback = null
    );

回调函数

上述函数的最后一个可选参数（$callback）允许您添加一个可调用的函数来处理API响应。您可以传递一个已定义的函数或闭包

使用已定义的函数

    function processCoopTransactionStatus($response) {
        // Do something with $response
    }
    $response = coopTransactionStatus($messageReference, 'processCoopTransactionStatus');

使用闭包

    $response = coopTransactionStatus($messageReference, function ($response) {
        // Do something with $response
    });

回调URL和数据核对

在您的回调URL端点使用coopReconcile()辅助函数处理API响应，可选地传递一个可调用的函数来处理API响应。您可以传递一个已定义的函数或闭包

使用已定义的函数

    function processCoopTransactionStatusResponse($response) {
        // Do something with $response
    }
    $response = coopReconcile('processCoopTransactionStatusResponse');

使用闭包

    $response = coopReconcile(function ($response) {
        // Do something with $response
    });

测试用例

作为开发者，当您创建沙盒应用程序时，测试用例将可供您下载。

测试用例旨在确保您已充分理解我们不同API的请求和响应结构。这些测试用例在一个电子表格中，您应填写每个测试场景的结果，这些场景是您想要使用的。

由于测试用例将涵盖所有可用的API，您只需对最初选择的API执行测试用例即可。

上线

一旦您已经在我们的平台上尝试了API，并针对我们提供的测试用例进行了测试，您就可以正式申请上线。

您需要将测试用例填写完整，然后发送一封包含这些填写完整的测试用例的电子邮件请求给我们的支持团队，他们将指导您进行下一步操作，以便您上线。

请将电子邮件请求和测试用例发送至 digitalbanking@co-opbank.co.ke