Cashless SDK

Cashless payment gateway SDK for Node.js and TypeScript.

Installation

npm install @cashless/sdk

Quick Start

import { cashless } from '@cashless/sdk';

// Initialize with API credentials
const api = cashless.api.live('your-api-key', 'your-api-secret');
// or for sandbox:
// const api = cashless.api.sandbox('your-api-key', 'your-api-secret');

// Create a bill
const billParams = new cashless.BillParams(
  '+255712345678',  // mobile
  10000,            // amount
  'reference-123'   // reference
);

const bill = await api.issue(billParams);
console.log('Bill ID:', bill.id);
console.log('Payment URL:', bill.paymentUrl);

API Reference

Initialization

// Live environment
const api = cashless.api.live(apiKey, apiSecret);

// Sandbox environment
const api = cashless.api.sandbox(apiKey, apiSecret);

Creating a Bill

const billParams = new cashless.BillParams(
  mobile,     // Phone number (e.g., '+255712345678')
  amount,     // Amount in cents (e.g., 10000 for 100.00)
  reference   // Unique reference for tracking
);

const bill = await api.issue(billParams);

Checking Bill Status

const bill = await api.get(billId);
console.log('Status:', bill.status);
console.log('Paid:', bill.paid);

Requirements

• Node.js >= 14.0.0
• TypeScript >= 4.0 (optional, for TypeScript projects)

License

Apache-2.0

Documentation

For complete documentation, visit: https://github.com/cashless/sdk

Support

• Issues: https://github.com/cashless/sdk/issues
• Email: [email protected]