sivehost/fossbilling-pesapal-mpesa

Pesapal MPESA Payment Gateway Module for FOSSBilling

dev-main 2025-03-09 11:53 UTC

This package is auto-updated.

Last update: 2025-03-09 11:54:24 UTC


README

πŸ“Œ FOSSBilling Mpesa Payment Module for Pesapal

Seamless payment processing for businesses in Kenya, Uganda, Tanzania, Malawi, Rwanda, Zambia, and Zimbabwe.

This module integrates Pesapal with FOSSBilling, enabling you to accept payments via credit cards, debit cards, and mobile money. Payments are settled directly into your local bank account.

Claim Status Graph

Invoice PDF Export

Invoice Status Graph

Claims page

Invoices page

Config page

Config page

🌍 Supported Payment Methods

πŸ“² Mobile Money Payments

βœ… MPESA (Kenya, Tanzania)
βœ… Airtel Money (Multiple countries)
βœ… MTN Money
βœ… Vodacom MPESA
βœ… Tigo Pesa

πŸ’³ Card Payments

βœ… Visa
βœ… MasterCard
βœ… American Express
βœ… Diners Club
βœ… JCB Cards

πŸ“₯ Installation

1️⃣ Install via FOSSBilling Extension Directory

The easiest way to install this module is using the FOSSBilling extension directory.

  1. Upload the Mpesa.php file into /library/Payment/Adapter/ and then Go to FOSSBilling Admin Panel.
  2. Navigate to System β†’ Payment Gateways.
  3. Search for Pesapal and click Install.
  4. Configure your API credentials and preferences.

2️⃣ Manual Installation

  1. Download the latest release from GitHub Releases.
  2. Create a new folder named Pesapal inside your FOSSBilling installation:
    /library/Payment/Adapter/Pesapal/
    
  3. Extract the downloaded files into the new Pesapal directory.
  4. Go to Admin Panel β†’ System β†’ Payment Gateways.
  5. Find Pesapal under the "New Payment Gateway" tab.
  6. Click the cog icon to install and configure Pesapal.

βš™οΈ Configuration

Once installed, configure Pesapal in FOSSBilling:

πŸ”‘ Enter API Credentials

  1. Navigate to System β†’ Payment Gateways β†’ Pesapal.
  2. Enter your Pesapal API Keys .
    • Find these in your Pesapal Dashboard.

πŸ”§ Customize Preferences

  • Enable sandbox mode for testing transactions before going live.
  • Enable transaction logging for debugging.

βœ… Save & Test

  1. Click Save Changes.
  2. Run a test transaction in sandbox mode.
  3. Once successful, switch to live mode to start accepting real payments.

πŸš€ Why Use This Module?

βœ” Fast & Secure: Accept payments in multiple currencies and payment methods.
βœ” Easy Setup: Install in just a few clicks.
βœ” Seamless Integration: Works directly with FOSSBilling’s invoicing system.
βœ” Automatic Settlements: Funds are settled into your local bank account.

🀝 Contributing

We welcome contributions! πŸš€

  • Found a bug? Open an issue in GitHub.
  • Want to improve the module? Submit a pull request.

To contribute:

git clone https://github.com/sivehost/fossbilling-pesapal-mpesa.git
cd fossbilling-pesapal-mpesa
git checkout -b feature-branch

Make your changes, commit, and submit a pull request.

πŸ“œ License

This module is licensed under the GNU General Public License v3.0.
See LICENSE for details.

πŸ“ž Support

For help, visit:

πŸ“’ Start Accepting Payments Today!

➑ Download the latest version and get started! πŸš€