README

A Laravel Package for integrating with Tumeny Pay

This Laravel package integrates Tumeny Pay as a payment gateway into your Laravel application.

Installation

Install the package via Composer:
```
composer require shengamo/tumeny-pay
```

Publish the package migrations:

php artisan vendor:publish --tag=Shengamo\TumenyPay\TumenyPayServiceProvider

Add the following environment variables to your .env file:

TUMENY_KEY=your_tumeny_key
TUMENY_SECRET=your_tumeny_secret
TUMENY_BASE_URL=https://tumeny.herokuapp.com/api/

Usage

Payment Request

To initiate a payment request, you can use the processPayment method provided by the TumenyPay class.

use Shengamo\TumenyPay\TumenyPay;

$tumeny = new TumenyPay();
$tumeny->processPayment('amount', 'plan name or default', 'Zambian mobile number', 'quantity of items', 'description');

// e.g. request a payment of K100 from the mobile number 0961234567.
$tumeny->processPayment(100, 'default', '0961234567', 1, 'custom description');

Setup the verification of payments

To automatically verify pending order payments, add the following line to the schedule function in your App\Console\Kernel.php file:

use Shengamo\TumenyPay\Jobs\VerifyPendingOrderPayments;

$schedule->job(new VerifyPendingOrderPayments())->everyMinute();

Events & Listeners

Events are fired when ShengamoOrder is generated and also when the ShengamoOrder has been updated. You could register these events in the EventServiceProvider. If you would like to handle an action, for example, if you would like to add a subscription if the order is successful, you could create an event listener that listens to the ShengamoOrderCreated Event.

For example, after creating a AddSubscriptionListener Listener class, the code below would handle subscription if order is successful.

class AddSubscriptionListener
{
    public function __construct()
    {
        //
    }

    public function handle(ShengamoOrderUpdated $event): void
    {;
        //If the order status is successful or 2
        if($event->shengamoOrder->status === 2)
        {
         // Add the subscription here
        }
    }
}

Add the events and listener in your App\Providers\EventServiceProvider like the example below.

    protected $listen = [
        
        ShengamoOrderUpdated::class => [
            AddSubscriptionListener::class
        ],

    ];

Manually firing the verification

In order to manually verify all the pending transactions in your shengamo_orders table, you can ran the artisan command.

php artisan tumeny:verify

Testing

./vendor/bin/phpunit

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email mo@shengamo.com instead of using the issue tracker.

Credits

Mo Malenga

License

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

shengamo / tumeny-pay

Maintainers

Details