Skip to content

Installation & Requirements

nepay is published to the npm registry as a zero-dependency (other than Zod) core library targeting Node 18+.

Install the package using your favorite package manager:

Terminal window
# npm
npm install @bivekkk/nepay
# pnpm
pnpm add @bivekkk/nepay
# yarn
yarn add @bivekkk/nepay
# bun
bun add @bivekkk/nepay
  • Node.js: >= 18.0.0 (Uses native Node fetch and node:crypto).
  • TypeScript: >= 5.0.0 recommended for full type inference and union narrowing.
  • Module Systems: Ships both ESM (import) and CommonJS (require) bundles with complete .d.ts type definitions.

Ensure your tsconfig.json has moduleResolution configured for modern packages:

tsconfig.json
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"strict": true,
"skipLibCheck": true
}
}

The core library does not depend on any specific web framework. You can use it with:

  • Express.js / Koa / Fastify
  • Next.js (App Router, Server Actions, Route Handlers, or Pages API routes)
  • Remix / React Router v7
  • NestJS
  • Cloudflare Workers / Node.js Serverless (AWS Lambda, Vercel Functions)

Next, head to the Quick Start Guide to initiate your first payment!