Malipo+ (malipo-plus)

M-PESA Online Payment REST API. Easily play with the M-Pesa Online payment API on a local enviroment or intergrate it into your application using Malipo+.

Prerequisites

Javascript
Node
HTTP requests

1. Getting Started

Simply fork

Requirements

For making HTTP requests You can download Postman Here
Create a Safaricom new developer account Here
Click on Add a new app and you will receive a consumer key and consumer secret

Local installation

Install all dependancies npm install
Create a new enviroment variables file .env in malipoplus (remember to include it .gitignore)

This will house all the neccessary authentication configurations required to communicate with the safaricom Lipa na MPesa API

    CB_URL=
    CONSUMER_KEY=
    CONSUMER_SECRET=
    DB_URI=
    PASS_KEY=

callbackURL - a live server where The M-Pesa API will send a response to after the user authenticates the transaction. The response will be saved in the database in the format below:

{
    "_id": {
        "$oid": "5bf1bcf0f106d80016efce20"
    },
    "amount": 1,
    "recieptNo": "MKI7YPUA0D",
    "transactionDate": 1542569200319,
    "phoneNumber": 254700000000,
}

run npm start to spin up the API on localhost:3000

2. API info

Currently all payments request are sent to M-Pesa Test paybill which will be reversed in atmost 24 hours

3. API config

Base url : https://malipoplus.herokuapp.com/

headers : none

response format : application/json

request body : application/x-www-form-urlencoded

The business short code is located in /config/payments.js You can use your own personal paybill but this should be done after filling the test cases located on safaricom's developers dashboard. After which you will recieve production credentials. Step by Step documentation can be found here

4. End-Points

- POST api/newpayment

Body	Value
phonenumber	254700000000
amount	200

POST https://malipoplus.herokuapp.com/api/newpayment

After a transacton request is successfuly sent to the user, expect such a response:

{
  "MerchantRequestID": "2133-8623129-1",
  "CheckoutRequestID": "ws_CO_DMZ_172926767_19112018131435269",
  "ResponseCode": "0",
  "ResponseDescription": "Success. Request accepted for processing",
  "CustomerMessage": "Success. Request accepted for processing"
}

Response Code '0' indicates a successful stk push request to the user

- GET api/verify

Query	Value
phonenumber	254700000000
amount	200

GET https://malipoplus.herokuapp.com/api/verify?phonenumber=254706496885&amount=200

A status of 200 indicates that the transaction was successfully verified

response	Value
status	200
body	OK

A status of 404 will be sent if the specified payment does not exist or if the payment has already been verified

response	Value
status	404
body	Not Found

5. TODO

Write tests
Structure transaction verification response body
Handle incorrect mpesa pin
Handle cancelled STK push by user
Create a interactive front-end for the api (educational)

EdwinWalela/malipoplus