sntaks/daraja-mpesa

这是一个用于Safaricom M-Pesa Daraja API的PHP软件包。

dev-main 2023-09-13 08:14 UTC

This package is auto-updated.

Last update: 2024-09-13 10:15:32 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

这是一个用于Safaricom M-Pesa Daraja API的PHP软件包。

安装次数

本项目支持composer依赖管理工具,也可以在不使用composer的情况下使用

使用Composer

  1. 运行以下命令
composer require sntaks/daraja-mpesa

不使用composer

  1. 下载已压缩的源代码

  2. 按照以下说明进行操作

<?php

use PP\Mpesa\Init as Mpesa;
  1. 查看以下使用示例 example/mpesa.php

配置

该库提供了一个基于您打算使用的API的配置文件。

要添加必要的配置:-

  1. 打开安装文件夹。

  2. 查找名为config/conf.php的文件

  3. 编辑必要的键,使其反映您使用的商品。

使用方法

<?php

use PP\Mpesa\Init as Mpesa;
$mpesa = new Mpesa();

try {

    // B2C Payment Request User Params
    $user_params = [
        'Amount' => 10,
        'PartyB' => 'xxx',
        'Remarks' => 'Test Business Payment'
    ];

    //Initiate B2C Payment Request
    $response = $mpesa->b2c($user_params);

    //Requests Account Balance
    $response = $mpesa->b2c_account_balance();
    $response = $mpesa->c2b_account_balance();

    // B2C Payment Transaction Status User Params
    $user_params = [
        'TransactionID' => 'xxxx'
    ];

    // B2C Payment Transaction Status Request
    $response = $mpesa->b2c_transaction_status($user_params);

    //C2B Register Endpoints
    $response_register = $mpesa->c2b();
}catch(\Exception $e){
    $response = json_decode($e->getMessage());
}

header('Content-Type: application/json');
echo json_encode($response);

支持

需要使用此软件包的支持: 在此处发送快速消息

支持的API

该库实现了以下Safaricom公开的所有端点:-

Lipa na M-Pesa Online Payment

    这是什么?

Lipa na M-Pesa Online Payment端点(STK推送)允许您从用户/客户请求支付。使用此端点,用户只需在提示下输入他们的M-PESA pin即可向您发送支付。

    如何实现?

在此处阅读文档.

Lipa na M-Pesa Online Query Request

    这是什么?

当您通过上述Lipa na M-Pesa Online端点从用户/客户请求支付时,您可能想了解该请求的状态。此端点提供了这种功能。它允许您查询任何STK推送的实时状态。

    如何实现?

在此处阅读文档.

C2B

    这是什么?

此端点允许开发者在客户向商户的Till号码或Paybill号码付款时接收实时通知。它假定付款是通过SIM卡工具包进行的,作为开发者,您需要知道付款何时到达商户的Till号码/ Paybill号码,以便进行对账和会计。

    如何实现?

在此处阅读文档.

B2C

    这是什么?

此端点允许商户从他们的Paybill账户向客户支付。一些用例包括但不限于支付工资、支付促销等。

    如何实现?

在此处阅读文档.

交易状态

    这是什么?

此端点允许开发者在B2B、B2C和C2B交易中启动状态检查。当交易中的一方失败/声称未收到交易确认时,这非常有用。

    如何实现?

在此处阅读文档.

账户余额

    这是什么?

此端点允许商户按需查询其Till/Paybill号码的账户余额。

    如何实现?

在此处阅读文档.

许可证

M-Pesa软件包是开源软件,许可协议为GNU许可证