ftg/mpesac2b

Package to integrate Mpesa C2B Service

dev-master 2017-04-11 09:41 UTC

Requires

• php: ^5.6 || ^7.0
• ftg/mpesac2b: dev-master
• nesbot/carbon: ^1.21

MIT

• David

README

Build up upon from https://packagist.org/packages/lawrence615/mpesa

This package is created to integrate c2b Mpesa. This package will only take payments payed by users in the system.

Requirements

• PHP >=5.6.0
• Laravel 5.x

Quick Installation

composer require "ftg/mpesac2b:dev-master"

Service Provider

Ftg\Mpesa\MpesaServiceProvider::class,

Configuration and Assets

php artisan vendor:publish --provider="Ftg\Mpesa\MpesaServiceProvider"

Then run php artisan migrate to create the tables in you database. This will create two tables;

1. mpesa_payment_logs table - logs everything received from Safaricom

2. payments table - breaks down what is received from Safaricom into a number of columns

Receiver Route

The route that receives the IPN is c2b/payments/receiver i.e. http://example.com/c2b/payments/receiver. This is the endpoint you give to Safaricom.

Events

There are events triggered when certain actions happen. You can extend the package's behaviour by setting up your own event listeners to provide custom functionality.

These are the events triggered by the package. The list will grow with time as more events come up;

Event	Available data
c2b.received.payment	Full C2B Payment Object

C2B Payment Event Listener

Add the following to the .env

BusinessNumber=
MaxAmount=

Create a Controller i.e. PaymentsController then create a function c2bPayment

    //$payload will have the data from the event
    public function c2bPayment($payload){
       
    }

Register an event listener in the boot method of your EventServiceProvider:

Event::listen('c2b.received.payment', 'App\Http\Controllers\PaymentsController@c2bPayment');