# korapay-node

> #### The Korapay NodeJS SDK

Latest version **1.3.5** (published 2023-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install korapay-node
pnpm add korapay-node
yarn add korapay-node
bun add korapay-node
```

## 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.3.5 |
| Published | 2023-07-25 |
| First published | 2023-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 34 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Owoade Anuoluwapo |
| Maintainers | owoade |

## Links

- npm: https://www.npmjs.com/package/korapay-node
- Repository: git@github.com:Owoade/korapay-sdk
- npm.io page: https://npm.io/package/korapay-node

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.4.0

## Recent versions

- 1.3.5 (latest) — 2023-07-25
- 1.3.4 — 2023-07-25
- 1.3.3 — 2023-07-25
- 1.3.2 — 2023-07-24
- 1.3.1 — 2023-07-24
- 1.3.0 — 2023-07-24
- 1.2.9 — 2023-07-24
- 1.2.8 — 2023-07-24
- 1.2.7 — 2023-07-24
- 1.2.6 — 2023-07-24
- 1.2.5 — 2023-07-24
- 1.2.4 — 2023-07-24
- 1.2.3 — 2023-07-24
- 1.2.2 — 2023-07-24
- 1.2.1 — 2023-07-23
- … 21 more at https://npm.io/package/korapay-node/versions

## README

# Korapay SDK

#### The Korapay NodeJS SDK

### How to use

```bash 
# NPM
npm install korapay-node

# YARN
yarn add korapay-node
```

ESM,

```javascript
import { Korapay } from "korapay-node";

const korapay = new Korapay(secret_key, public_key);
```

CommonJs

```javascript
const { Korapay } = require("korapay-node");

const korapay = new Korapay(secret_key, public_key);
```

All methods use promise meaning you can either use the `async...await` or `then`. However, you do not have to clutter your code with blocks of `try..catch` as the SDK intuitively handles error already. For instance:

```javascript
 const charge = await korapay.charge.initialize( payload );

 if( !charge.status ) return charge.message; // this might be different depending on your use case

 redirect( charge.data.checkout_url ); // this might be different depending on your use case

```

### Modules

- [x] Charge(Payin)
- [x] Payout
- [x] Verification
- [x] Balances
- [x] Miscellaneous



### Contributing

Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.


Created with 🧡 by [Owoade](https://my-portfolio-owoade.vercel.app/)

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