pesapaljs: A JavaScript repository from CalvinMagezi

PesapalJS

Goal

Make it easy to integrate PesaPal into a website or mobile app AND most importantly allow one to customize the payment user interface.

Core Features

paymentListener: express middleware that parses PesaPal payment notifications.
getPaymentStatus(options) : Get status of a payment. options should contain either a reference alone or a reference and transaction together.
getPaymentDetails(options): Get all information about a payment. options should contain a reference and a transaction.
getPaymentURL(order, callbackURI): Get a signed URL to the PesaPal payment page.
makeOrder(order, paymentMethod): Prepare an order for payment on a custom UI.
payOrder(order, paymentDetails): After a successful call to makeOrder, pay an order with details collected through a custom UI.

Usage

Install

$ npm install pesapaljs

Setup

var PesaPal = require('pesapaljs').init({
    key: CONSUMER_KEY,
    secret: CONSUMER_SECRET,
    debug: true // false in production!
});

When the debug option is set, pesapaljs will use the demo.pesapal.com/* endpoints.

Listen for payment notifications

// Listen for IPNs (With an express app)
// Use localtunnel or similar tools to test IPN when running on localhost
app.get('/ipn', PesaPal.paymentListener, function(req, res) { 
    var payment = req.payment;
    // do stuff with payment {transaction, method, status, reference}
    
    // DO NOT res.send()
});

Check Payment info

var options = {
    reference: "42314123", // Send this
    transaction: "175c6485-0948-4cb9-8d72-05a2c3f25be5" // or both.
};
PesaPal.getPaymentStatus(options)
        .then(function(status){ /* do stuff*/ })
        .catch(function(error){ /* do stuff*/ });

PesaPal.getPaymentDetails(options)
        .then(function (payment) {
            //payment -> {transaction, method, status, reference}
            //do stuff
        })
        .catch(function (error) { /* do stuff*/  });

Make a direct order

Make your customer pay on PesaPal's page:

var customer = new PesaPal.Customer("kariuki@pesapal.com");
var order = new PesaPal.Order("42314123", customer, "Ma ndazi", 1679.50, "KES", "MERCHANT");

// Redirect user to PesaPal
var url = PesaPal.getPaymentURL(order, "http://mysite.co.ke/callback");
// send it to an iframe ?

Or make your own awesome payment UI (web page, mobile app front-end, etc.):

var customer = new PesaPal.Customer("john@pesapal.com");
var order = new PesaPal.Order("WSDE0RFCC", customer, "Maziwa", 100, "KES", "MERCHANT");

// place order directly with your own UI

PesaPal.makeOrder(order, method) // First make the order

    .then(function (processedOrder) { // then collect payment details from user
        // Get payment details from user, DB - like their credit card info ;) or whatever
        // ...
        
        return Promise.resolve({
            order: processedOrder, 
            paymentDetails: new PesaPal.MobileMoney("254728988983","DEWEDWED")
        });
        
    }).then(function(collected) => { // then send payment request
        return PesaPal.payOrder(collected.order, collected.paymentDetails)
    })
    .then(function(resp) { // finally, receive a transaction id
        // resp.reference Your order, reference (42314123)
        // resp.transaction Payment transaction ID from PesaPal
        
    })
    .catch(function(error) {
        // Yo something went horribly wrong!
    });

Contributing

Fork this repo and make changes in your own fork.
Commit your changes and push to your fork git push origin master
Create a new pull request and submit it back to the project.

Bugs & Issues

To report bugs (or any other issues), use the issues page.

CalvinMagezi/pesapaljs