ssiva/mpesa-lumen-sdk

This package provides a seamless integration of M-PESA Daraja APIs in Lumen applications

v1.1.3 2023-04-13 19:00 UTC

Requires

• illuminate/support: *
• ssiva/mpesa-daraja: ^4

Requires (Dev)

• fakerphp/faker: ^1.9.1
• mockery/mockery: ^1.4.4
• phpunit/phpunit: ^10.0

MIT

• Simon Siva

README

This package provides a seamless integration of M-PESA Daraja APIs in Lumen applications, allowing developers to easily handle:

• B2C (Business to Customer)
• C2B (Customer to Business)
• B2B (Business to Business)
• Account Balance inquiries
• Transaction reversals queries
• Transaction status queries.

It simplifies the implementation process by providing an intuitive interface for making API requests, handling responses, and managing errors. With this package, developers can seamlessly integrate M-PESA Daraja APIs in their Lumen projects, saving time and effort.

Installation and Setup

1. Run the command below

   composer require ssiva/mpesa-lumen-sdk
   

2. Open your bootstrap/app.php and make the following changes:

   • uncomment and edit the following line

      // $app->withFacades();

     to

     $app->withFacades(true, [
     \Ssiva\MpesaLumenSdk\MpesaFacade::class => 'MpesaDaraja',
     ]);

   • Register the Mpesa ServiceProvider

      // Mpesa ServiceProvider
      $app->register(\Ssiva\MpesaLumenSdk\MpesaServiceProvider::class);

Configuration

Set up the config values as required

1. Account API Online Config

        MPESA_SHORTCODE=
        MPESA_RESULT_URL=
        MPESA_TIMEOUT_URL=
        MPESA_INITIATOR_NAME=
        MPESA_SECURITY_CREDENTIAL=
        MPESA_SECURITY_CERT=
        MPESA_ACCOUNT_IDENTIFIER=

2. LipaNaMpesa API Online Config

        MPESA_SHORTCODE=
        MPESA_CALLBACK_URL=
        MPESA_PASSKEY=
        MPESA_ONLINE_TRANSACTION_TYPE=

3. B2C API Config

        MPESA_SHORTCODE=
        MPESA_RESULT_URL=
        MPESA_TIMEOUT_URL=
        MPESA_INITIATOR_NAME=
        MPESA_SECURITY_CREDENTIAL=
        MPESA_SECURITY_CERT=
        MPESA_ACCOUNT_IDENTIFIER=
        MPESA_B2C_COMMAND=

4. B2B API Config

        MPESA_SHORTCODE=
        MPESA_RESULT_URL=
        MPESA_TIMEOUT_URL=
        MPESA_INITIATOR_NAME=
        MPESA_SECURITY_CREDENTIAL=
        MPESA_SECURITY_CERT=
        MPESA_ACCOUNT_IDENTIFIER=
        MPESA_B2B_COMMAND=
        MPESA_B2B_SENDER_ID=
        MPESA_B2B_RECEIVER_ID=

5. C2B API Config

        MPESA_SHORTCODE=
        MPESA_C2B_COMMAND=
        MPESA_C2B_CONFIRMATION_URL=
        MPESA_C2B_VALIDATION_URL=
        MPESA_C2B_RESPONSE_TYPE=

Usage Examples

<?php
namespace YOURNAMESPACE;

use MpesaDaraja; 
use Ssiva\MpesaDaraja\Mpesa;

class CheckoutController extends Controller {
   
   public function darajaExamples(
        $mpesaDaraja = new MpesaDaraja();
        
        // authenticate
        $mpesaDaraja::authenticate();
        
        // STK Push
        $stkParams = [
            'Amount' => '2',
            'PartyA' => '2547XXXXXXXX',
            'PhoneNumber' => '2547XXXXXXXX',
            'AccountReference' => '13',
            'TransactionDesc' => 'Shopping',
        ];
       $mpesaDaraja::stkPush($stkParams);
       
       // stk push status query
       $stkQueryParams = [
         'CheckoutRequestID' => "ws_CO_290320231617432767XXXXXXXX",
       ];
       $mpesaDaraja::stkPushQuery($stkQueryParams);
       
       // transaction status query
       $statusParams = [
         'Remarks' => "Status test for RCC3LAPCEL",
         "TransactionID" => "RCC3LAPCEL",
         "Occasion" => "Optional Value for Occasion"
       ];
       $mpesaDaraja::transactionStatus($statusParams);

   }
}