eyowo-php
A PHP API wrapper for Eyowo.
Requirements
- Curl 7.34.0 or more recent (Unless using Guzzle)
- PHP 5.4.0 or more recent
- OpenSSL v1.0.1 or more recent
Install
Via Composer
$ composer require djunehor/eyowo-php
Usage
1. Get your API KEYS
- Goto Eyowo Developer Portal
- Register and Login
- Create an app
2. configure package (optional)
- Add
EYOWO_APP_KEY
andEYOWO_APP_SECRET
to your.env
and set the values
3. Initialise API
use Djunehor\Eyowo\Api;
$eyowo = new Api($appKey); //if appKey is not passed, package uses value in .env
Validate a user
// phone should be in the format 2348020000000
$eyowo->validate($phone);
Authenticate user
// sends SMS to user phone
$eyowo->initiateAuthorization($phone);
// $code is the 6-digit number send to user phone
$eyowo->generateToken($phone, $code);
[
'success' => true,
'data' => [
'accessToken' => kjaskajs7a8s6as7a7s68a,
'refreshToken' => askhas7a7s6a7yajgsa67u
]
$walletToken = $eyowo->getAccessToken();
$refreshToken = $eyowo->getRefreshToken();
Refresh Token
$eyowo->refreshToken($refreshToken);
Get banks
$output = $eyowo->banks();
[
'success' => true,
'data' => [
'banks' => [
[
"bankCode" => "090270",
"bankName" => "AB MICROFINANCE BANK"
]
...
]
]
]
$banks = $eyowo->getBanks();
[
"bankCode" => "090270",
"bankName" => "AB MICROFINANCE BANK"
]
...
]
Transfer to phone
//amount should be in kobo
$eyowo->transferToPhone($walletToken, $amount, $phone);
Transfer to bank
//amount should be in kobo
$eyowo->transferToPhone($walletToken, $amount, $accountName, $accountNumber, $bankCode);
Wallet Balance
$eyowo->balance($walletToken); returns raw API response
$balance = $eyowo->getBalance(); // returns int|float
VTU
// provider has to be one of ['mtn', 'glo', 'etisalat', 'airtel'];
$eyowo->vtu($walletToken, $amount, $phone, $provider);
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
- Clone this repo
- Run
composer install
- Run
cp .env.sample .env
- Set your API keys in
.env
- Run
composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details. Check our todo list for features already intended.
Security
If you discover any security related issues, please email yabacon.valley@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.