rais/momo-suite

Mobile Money Payment Suite for Laravel

1.0.0 2025-05-20 12:11 UTC

Requires

• php: ^8.0 || ^8.1 || ^8.2
• guzzlehttp/guzzle: ^7.2
• illuminate/console: ^8.0 || ^9.0 || ^10.0 || ^11.0
• illuminate/contracts: ^8.0 || ^9.0 || ^10.0 || ^11.0
• illuminate/support: ^8.0 || ^9.0 || ^10.0 || ^11.0

MIT

• Rais

README

📚 Documentation

A powerful, flexible Mobile Money Payment Suite for Laravel supporting multiple providers (Paystack, Hubtel, ITC, Korba, and more).

Features

• Unified API for sending and receiving mobile money across multiple providers
• Webhook/callback handling
• Transaction logging and status tracking
• Extensible provider system
• Laravel 8, 9, 10, 11 support (PHP 8+)
• Korba is used as the default provider if none is set.

Installation

composer require rais/momo-suite

Configuration

You should publish all package assets (config, migrations, views, routes, public) with:

php artisan vendor:publish --provider="Rais\MomoSuite\MomoSuiteServiceProvider"

1. Set up your provider credentials in config/momo-suite.php.

2. Run migrations:

   php artisan migrate

3. Dashboard UI & Admin User

   • Enable the dashboard by setting MOMO_SUITE_LOAD_DASHBOARD=true in your .env file
   • The views will be published to resources/views/vendor/momo-suite
   • Note: Publishing views will make it harder to receive view updates from the package

   👤 Create an Admin User

   You can create an admin user for the system using the provided Artisan command.

   🔹 Option 1: Create Default Admin

   php artisan momo-suite:create-admin --default

   ⚠️ Note: This will create a default admin user with the following credentials:

   • Email: [e-mail]
   • Password: password ✅ Important: You should log in and change these credentials immediately after your first login for security reasons.

   🔹 Option 2: Create Custom Admin

   php artisan momo-suite:create-admin

   This will prompt you to enter the admin's name, email, and password manually during execution.

Usage

Sending Money

Usage Examples

Available network providers for the network parameter:

• MTN
• TELECEL
• AIRTELTIGO

Receive Money (Korba, default provider)

$momo = app('momo-suite');

$receive = $momo->receive([
    'phone' => '0241234567',
    'amount' => 1.00,
    'network' => 'MTN',
    'reference' => 'Testing',
    'meta' => [
        'customer_name' => 'User one',
        'customer_email' => '[e-mail]',
    ], // optional
]);

Send Money (Korba, default provider)

$momo = app('momo-suite');

$send = $momo->send([
    'phone' => '0241234567',
    'amount' => 1.00,
    'network' => 'MTN',
    'reference' => 'Test sending money',
]);

Use a Specific Provider (e.g., Hubtel)

$momo = app('momo-suite');
$momo->setProvider('hubtel');

$send = $momo->send([
    'phone' => '0241234567',
    'amount' => 1.00,
    'network' => 'MTN',
    'reference' => 'Test Payment',
    'customer_name' => 'username', // Required for Hubtel
]);

Receive Money with Hubtel

$momo = app('momo-suite');
$momo->setProvider('hubtel');

$receive = $momo->receive([
    'phone' => '0241234567',
    'amount' => 1.00,
    'network' => 'MTN',
    'reference' => 'Test Payment',
    'customer_name' => 'username', // Required for Hubtel
]);

Send Money using Facade (Hubtel)

use Rais\MomoSuite\Facades\Momo;

Momo::setProvider('hubtel');

$send = Momo::send([
    'phone' => '0241234567',
    'amount' => 1.00,
    'network' => 'MTN',
    'reference' => 'Test Disbursement',
    'customer_name' => 'username', // Required for Hubtel
]);

Receive Money with Paystack

$momo = app('momo-suite');
$momo->setProvider('paystack');

$receive = $momo->receive([
    'phone' => '0241234567',
    'amount' => 1.00,
    'email' => '[e-mail]', // Required for Paystack
    'network' => 'MTN',
    'reference' => 'Test receive Payment',
]);

Send Money with Paystack

$momo = app('momo-suite');
$momo->setProvider('paystack');

$send = $momo->send([
    'phone' => '0241234567',
    'amount' => 1.00,
    'email' => '[e-mail]', // Required for Paystack
    'network' => 'MTN',
    'customer_name' => 'username', // Required for Paystack
    'reference' => 'Test',
]);

Verify OTP with Paystack

$momo = app('momo-suite');
$momo->setProvider('paystack');

$otp = $momo->verifyOtp([
    'otp' => '123456',
    'reference' => 'transaction-reference',
]);

Receive Money with ITC

$momo = app('momo-suite');
$momo->setProvider('itc');

$receive = $momo->receive([
    'phone' => '0241234567',
    'amount' => 1,
    'network' => 'MTN',
    'reference' => 'Testing ITC',
]);

Send Money with ITC

$momo = app('momo-suite');
$momo->setProvider('itc');

$send = $momo->send([
    'phone' => '0241234567',
    'amount' => 0.5,
    'network' => 'MTN',
    'reference' => 'Test Disbursement ITC',
]);