# maplerad-node

> Official Nodejs library for the Maplerad API

Latest version **1.1.3** (published 2024-06-21) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2024-06-21 |
| First published | 2022-07-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 67.7 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Christian Ndu |
| Keywords | sdk, banking, payments, fintech |

## Links

- npm: https://www.npmjs.com/package/maplerad-node
- Repository: https://github.com/wirepay/maplerad-node
- Issues: https://github.com/wirepay/maplerad-node/issues
- npm.io page: https://npm.io/package/maplerad-node

## Dependencies (2)

- [tsx](https://npm.io/package/tsx.md) ^4.15.7
- [axios](https://npm.io/package/axios.md) ^0.27.2

## Recent versions

- 1.1.3 (latest) — 2024-06-21
- 1.1.2 — 2024-06-21
- 1.1.1 — 2024-06-21
- 1.1.0 — 2023-05-10
- 1.0.1 — 2023-05-10
- 0.0.1 — 2022-07-20

## README

# The Maplerad Node Client

The library follows an object-oriented approach and methods are grouped under categories.

There are currently twelve (12) base categories namely:

-   Customer
-   Collections
-   Transfer
-   Bills
-   Wallets
-   Issuing
-   Identity
-   Transactions
-   Counterparty
-   Forex
-   Institutions
-   Misc

#### Learn more from the [docs](https://maplerad.dev/reference)

# Installation

```shell
 $  npm install maplerad-node

 or

 $  yarn add maplerad-node
```

# Authorization

A secret key is needed for authorization. It can be gotten from the Maplerad dashboard

# Environments

Maplerad provides two environments to ensure a smooth and easy experience.

-   sandbox: for development
-   live: for production

## Sandbox

Sandbox is your playground. You can credit your test wallets and use that to test your integrations, no real money will be debited or credited.
Ensure to switch to Live when you are ready to launch.

## Live

All method calls under Live will be charged and real money will be debited or credited.
You are advised to use this when you have fully tested your integrations and are ready to launch your product.

# Usage

```js
// import the package
const Maplerad = require("maplerad-node"); // commonjs
// or
import Maplerad from "maplerad-node"; // esm

const SECRET_KEY = process.env.SECRET_KEY;
const ENVIRONMENT = "sandbox";

const client = new Maplerad(SECRET_KEY, ENVIRONMENT);
```

## Get all Customers

```js
// Get all customers
async function getAllCustomers() {
    try {
        const customers = await client.Customers.GetAllCustomers();
        console.log(customers);
    } catch (error) {
        console.error(error);
    }
}
```

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