node-shoket

KO | EN

gitlite — search

#python #hacktoberfest #react #golang #android #rust #linux #docker #windows #awesome #cli #kubernetes #awesome-list #pytorch

(★ 11)

Shoket node wrapper

node-shoket Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-shoket

A simple node wrapper for the shoket payment API, for more information on the API visit [Shoket Official website](https://developers.shoket.co/).

## Getting Started

### Prerequisites

- Install [Node.js](https://nodejs.org/) which includes [Node Package Manager](https://www.npmjs.com/get-npm)

### Installation
Installing with npm:

```shell
npm install node-shoket
```

### Usage
```js
const {makePayment, verifyPayment} = require('node-shoket');

//function used to make payment
makePayment(API_KEY,'5000','Sam Smith','user@mail.com','255612345678','Halotel');

//function used to verify payment
verifyPayment(API_KEY, '3j8zL7Tu7LhTMuR1S540f');

```

### Testing
```js
npm test
```

## Documentation
- The **makePayment** function is used to accept payments, the function has 6 parameters which are **API_KEY**, **amount**, **customer_name**, **email**, **number_used** and **channel**. 
The parameters are as follows in the function:
```js
makePayment(API_KEY, amount, customer_name, email, number_used, channel);
```
| Parameter       | Required | Description                                                                                                 |
|-----------------|----------|-------------------------------------------------------------------------------------------------------------|
| API_KEY         | Yes      | This is the secret API key given on registering at the [Shoket Official site](https://dashboard.shoket.co/) |
| Amount          | Yes      | This is an amount in Tanzania shilling.                                                                     |
| Customer Number | Yes      | This is a customer phone number which will be used to charge a customer.                                    |
| Email           | Yes      | This is a customer Email                                                                                    |
| Channel         | Yes      | Mobile-provider name which is used by the customer phone number.                                            |
| Customer names  | Yes      | This is a customer full name                                                                                |

- The **verifyPayment** is used to verify the transaction conducted, the function has 2 parameters which are the **API_KEY** and the **transaction reference**. The parameters are arranged as follows:

```js
verifyPayment(API_KEY, transaction_reference);
```
| Parameter             | Required | Description                                                                                                 |
|-----------------------|----------|-------------------------------------------------------------------------------------------------------------|
| API_KEY               | Yes      | This is the secret API key given on registering at the [Shoket Official site](https://dashboard.shoket.co/) |
| Transaction Reference | Yes      | This is the reference of the transaction performed already.                                                 |

## Contributing

Please see [CONTRIBUTING](CODE_OF_CONDUCT.md) for details.

## Credits

-   [Abdulaziz(Samatar) Abdi](https://github.com/azeez1776)
-   [Louis Ngatale](https://github.com/LouisNgatale)
-   [All Contributors](../../contributors)

## License

This project is licensed under the [MIT](LICENSE.md) License.

node-shoket

node-shoket Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

node-shoket

node-shoket Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README