Laravel MpesaB2C

Safaricom's Mpesa Daraja API B2C implementation

Getting Started

Read on the Daraja B2C documentation to get to understand more on this implementation.

Installing

composer require manuelgeek/mpesab2c

Laravel 5 and above

This package supports the auto-discovery feature of Laravel 5.5 and above, So skip these Setup instructions if you're using Laravel 5.5 and above.

In app/config/app.php add the following :

1- The ServiceProvider to the providers array :

Manuelgeek\MpesaB2C\MpesaServiceProvider::class,

2- The class alias to the aliases array :

'B2C' => Manuelgeek\MpesaB2C\Facades\B2C::class,

3- Publish the config file

php artisan vendor:publish --provider="Manuelgeek\MpesaB2C\MpesaServiceProvider"

There will now be a new mpesa_b2c.php file in your config directory that is at the root of your project. All the configuration options are present in the file. Also remember to set the QueueTimeOutURL and ResultURL endpoints w. E.g.

"QueueTimeOutURL" => "http:example.com/mpesa/receive",

"ResultURL" => "http://example.com/mpesa/receive"

Usage

Mpesa B2C Laravel

    $Amount ='300';
    $CommandID = 'BusinessPayment';
    $PartyB = '254708374149';
    $Remarks = 'Payed well';

    //Using the Facade
    $response = \B2C::sendMpesaMoney($Amount,$CommandID,$PartyB, $Remarks);
    
    //or the function
    $response = sendMpesaMoney($Amount,$CommandID,$PartyB, $Remarks);

Without Laravel

Example

<?php

    require_once "vendor/autoload.php";

    $Amount ='300';
    $CommandID = 'BusinessPayment';
    $PartyB = '254708374149';
    $Remarks = 'Payed well';
    
    $mpesa = new \Manuelgeek\MpesaB2C\B2C();
    
    $response = $mpesa->sendMpesaMoney($Amount,$CommandID,$PartyB, $Remarks);

?>

Sample Responses

Successful Request

Once sent, you shall expect a success acknowledgement response from the API informing you that your request was accepted. The response format is as below:

{
  "ConversationID": "AG_20180326_00005ca7f7c21d608166",
  "OriginatorConversationID": "12363-1328499-6",
  "ResponseCode": "0",
  "ResponseDescription": "Accept the service request successfully."
}

Note the value of ResponseCode. Any value other than 0 (zero) means the request was unsuccessful, and the error is defined in the ResponseDescription element. So you need to fix that first. A value of 0 means the request was accepted by the API.

After M-Pesa completes processing the transaction, it sends back the callback via the ResultURL you specified in the initial request. A callback from M-Pesa can either be a success callback or a failure callback. A sample of a successful transaction callback is as shown below:

{
	"Result":
	{
		"ResultType":0,
		"ResultCode":0,
		"ResultDesc":"The service request has been accepted successfully.",
		"OriginatorConversationID":"14593-80515-2",
		"ConversationID":"AG_20170821_000049448b24712383de",
		"TransactionID":"LHL41AHJ6G",
		"ResultParameters":
		{
			"ResultParameter":
			[
				{
					"Key":"TransactionAmount",
					"Value":100
				},
				{
					"Key":"TransactionReceipt",
					"Value":"LHL41AHJ6G"
				},
				{
					"Key":"B2CRecipientIsRegisteredCustomer",
					"Value":"Y"
				},
				{
					"Key":"B2CChargesPaidAccountAvailableFunds",
					"Value":0.00
				},
				{
					"Key":"ReceiverPartyPublicName",
					"Value":"254708374149 - John Doe"
				},
				{
					"Key":"TransactionCompletedDateTime",
					"Value":"21.08.2017 12:01:59"
				},
				{
					"Key":"B2CUtilityAccountAvailableFunds",
					"Value":98834.00
				},
				{
					"Key":"B2CWorkingAccountAvailableFunds",
					"Value":100000.00
				}
			]
		},
		"ReferenceData":
		{
			"ReferenceItem":
			{
				"Key":"QueueTimeoutURL",
				"Value":"https:\/\/internalsandbox.safaricom.co.ke\/mpesa\/b2cresults\/v1\/submit"
			}
		}
	}
}

A sample method to consume the callback response would be as below, just get the data and dump it to a transactions table

    public function saveResponse()
        {
            $postData =  file_get_contents('php://input');
   
            $request = json_decode($postData,true);
    
            if ($request['Result']['ResultCode'] == 0) {
    
            	DB::table('mpesa_transactions')
                ->insert([
                    'ResultType' => $request['Result']['ResultType'],
                    'ResultCode' => $request['Result']['ResultCode'],
                    "ResultDesc" => $request['Result']['ResultDesc'],
                    "OriginatorConversationID" => $request['Result']['OriginatorConversationID'],
                    "ConversationID" => $request['Result']['ConversationID'],
                    "TransactionID" => $request['Result']['TransactionID'],
                    "TransactionReceipt" => $request['Result']['ResultParameters']['ResultParameter'][0]['Value'] ,
                    "TransactionAmount" => $request['Result']['ResultParameters']['ResultParameter'][1]['Value'] ,
                    "B2CWorkingAccountAvailableFunds" => $request['Result']['ResultParameters']['ResultParameter'][2]['Value'] ,
                    "B2CUtilityAccountAvailableFunds" => $request['Result']['ResultParameters']['ResultParameter'][3]['Value'] ,
                    "TransactionCompletedDateTime" => $request['Result']['ResultParameters']['ResultParameter'][4]['Value'] ,
                    "ReceiverPartyPublicName" => $request['Result']['ResultParameters']['ResultParameter'][5]['Value'] ,
                    "B2CChargesPaidAccountAvailableFunds" => $request['Result']['ResultParameters']['ResultParameter'][6]['Value'] ,
                    "B2CRecipientIsRegisteredCustomer" => $request['Result']['ResultParameters']['ResultParameter'][7]['Value'] ,
                    "QueueTimeoutURL" => $request['Result']['ReferenceData']['ReferenceItem']['Value'] ,
                    'created_at'=>\Carbon\Carbon::now(),
                    'updated_at'=>\Carbon\Carbon::now(),
                ]);
            }
    
    
            return "success";
        }

Contributing

https://github.com/manuelgeek/mpesab2c/pulls

Authors

Magak Emmanuel - Manuelgeek

License

This project is licensed under the MIT License - see the LICENSE.md file for details