# easy-paystack

> This developers use integrate Paystack into their application very easily

Latest version **1.0.0** (published 2020-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install easy-paystack
pnpm add easy-paystack
yarn add easy-paystack
bun add easy-paystack
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-07-14 |
| First published | 2020-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Elvis Onobo |
| Maintainers | elvis-onobo |
| Keywords | Paystack, Paystack Package, Node JS Paystack, Paystack JavaScript Package |

## Links

- npm: https://www.npmjs.com/package/easy-paystack
- npm.io page: https://npm.io/package/easy-paystack

## Dependencies (2)

- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0

## Recent versions

- 1.0.0 (latest) — 2020-07-14

## README

# Easy Paystack
The goal of the Easy Paystack package is to make working with Paystack APIs as easy as possible for the newbie.

### Some Advantages
1. While other packages are structured in a way that allows developers to include API keys within their code, with Easy Paystack you only need to set it up in your as an environment variable and you are good to go. This reduces the margin of error from copying and pasting your API keys all over the place. Also, this helps you build more secure apps and avoid the mistake of pushing your API keys to version control such as Github.

2. The main code makes heavy use of async/await so you can access returned values with just about two lines of code. Hopefully, I or you can optimize this soon enough such that the promise is resolved from the end of the package and only one response is sent back: the success case or the error case.

### Contribution
You are welcome to contribute to this package. However, you need to follow this convention:
1. Kindly stick to the use of __async/await__
2. Write a test for for the methods you contribute
3. Write an example usage for the method you contribute and add it to the __usage.js__ file
4. Add your methods to the Paystack object to keep sync and maintain the naming convention. The naming convention is as below:
  
	```Paystack.groupName.methodName()```
  
	For example, a method created to check for a user's BVN will be under the Verification group name. It will therefor be:
  
	```Paystack.verification.resolveBVN()```
  
	This is not rigid. You can use appropriate shorter versions of the words as long as the meaning is not lost and users will 
  be able to understand what it stands for and what your code does.
  
	### Using the Package
	```const Paystack = require('easy-paystack')```
	
	```const banks = Paystack.misc.listBanks()```

	```banks.then(data => console.log(data))```		 
	```.catch(err => console.log(err))```

	Result: You get the list of banks currently supported by Paystack
	
	### Current Methods
	1. Transactions
		- Initialize transaction: ```transactions.initialize(amount, email)```
		- Verify Transaction: ```transactions.verifyTrx(reference)```
		- List Transactions: ```transactions.listTrx()```
		- Fetch Transaction: ```transactions.fetchTrx(id)```
	
	2. Verification
		- Verify BVN Match: ```verify.matchBVN((bvn, accountNumber, bankCode, firstName, lastName)```
		- Resolve BVN: ```verify.resolveBVN(bvn)```
		- Resolve Account Number: ```verify.resolveAccount(bankAccount, bankCode)```
		- Resolve Card BIN: ```verify.resolveCardBin(bin)```

	3. Miscellaneous
		- List Banks: ```misc.listBanks()```
		- List Countries: ```misc.countries()```

	### Environment Settings
	Easy Paystack has been built such that you would not need to copy your public and private keys around.
	All you need to do is to create a .env file and add your keys like so:

	```PAYSTACK_SECRET_KEY=sk_test_****************************************```
	```PAYSTACK_PUBLIC_KEY=pk_test_****************************************```

	You may also add your BVN and Card Bin like so when testing
	```MY_BVN=************```
	```CARD_BIN=******```

	### Licence
  MIT
  
  ### Help This Package Get Noticed
  You can share this package with your friends and give us it a star on Github.

---
_Source: https://npm.io/package/easy-paystack · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._