FinConnect

A unified wrapper for East African fintech payment providers

Features • Quick Start • Supported Providers • Documentation • Contributing

---

Overview

FinConnect is a lightweight, provider-agnostic integration wrapper that simplifies payment processing across multiple East African fintech platforms. Instead of managing different authentication flows, payload structures, and error handling for each provider, FinConnect provides a single, unified API for PesaPal, AzamPay, ClickPesa, and more.

The Problem We Solve

Integrating multiple payment providers typically requires:

• Learning different authentication flows (OAuth2 vs. JWT)
• Managing different payload structures per provider
• Implementing custom error handling for each API
• Maintaining complex provider-specific logic

FinConnect eliminates this complexity with a consistent, developer-friendly interface.

---

✨ Features

• 🔌 Provider-Agnostic API - Single interface for multiple payment providers
• 🔐 Multi-Auth Support - OAuth2, JWT, Bearer tokens handled transparently
• ⚡ Type-Safe - Full TypeScript support with complete type definitions
• 🌍 Regional Coverage - PesaPal (East Africa), AzamPay (Tanzania), ClickPesa (East Africa)
• 🛡️ Error Handling - Consistent error messages and status tracking
• 🔄 Async/Await Ready - Modern async patterns throughout
• 📝 Well-Documented - Comprehensive examples and API documentation

---

🚀 Quick Start

Prerequisites

• Node.js 16.x or later
• npm 7.x or later

Installation

npm install finconnect

Or from the repository source:

# Clone the repository
git clone https://github.com/somebody1011/finconnect.git

# Navigate to project directory
cd finconnect

# Install dependencies
npm install

Configuration

Create a .env file in your root directory with your provider credentials:

# PesaPal Configuration
PESAPAL_APP_KEY=your_key
PESAPAL_APP_SECRET=your_secret


# AzamPay Configuration
AZAMPAY_SECRET=your_secret

# ClickPesa Configuration
CLICKPESA_CLIENT_ID=your_id
CLICKPESA_API_KEY=your_api_key

Basic Usage

import { FintechGateway } from './src/index';

// Initialize gateway for pesapal
const gateway = new FintechGateway('pesapal', {
  apiKey: process.env.PESAPAL_CONSUMER_KEY,
  apiSecret: process.env.PESAPAL_CONSUMER_SECRET,
  shortCode: '174379',
  environment: 'sandbox'
});

// Process a payment
async function processPayment() {
  try {
    const response = await gateway.processPayment({
      amount: 1000,
      phoneNumber: '255700000000',
      reference: 'REF-99'
    });

    if (response.success) {
      console.log(`✅ Payment successful! Transaction ID: ${response.transactionId}`);
    } else {
      console.error(`❌ Payment failed: ${response.message}`);
    }
  } catch (error) {
    console.error('Error processing payment:', error);
  }
}

processPayment();

---

🏗️ Supported Providers

Provider	Status	Auth Method	Region(s)
ClickPesa	🚧🛠️ Onprogress	JWT	East Africa
PesaPal	🚧🛠️ Onprogress	OAuth2	East Africa
AzamPay	🚧🛠️ Onprogress	Bearer/Secret	Tanzania
snippe	📋 Planned	Bearer/Secret	Tanzania

---

📚 API Reference

FintechGateway

Constructor

new FintechGateway(provider: string, config: ProviderConfig)

Parameters:

• provider - The payment provider identifier ('pesapal', 'azampay', 'clickpesa')
• config - Provider-specific configuration object

Methods

processPayment()

processPayment(params: PaymentParams): Promise<PaymentResponse>

Parameters:

interface PaymentParams {
  amount: number;
  phoneNumber: string;
  reference: string;
  description?: string;
}

Returns:

interface PaymentResponse {
  success: boolean;
  transactionId?: string;
  message: string;
  status: 'pending' | 'completed' | 'failed';
  timestamp: Date;
}

Example:

const result = await gateway.processPayment({
  amount: 5000,
  phoneNumber: '254712345678',
  reference: 'ORD-2024-001',
  description: 'Payment for order #123'
});

---

📁 Project Structure

finconnect/
├── src/
│   ├── index.ts        # Main gateway class
│   ├── providers/
│   │   ├── BaseProvider.ts      # Abstract base class
│   │   ├── MpesaProvider.ts     # M-Pesa implementation
│   │   ├── AzampayProvider.ts   # AzamPay implementation
│   │   └── ClickpesaProvider.ts # ClickPesa implementation
├── tests/
│   ├── unit/
│   └── integration/
├── .env.example
├── package.json
├── tsconfig.json
├── jest.config.js
└── README.md

---

🔒 Security Best Practices

1. Never commit credentials - Use .env files and add them to .gitignore
2. Use environment variables - Store sensitive keys outside version control
3. Validate inputs - Always validate payment amounts and phone numbers
4. HTTPS only - All API calls are made over HTTPS
5. Error messages - Avoid exposing sensitive details in error responses

Example:

// ❌ DO NOT DO THIS
const gateway = new FintechGateway('pesapal', {
  apiKey: 'your_actual_key_here'
});

// ✅ DO THIS
const gateway = new FintechGateway('pesapal', {
  apiKey: process.env.PESAPAL_CONSUMER_KEY,
  apiSecret: process.env.PESAPAL_CONSUMER_SECRET
});

---

🗺️ Roadmap

• ClickPesa integration
• PesaPal integration
• AzamPay integration
• Add comprehensive unit tests using Jest
• Add B2C (Business to Customer) support
• Implement automatic retry logic for failed API calls
• Add rate limiting and throttling
• Support for transaction status polling
• Webhook integration for payment notifications
• SDK for React Native

---

🤝 Contributing

We welcome contributions! Here's how to get started:

1. Fork the repository on GitHub
2. Create a feature branch for your changes:

   git checkout -b feature/add-new-provider

3. Add a new provider (if applicable):
   • Create a new file in src/providers/ (e.g., NewProviderName.ts)
   • Extend the BaseProvider class
   • Implement required methods: authenticate(), processPayment(), getTransactionStatus()
4. Add tests for your changes:

   npm test

5. Commit your changes with clear messages:

   git commit -m "Add support for XYZ provider"

6. Push to your fork and submit a Pull Request

Development Setup

# Install dev dependencies
npm install --save-dev

# Run tests
npm test

# Build the project
npm run build

# Lint the code
npm run lint

---

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

📞 Support & Contact

• Issues - Report bugs or request features via GitHub Issues
• Discussions - Join our community discussions here
• Author - @somebody1011

---

🙏 Acknowledgments

• Built with ❤️ for the East African fintech community
• Inspired by Stripe's elegant API design
• Special thanks to all contributors and early users
• Thanks to the open-source community for amazing tools and libraries

---

Made with ❤️ by somebody1011

⭐ Star us on GitHub! somebody1011/finconnect