JavaScript M-Pesa SDK

This is a library willing to help you to integrate the Vodacom M-Pesa operations to your application.

Features

Using this library, you can implement the following operations:

• Receive money from a mobile account to a business account (C2B)
• Send money from a business account to a mobile account (B2C)
• Send money from a business account to another business account (B2B)
• Revert any of the transactions above mentioned
• Query the status of a transaction

Requirements

• NodeJS v12.0+
• NPM or Yarn
• Valid credentials obtained from the Mpesa Developer portal

Installation

Using NPM

npm install --save @paymentsds/mpesa

Using Yarn

yarn add @paymentsds/mpesa

Usage

Using this SDK is very simple and fast, let us see some examples:

Client configuration

import { Client } from '@paymentsds/mpesa'

const client = new Client({
   apiKey: '<REPLACE>',              // API Key
   publicKey: '<REPLACE>',           // Public Key
   serviceProviderCode: '<REPLACE>', // Service Provider Code,
   initiatorIdentifier: '<REPLACE>', // Initiator Identifier,
   securityIdentifier: '<REPLACE>',  // Security Credential
   timeout: '<REPLACE>',             // time in seconds
   debugging: true,                 
   verifySSL: false,
   userAgent: '<REPLACE>' 
});

C2B Transaction (Receive money from mobile account)

On ES6 Modules

import { Client } from '@paymentsds/mpesa'

const client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>' // Service Provider Code
});

const paymentData = {
   from: '841234567',               // Customer MSISDN
   reference: '11114',              // Third Party Reference
   transaction: 'T12344CC',          // Transaction Reference
   amount: '10'                     // Amount
};

client.receive(paymentData).then(r => {
   // Handle success scenario
}).catch(e =>{
   // Handle success scenario
});

CommonJS

var Client = require("@paymentsds/mpesa").Client;

var client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>' // Service Provider Code
});

var paymentData = {
   from: '841234567',               // Customer MSISDN
   reference: '11114',              //  Third Party Reference
   transaction: 'T12344CC',          //  Transaction Reference
   amount: '10'                     //  Amount
};

client.receive(paymentData).then(function(r) {
   // Handle success scenario
}).catch(function(e) {
   // Handle success scenario
});

B2C Transaction (Sending money to mobile account)

On ES6 Modules

import { Client } from '@paymentsds/mpesa'

const client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>' // Service Provider Code
});

const paymentData = {
   to: '841234567',               // Customer MSISDN
   reference: '11114',              // Third Party Reference
   transaction: 'T12344CC',          // Transaction Reference
   amount: '10'                     // Amount
};

client.send(paymentData).then(function(r) {
   // Handle success scenario
}).catch(function(e) {
   // Handle failure scenario
});

CommonJS

let Client = require("@paymentsds/mpesa").Client;

let client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>' // Service Provider Code
});

let paymentData = {
   to: '841234567',               // Customer MSISDN
   reference: '11114',              // Third Party Reference
   transaction: 'T12344CC',          // Transaction Reference
   amount: '10'                     // Amount
};

client.send(paymentData).then(r => {
   // Handle success scenario
}).catch(e =>{
   // Handle failure scenario
});

B2B Transaction (Sending money to business account)

On ES6 Modules

import { Client } from '@paymentsds/mpesa'

const client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>' // Service Provider Code
});

const paymentData = {
   to: '979797',                 // Receiver Party Code
   reference: '11114',              // Third Party Reference
   transaction: 'T12344CC',          // Transaction Reference
   amount: '10'                     // Amount
};

client.send(paymentData).then(r => {
   // Handle success scenario
}).catch(e =>{
   // Handle failure scenario
});

CommonJS

let Client = require("@paymentsds/mpesa").Client;

let client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>' // Service Provider Code
});

let paymentData = {
   to: '979797',                    // Receiver Party Code
   reference: '11114',              // Third Party Reference
   transaction: 'T12344CC',          // Transaction Reference
   amount: '10'                     // Amount
};

client.send(paymentData).then(function(r) {
   // Handle success scenario
}).catch(function(e) {
   // Handle failure scenario
});

Transaction Reversal

On ES6 Modules

import { Client } from '@paymentsds/mpesa'

const client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>', // Service Provider Code,
   initiatorIdentifier: '<REPLACE>', // Initiator Identifier,
   securityCredential: '<REPLACE>'  // Security Credential
});

const reversionData = {
   reference: '11114',           // Third Party Reference
   transaction: 'T12344CC',       // Transaction ID
   amount: '10'                  // Reversal Amount
};

client.revert(reversionData).then(r => {
   // Handle success scenario
}).catch(e =>{
   // Handle failure scenario
});

CommonJS

let Client = require("@paymentsds/mpesa").Client;

let client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>', // Service Provider Code,
   initiatorIdentifier: '<REPLACE>', // Initiator Identifier,
   securityCredential: '<REPLACE>'  // Security Credential
});

let reversionData = {
   reference: '11114',           // Third Party Reference
   transaction: 'T12344CC',       // Transaction ID
   amount: '10'                  // Reversal Amount
};

client.revert(reversionData).then(function(r) {
   // Handle success scenario
}).catch(function(e) {
   // Handle failure scenario
});

Query the transaction status

On ES6 Modules

import { Client } from '@paymentsds/mpesa'

const client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>', // Service Provider Code,
});

const reversionData = {
   reference: '11114', // Third Party Reference
   subject: '5C1400CVRO', // Query Reference
};

client.query(reversionData).then(r => {
   // Handle success scenario
}).catch(e => {
   // Handle failure scenario
});

CommonJS

let Client = require('@paymentsds/mpesa');

let client = new Client({
   apiKey: '<REPLACE>',             // API Key
   publicKey: '<REPLACE>',          // Public Key
   serviceProviderCode: '<REPLACE>', // Service Provider Code,
});

let reversionData = {
   reference: '11114', // Third Party Reference
   subject: '5C1400CVRO', // Query Reference
};

client.query(reversionData).then(function(r) {
   // Handle success scenario
}).catch(function(e) {
   // Handle failure scenario
});

Friends

• M-Pesa SDK for Python
• M-Pesa SDK for Java
• M-Pesa SDK for PHP
• M-Pesa SDK for Ruby

Authors

• Anísio Mandlate
• Edson Michaque
• Elton Laice
• Nélio Macombo

Contributing

Thank you for considering contributing to this package. If you wish to do it, email us at [email protected] and we will get back to you as soon as possible.

Security Vulnerabilities

If you discover a security vulnerability, please email us at [email protected] and we will address the issue with the needed urgency.

License

Copyright 2022 © The PaymentsDS Team

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.