algoetech/openapi_mpesa

Easy OpenAPI integration for Laravel Applications

0.01 2024-06-23 17:13 UTC

Requires

• php: ^8.0
• illuminate/contracts: ^7.0|^8.0|^9.0|^10.0
• openpesa/pesa: 0.1.0
• spatie/laravel-package-tools: 1.16.4

Requires (Dev)

• larastan/larastan: ^2.1.11
• nunomaduro/collision: ^7.0
• orchestra/testbench: ^6.0|^7.0|^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^10.1

MIT

• Aman S. Tairo

README

Offers effortless integration with mobile money operators, such as Vodacom's M-Pesa, for seamless inclusion in your Laravel applications. 💰

Documentation

🚧 Work in Progress

For detailed instructions on package usage, please refer to the example readme available here.

🚀 Installation

You can install the package via Composer:

composer require algoetech/openapi_mpesa

💼 Usage

Using Facades

*Web|api Route

    Route::post('/pay', [PaymentController::class, 'payment'])->name('payments_api');

*Controller [ PaymentController ]

use Openpesa\Pesa\Facades\Pesa;

// This function will be mapped to web|api route: `your-URL/api/pay`
// assuming you have data captured from a form 
public function payment(PaymentApiRequest $req) {
    $response = Pesa::c2b([
        'input_Amount' => $req->price, // Amount to be charged
        'input_Country' => 'TZN',
        'input_Currency' => 'TZS',
        'input_CustomerMSISDN' => '255'.$req->msisdn, // assuming you capture phone number without country code and zero
        'input_ServiceProviderCode' => '000001', // Replace with your service provider code given by M-Pesa
        'input_ThirdPartyConversationID' => 'mpesatz', // Unique [use a rand function to isolate ConversationId]
        'input_TransactionReference' => 'imethibitishwa', // Unique []
        'input_PurchasedItemsDesc' => $req->item
    ]);
    
    // make your logics to handle responses here
    return $response;
};

💼 Usage

composer test

👥 Credits

• All Contributors

📄 License

The MIT License (MIT). Please see License File for more information.