package mpesa

safaricom/mpesa

A PHP package for Mpesa API

Introduction, _(*1)

This package seeks to help php developers implement the various Mpesa APIs without much hustle. It is based on the REST API whose documentation is available on https://developer.safaricom.co.ke., _(*2)

Installation using composer
composer require safaricom/mpesa
, _(*3)

Configuration
At your project root, create a .env file and in it set the consumer key and consumer secret as follows
MPESA_CONSUMER_KEY= [consumer key]
MPESA_CONSUMER_SECRET=[consumer secret]
MPESA_ENV=[live or sandbox]
For Laravel users, open the Config/App.php file and add \Safaricom\Mpesa\MpesaServiceProvider::class under providers and 'Mpesa'=> \Safaricom\Mpesa\MpesaServiceProvider::class under aliases., _(*4)

Remember to edit the consumer_key and consumer_secret values appropriately when switching between sandbox and live, _(*5)

Usage, _(*6)

Confirmation and validation urls, _(*7)

B2C Payment Request, _(*8)

This creates transaction between an M-Pesa short code to a phone number registered on M-Pesa., _(*9)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*10)

$b2cTransaction=$mpesa->b2c($InitiatorName, $SecurityCredential, $CommandID, $Amount, $PartyA, $PartyB, $Remarks, $QueueTimeOutURL, $ResultURL, $Occasion);, _(*11)

Account Balance Request, _(*12)

This is used to enquire the balance on an M-Pesa BuyGoods (Till Number), _(*13)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*14)

$balanceInquiry=$mpesa->accountBalance($CommandID, $Initiator, $SecurityCredential, $PartyA, $IdentifierType, $Remarks, $QueueTimeOutURL, $ResultURL);, _(*15)

Transaction Status Request This is used to check the status of transaction., _(*16)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*17)

$trasactionStatus=$mpesa->transactionStatus($Initiator, $SecurityCredential, $CommandID, $TransactionID, $PartyA, $IdentifierType, $ResultURL, $QueueTimeOutURL, $Remarks, $Occasion);, _(*18)

B2B Payment Request, _(*19)

This is used to transfer funds between two companies., _(*20)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*21)

$b2bTransaction=$mpesa->b2b($ShortCode, $CommandID, $Amount, $Msisdn, $BillRefNumber );, _(*22)

C2B Payment Request, _(*23)

This is used to Simulate transfer of funds between a customer and business., _(*24)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*25)

$b2bTransaction=$mpesa->c2b($ShortCode, $CommandID, $Amount, $Msisdn, $BillRefNumber );, _(*26)

Also important to note is that you should have registered validation and confirmation urls where the callback responses will be sent., _(*27)

STK Push Simulation, _(*28)

This is used to initiate online payment on behalf of a customer., _(*29)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*30)

$stkPushSimulation=$mpesa->STKPushSimulation($BusinessShortCode, $LipaNaMpesaPasskey, $TransactionType, $Amount, $PartyA, $PartyB, $PhoneNumber, $CallBackURL, $AccountReference, $TransactionDesc, $Remarks);, _(*31)

STK Push Status Query, _(*32)

This is used to check the status of a Lipa Na M-Pesa Online Payment., _(*33)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*34)

$STKPushRequestStatus=$mpesa->STKPushQuery($checkoutRequestID,$businessShortCode,$password,$timestamp);, _(*35)

Callback Routes M-Pesa APIs are asynchronous. When a valid M-Pesa API request is received by the API Gateway, it is sent to M-Pesa where it is added to a queue. M-Pesa then processes the requests in the queue and sends a response to the API Gateway which then forwards the response to the URL registered in the CallBackURL or ResultURL request parameter. Whenever M-Pesa receives more requests than the queue can handle, M-Pesa responds by rejecting any more requests and the API Gateway sends a queue timeout response to the URL registered in the QueueTimeOutURL request parameter., _(*36)

Obtaining post data from callbacks This is used to get post data from callback in json format. The data can be decoded and stored in a database., _(*37)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*38)

$callbackData=$mpesa->getDataFromCallback();, _(*39)

Finishing a transaction After obtaining the Post data from the callbacks, use this at the end of your callback routes to complete the transaction, _(*40)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*41)

$callbackData=$mpesa->finishTransaction();, _(*42)

If validation fails, pass false to finishTransaction(), _(*43)

$mpesa= new \Safaricom\Mpesa\Mpesa();, _(*44)

$callbackData=$mpesa->finishTransaction(false);, _(*45)