Skip to content

Latest commit

Β 

History

History
98 lines (64 loc) Β· 2.64 KB

README.md

File metadata and controls

98 lines (64 loc) Β· 2.64 KB

AxonJs Logo

@axonlabs/payments

πŸ’³ Modular, type-safe payment gateway clients for Node.js β€” with first-class TypeScript, ESM exports, and real-world API support.


πŸš€ What is this?

@axonlabs/payments is a unified payment client library for Node.js applications β€” built with TypeScript, ESM, and modern developer ergonomics in mind.

Whether you're integrating Plisio, Zarinpal (more payment clients will coming soon) this package gives you:

  • 🧩 Gateway-specific clients with type-safe methods
  • πŸ”Œ Easy plug-and-play usage
  • πŸ”„ Common interfaces for consistency
  • ⚑️ Fully tree-shakable via ESM exports
  • πŸ“¦ Single package, clean structure

Project Changelog


πŸ“¦ Supported Gateways

Gateway Import Path Status
Plisio @axonlabs/payments/plisio πŸ§ͺ In progress
Zarinpal @axonlabs/payments/zarinpal 🚧 In Future

Want to contribute a gateway? PRs are welcome!


πŸ§ͺ Example Usage

// Plisio
import { PlisioClient } from '@axonlabs/payments/plisio';

const plisio = new PlisioClient(secret_key, "whitelabel");

// Central hub
import { Payments, AxonPayments } from '@axonlabs/payments';

const plisio1 = Payments.getPlisio(secret_key, "whitelabel");
const plisio2 = new AxonPayments().getPlisio(secret_key, "whitelabel");

Each gateway is designed to be self-contained and follow a consistent interface.


🧠 Philosophy

  • βœ… ESM-first β€” optimized for modern tooling
  • βš™οΈ Shared interfaces, custom configs, and low-level control
  • πŸ§ͺ Testable clients for real-world server environments
  • 🌍 Multi-gateway ready in a single unified package

πŸ“‚ Import Structure

// Plisio
import { PlisioClient } from '@axonlabs/payments/plisio';
// Central hub
import { Payments, AxonPayments } from '@axonlabs/payments';

πŸ“œ License

MIT Β© AxonJsLabs


πŸ™Œ Contribute

We ❀️ open-source! Feel free to open issues, suggest improvements, or add new gateway clients.

npm install
npm run build
npm run test

Want to add your own gateway (e.g. NowPayments, IDPay, PayPal)? Check the lib/ folder and follow the structure.

Built with πŸ’œ by the AxonJsLabs community