kabangi/mpesa

M-Pesa API implementation

M-PESA API Package

, _(*1)

This is a PHP package for the Safaricom's M-Pesa REST API dubbed DARAJA API., _(*2)

If you are looking for a laravel implementation do check the following repo Laravel Implementation, _(*3)

Installation

This project supports both composer dependency management tool and can also be used without composer, _(*4)

Using Composer

1. Run the following command

composer require kabangi/mpesa

Without composer

1. Download the source code as zipped, _(*5)

2. Follow the following directions, _(*6)

<?php
require "{PATHTOTHISLIBFOLDER}/src/autoload.php";

use Kabangi\Mpesa\Init as Mpesa;

1. Check the following example for usage https://github.com/Kabangi/mpesa/blob/master/example/mpesa.php

Configuration

The library comes with a structured config file based on the API that you intend to use., _(*7)

To add the necessary configurations:- 1. Open the folder installation., _(*8)

1. Look for a file named config/mpesa.php, _(*9)

2. Edit the necessary keys that reflects the product you are using., _(*10)

Usage

<?php
require "../src/autoload.php";

use Kabangi\Mpesa\Init as Mpesa;

// You can also pass your own config here.
// Check the folder ./config/mpesa.php for reference

$mpesa = new Mpesa();
try {

    $response = $mpesa->STKPush([
        'amount' => 10,
        'transactionDesc' => '',
        'phoneNumber' => '',
    ]);

    $response = $mpesa->B2C([
        'amount' => 10,
        'accountReference' => '12',
        'callBackURL' => 'https://example.com/v1/payments/C2B/confirmation',
        'queueTimeOutURL' => 'https://example.com/v1/payments/C2B/confirmation',
        'resultURL' => 'https://example.com/v1/payments/C2B/confirmation',
        'Remarks' => 'Test'
    ]);


    // $mpesa->STKStatus([]);

    // $mpesa->C2BRegister([]);

    // $mpesa->STKPush([]);

    // $mpesa->C2BSimulate([]);

    // $mpesa->B2C([])

    // $mpesa->B2B([]);

    // $mpesa->accountBalance([])

    // $mpesa->reversal([]);

    // $mpesa->transactionStatus([]);

    // $mpesa->reversal([]);
}catch(\Exception $e){
    $response = json_decode($e->getMessage());
}

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

Support

Need support using this package:- Send a quick message here, _(*11)

https://t.me/kabangi, _(*12)

API's Supported

The library implements all the exposed endpoints by Safaricom as listed below:-, _(*13)

1. Lipa na M-Pesa Online Payment

    What it is?

The Lipa na M-Pesa Online Payment endpoint(STK push) allows you to request payment from your users/clients. With this endpoint all the user is required to do is input their M-PESA pin to a prompt to send a payment to you., _(*14)

    How to implement it?

Read docs here., _(*15)

2. Lipa na M-Pesa Online Query Request

    What it is?

When you request payment from your users/clients via Lipa na M-Pesa Online endpoint above you might want to know the status of that request. This endpoint facilitates that. It allows you to query the status of any STK push on demand., _(*16)

    How to implement it?

Read docs here., _(*17)

3. C2B

    What it is?

This endpoint enables developers to receive real time notifications when a client makes a payments to a merchant's Till number or Paybill number. It assumes the payment are made via the SIM card toolkit and as a developer you need to know when that payment hits the merchants till/paybill number for reconciliation and accounting purposes., _(*18)

    How to implement it?

Read docs here., _(*19)

4. B2C

    What it is?

This endpoints enables merchants to pay their customers from they paybill account. Some of the use cases are but not limited to paying salaries, paying promotions to customers etc., _(*20)

    How to implement it?

Read docs here., _(*21)

5. B2B

    What it is?

This endpoint allows merchants to transfer funds from business to business accounts., _(*22)

    How to implement it?

Read docs here., _(*23)

6. Transaction Status

    What it is?

This endpoint enables developers to initiate status check of a B2B, B2C and C2B transactions. It really comes in handy where one party in a transactions fails/claims not to have received an acknowledgment for a transaction., _(*24)

    How to implement it?

Read docs here., _(*25)

7. Reverse API

    What it is?

This endpoint enables merchants to reverse a B2B, B2C or C2B transaction. It allows automation of reversal of erronous payment to a merchant's paybill/till number or payments to goods never delivered., _(*26)

    How to implement it?

Read docs here., _(*27)

8. Account Balance

    What it is?

This endpoint enables merchants to query their Till/Paybill numbers account balance on demand., _(*28)

    How to implement it?

Read docs here., _(*29)

Inspiration

This package was inspired by the work from smodav work on the following project:- https://github.com/SmoDav/mpesa, _(*30)

Contributors

Gratitudes goes to the following Ninjas for their help during my integration process and the things I had to learn along the way fom them or their code:-, _(*31)

_{Julius Kabangi}, _(*32)

License

The M-Pesa Package is open-sourced software licensed under the MIT license., _(*33)