Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 3.83 KB

README.md

File metadata and controls

118 lines (85 loc) · 3.83 KB
Raw

Node pesa

npm (scoped) NPM

node pesa

Integration that simplifies access to M-Pesa's OpenAPI for developers to build applications/ software by providing easy access to services like Customer to Business (C2B), Query, and more.

Report Bug · Request Feature

🚧 Documentation

Take a look at the API docs here.

🚀 Getting Started

  1. Sign up for OpenAPI Portal – Before you begin, you need to sign up for an account and retrieve your credentials.

  2. Minimum requirements – To run the SDK, your system will need to meet the minimum requirements, including having Node >= 10.1.

  3. Install the SDK – Using NPM is the recommended way to install the Pesa SDK for JS. The SDK is available via [NPM] under the openpesa/pesa-js package. You can run the following in the base directory of your project to add the SDK as a dependency:

    npm install openpesa/pesa-js

    Please see the Installation section of the User Guide for more detailed information about installing the SDK through Composer and other means.

  4. Using the SDK – The best way to become familiar with how to use the SDK is to read the User Guide.

💼 Usage

import { Pesa } from '@openpesa/pesa-js';

// Populate the credentials
const api_key = 'your_api_key';
const public_key = 'the_public_key';

// Intiate with credentials
let pesa = new Pesa({ api_key, public_key });

// Setup the transaction
let data = {
    input_Amount: 10000,
    // ..
};

// Execute the transaction
pesa.c2b(data)
    .then((data) => {
        // Print results
        console.log(data);
    })
    .catch((e) => {
        console.log('err: ' + e);
    });

🧪 Test

npm test

🗺️ Road Map

  1. Validate data input using Regex before the API call.
  2. If fields are not provided then generate a random string for "input_ThirdPartyConversationID" and "input_TransactionReference"
  3. Allow optional input for not required fields in a request.
  4. Check and Throw an error when used outside of Node.js due to security reasons, Advice on use outside Node.js.
  5. Validate Secret Keys length and format.
  6. Allow user use custom sessionID on any/each transaction. (Portal allow for seesion with several hours of validity)
  7. Add and improve documentation and examples(example will include expressjs app)

📜 Changelog

Please see CHANGELOG for more information on what has changed recently.

🤝 Contributing

Please see CONTRIBUTING for details.

🔐 Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

👥 Credits

📄 License

The MIT License (MIT). Please see License File for more information.