README

Prerequisites

You will need the following to get started with you integration...

Create an application on the AirtelMoney Developer Portal.
Write to the AirtelMoney Support Team to get your application approved, here.

Note: Your application won't work until it's approved. You can check the statuses in the portal.

Status	Explanation
NA	Not Approved
Partially Approved	UAT Approved
Approved	PROD Approved

Getting started

Installation

composer require bmatovu/laravel-airtel-money

Publishables

php artisan vendor:publish --provider="Bmatovu\AirtelMoney\AirtelMoneyServiceProvider"

Migrations

php artisan migrate

Authentication & PIN

Set credentials

Get the client_id and client_secret from Key Management

php artisan airtel-money:auth

Set disbursement PIN

php artisan airtel-money:pin

Usage

Authentication & KYC

use Bmatovu\AirtelMoney\Facades\AirtelMoney;

$token = AirtelMoney::getToken();

$user  = AirtelMoney::getUser($phoneNumber);

Collections

use Bmatovu\AirtelMoney\Facades\Collection;

$transaction = Collection::receive($phoneNumber, $amount);

$transaction = Collection::refund($airtelMoneyId);

$transaction = Collection::getTransaction($transactionId);

$balance     = Collection::getBalance();

Disbursement

use Bmatovu\AirtelMoney\Facades\Disbursement;

$transaction = Disbursement::send($phoneNumber, $amount);

$transaction = Disbursement::getTransaction($transactionId);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

bmatovu / laravel-airtel-money

Maintainers

Details