UNPKG

mpesa

Version:

Mpesa npm module for listening to requests

110 lines (60 loc) 2.56 kB
[![Mpesa Logo](https://tech-ish.com/wp-content/uploads/2014/09/Mpesa-Logo.jpeg)](http://www.safaricom.co.ke) Fast and quick deployment of M-Pesa listeners for B2C, C2B, B2B and Lipa Na Mpesa Online for daraja [Daraja](http://developer.safaricom.co.ke). ```js var demo = require ('mpesa'); demo.b2clistener (); //creates a b2clistener demo.c2bvalidation (); //creates a validation listener demo.c2bconfirmation (); //creates a confirmation listener demo.b2blistener (); //creates a b2b listener ``` ## Installation This is a [Node.js](https://nodejs.org/en/) module available through the [npm registry](https://www.npmjs.com/). Before installing, [download and install Node.js](https://nodejs.org/en/download/). Node.js 0.10 or higher is required. Installation is done using the [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally): ```bash $ npm install mpesa ``` ## Features * Quick Deployment * URLS automatically generated on running your js file * Console.logs all incoming requests * Confirms and validates all incoming requests * Only takes 5 lines of code to deploy * Executable for generating applications quickly ## Docs & Community * [Website and Documentation](http://developer.safaricom.co.ke/) * [GitHub Organization](https://github.com/safaricom) for Official Middleware & Modules **PROTIP** Be sure to be checking for version updates ### Security Issues If you discover a security vulnerability in Express, please see [Security Policies and Procedures](Security.md). ## Quick Start The quickest way to get started with mpesa is to call the require function on [`mpesa`] Install the npm first ```bash $ npm install mpesa ``` Create your .js file (this can be test.js) ```bash var demo = require ('mpesa'); demo.b2clistener (); //creates a b2clistener demo.c2bvalidation (); //creates a validation listener demo.c2bconfirmation (); //creates a confirmation listener demo.b2blistener (); //creates a b2b listener ``` Run the file using node: ```bash $ node test.js ``` ## Philosophy We make it seemless for developers to integrate using our apis on the daraja platform to allow for easier movement of mobile money (M-Pesa). The platform that allows users to easily integrate their applications to Mobile money and transforming lives for Kenyans. ## People The original author of mpesa is [Arbaaz Wahid](https://) The current lead maintainer is [Safaricom](https://github.com/safaricom) ## License [ISC](LICENSE)