@fundkit/tingg
v1.8.0
Published
Tingg payment provider integration for FundKit
Readme
@fundkit/tingg
Tingg payment provider integration for FundKit
📦 Installation
npm install @fundkit/core @fundkit/tingg
# or
yarn add @fundkit/core @fundkit/tingg
# or
pnpm add @fundkit/core @fundkit/tinggGet Your API Key
Before you start, you'll need a FundKit API key. Get yours at fundkit.dev - it's free to get started!
Quick Start
import { PaymentClient } from '@fundkit/core';
import { Tingg } from '@fundkit/tingg';
// Initialize Tingg provider
const tingg = new Tingg({
apiKey: process.env.TINGG_API_KEY!,
publicKey: process.env.TINGG_PUBLIC_KEY!,
});
// Use with FundKit client
const client = new PaymentClient({
apiKey: process.env.FUNDKIT_API_KEY!,
providers: [tingg],
environment: 'sandbox',
});
// Process payment
const transaction = {
amount: 5000,
currency: 'KES',
operator: 'safaricom',
accountNumber: '254701234567',
externalId: 'tx_' + Date.now(),
};
const response = await client.collection(transaction);
console.log('Tingg payment:', response);Configuration
Required Configuration
interface TinggConfig {
apiKey: string; // Your Tingg API key
publicKey: string; // Your Tingg public key
}Environment Variables
TINGG_API_KEY=your_api_key_here
TINGG_PUBLIC_KEY=your_public_key_here🌍 Supported Features
- Mobile money payments across Africa
- Multiple currencies (KES, UGX, TZS, RWF, MWK, ZMW, ZWL)
- Transaction status checking
- Real-time notifications
- Sandbox and production environments
- High uptime (98%) across all supported countries
🌍 Supported Countries
Tingg supports mobile money payments in the following countries:
- Kenya (KES) - Safaricom M-Pesa, Airtel Money
- Uganda (UGX) - MTN MoMo, Airtel Money
- Tanzania (TZS) - M-Pesa, Tigo Pesa, Airtel Money
- Rwanda (RWF) - MTN MoMo, Airtel Money
- Malawi (MWK) - Airtel Money, TNM Mpamba
- Zambia (ZMW) - MTN MoMo, Airtel Money
- Zimbabwe (ZWL) - EcoCash, OneMoney
API Reference
Tingg Class
class Tingg extends BaseProvider {
constructor(config: TinggConfig);
async collection(transaction: Transaction): Promise<CollectionResponse>;
async getTransaction(txId: string): Promise<TransactionStatus>;
getCoverage(): CoverageMap;
}Related Documentation
Development
This package is part of the FundKit monorepo. For development setup:
- Clone the FundKit repository
- Install dependencies:
bun install - Build packages:
bun run build - Run tests:
bun test
License
MIT License - see the LICENSE file for details.
