Git Product home page Git Product logo

daraja's Introduction

Daraja Logo

A NodeJS library to simplify integration with Safaricom's Daraja M-Pesa API

npm Travis (.com) Coveralls github Codacy grade Code Climate issues Code Climate maintainability David David npm bundle size (minified) npm GitHub

Example

const { Daraja } = require('daraja');

// instantiate Daraja with the organization's shortcode and app's Consumer Key
// and Consumer Secret
const daraja = new Daraja([SHORTCODE], '[CONSUMER_KEY]', '[CONSUMER_SECRET]');

// create an MPesa instance configured according to the API's you will consume
// e.g to consume MPesa Express (Lipa Na M-Pesa Online) API
const mpesa = daraja
  .configureMPesaExpress('[PASSKEY]', '[CALLBACK_URL]')
  .build();

// finally make the call to the API passing the required arguments
mpesa
  .mPesaExpressRequest(
    [AMOUNT],
    [SENDER],
    [RECIPIENT],
    '[TRANSACTION_TYPE]',
    '[ACCOUNT_REFERENCE]',
    '[TRANSACTION_DESCRIPTION]'
  )
  .then(response => {
    // if the call was successfull, you can do something with the response here
  })
  .catch(error => {
    // if any error occurs, you can handle it here
  });

// you can also use async-await to handle the response and errors
try {
  const response = await mpesa.mPesaExpressRequest(
    [AMOUNT],
    [SENDER],
    [RECIPIENT],
    '[TRANSACTION_TYPE]',
    '[ACCOUNT_REFERENCE]',
    '[TRANSACTION_DESCRIPTION]'
  );
  // handle the response here
} catch (error) {
  // handle any errors here
}

Motivation

I developed this library to make it as painless as possible for JavaScript & TypeScript developers to integrate their web applications with Safaricom's Daraja M-Pesa API.

The emphasis is to make use of modern JavaScript & TypeScript syntax to provide a clean an easy to use interface. This library is under constant maintenance and more features will be added to simplify the integration even further and capture all common use cases.

Installation

  1. Ensure you have Node & npm installed for your operating system.

    node --version
    npm --version
  2. Open a command line and navigate to your project folder. Run the following command to install daraja as a project dependency

    npm install --save daraja

API Reference

Visit the documentation

License

This project is licensed under the MIT License.

daraja's People

Contributors

austinewuncler avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.