@openpesa/pesa-js/README.md

MPesa SDK for Nodejs

<p align="center"><img src="img/mpesa.png" width="400px" alt="M-Pesa Logo"></p>

# Pesa SDK for Nodejs using M-Pesa Open API

![npm (scoped)](https://img.shields.io/npm/v/@openpesa/pesa-js)
[![Build Status](https://travis-ci.org/openpesa/pesa-js.svg)](https://travis-ci.org/openpesa/pesa-js)
![documentation](https://github.com/openpesa/pesa-js/workflows/documentation/badge.svg)
[![NPM](https://nodei.co/npm/@openpesa/pesa-js.png?mini=true)](https://npmjs.org/package/@openpesa/pesa-js)

The **Pesa SDK for Node.js** makes it easy for developers to access [OpenAPI](https://openapiportal.m-pesa.com/) in their Javascript code, and build robust applications and software using services like Customer 2 Bussiness, Query, etc.

## Documentation

Take a look at the [API docs here](https://openpesa.github.io/pesa-js/).

## Getting Started

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

1. **Minimum requirements** – To run the SDK, your system will need to meet the
   [minimum requirements](https://openpesa.github.io/pesa-js/guide/installation#system-requirements), including having **Node >= 10.1**.
1. **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`](https://www.npmjs.com/package/@openpesa/pesa-js) package. You can run the following in the base directory of your project to add the SDK as a dependency:
    ```sh
    npm install openpesa/pesa-js
    ```
    Please see the
    [Installation section of the User Guide](https://openpesa.github.io/pesa-js/installation.html) for more
    detailed information about installing the SDK through Composer and other
    means.
1. **Using the SDK** – The best way to become familiar with how to use the SDK
   is to read the [User Guide](https://openpesa.github.io/pesa-js/).

## Usage

### Quick Examples

```js
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);
    });
```

### Testing

```bash
npm test
```

## Opening Issues

If you have a feature request or you encounter a bug, please file an issue on [our issue tracker on GitHub](https://github.com/openpesa/pesa-js/issues).

## 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)
8. 


### Security

If you discover any security-related issues, please email [alphaolomi@gmail.com](mailto:alphaolomi@gmail.com) instead of using the issue tracker.

## Credits

-   [Openpesa](https://github.com/openpesa)
-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.