https://github.com/lawrence615/mpesa

https://github.com/lawrence615/mpesa

c2b event-listener events-triggered laravel-5-package laravel5 mobidev mpesa-api payments php safaricom soap

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/lawrence615/mpesa
• Owner: lawrence615
• Created: 2017-01-11T15:27:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-10T07:36:25.000Z (over 7 years ago)
• Last Synced: 2024-10-01T16:53:22.306Z (about 2 months ago)
• Topics: c2b, event-listener, events-triggered, laravel-5-package, laravel5, mobidev, mpesa-api, payments, php, safaricom, soap
• Language: PHP
• Size: 32.2 KB
• Stars: 1
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mpesa API Implementation

[![Latest Stable Version](https://poser.pugx.org/lawrence615/mpesa/v/stable)](https://packagist.org/packages/lawrence615/mpesa)

[![Total Downloads](https://poser.pugx.org/lawrence615/mpesa/downloads)](https://packagist.org/packages/lawrence615/mpesa)

[![Latest Unstable Version](https://poser.pugx.org/lawrence615/mpesa/v/unstable)](https://packagist.org/packages/lawrence615/mpesa)

[![License](https://poser.pugx.org/lawrence615/mpesa/license)](https://packagist.org/packages/lawrence615/mpesa)

This package is created to integrate MPesa Services i.e. C2B, B2C, B2B and Online Checkout in your Laravel app.

It allows you to receive and process soap sent by Safaricom. The package is still under heavy development and thus subject to bugs and changes.

## Requirements

- [PHP >=5.6.0](http://php.net/)

- [Laravel 5.x](https://github.com/laravel/framework)

## Quick Installation

```bash

composer require "lawrence615/mpesa:dev-master"

```

#### Service Provider

```php

Mobidev\Mpesa\MpesaServiceProvider::class

```

#### Configuration and Assets

```bash

php artisan vendor:publish --provider="Mobidev\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__

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

```php

    //$payload will have the data from the event

    public function c2bPayment($payload){

       

    }

```

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

```php

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

```