You can install the package via composer:
composer require alphaolomi/laravel-azampay
You can publish the config file with:
php artisan vendor:publish --tag="azampay-config"
MNO checkout using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->mobileCheckout([
'amount' => 1000,
'currency' => 'TZS',
'accountNumber' => '0625933171',
'externalId' => '08012345678',
'provider' => 'Mpesa',
]);
# Response
[ 'transactionId' => 'string', 'message' => 'string' ]
MNO checkout using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::mobileCheckout([
'amount' => 1000,
'currency' => 'TZS',
'accountNumber' => '0625933171',
'externalId' => '08012345678',
'provider' => 'Mpesa',
]);
# Response
[ 'transactionId' => 'string', 'message' => 'string' ]
Bank checkout using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->bankCheckout([
'amount' => 1000,
'currencyCode' => 'TZS',
'merchantAccountNumber' => '34567890987654',
'merchantMobileNumber' => '08012345678',
'merchantName' => '[email protected]',
'otp' => '1234',
'provider' => 'CRDB',
'referenceId' => '24345345',
]);
# Response
[ 'transactionId' => 'string', 'message' => 'string' ]
Bank checkout using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::bankCheckout([
'amount' => 1000,
'currencyCode' => 'TZS',
'merchantAccountNumber' => '34567890987654',
'merchantMobileNumber' => '08012345678',
'merchantName' => '[email protected]',
'otp' => '1234',
'provider' => 'CRDB',
'referenceId' => '24345345',
]);
# Response
[ 'transactionId' => 'string', 'message' => 'string' ]
Get payment partners using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->getPaymentPartners();
# Response
[
[
'logoUrl' => 'string',
'partnerName' => 'string',
'provider' => 0,
'vendorName' => 'string',
'paymentVendorId' => '1213c943-b30e-4c9e-ac2f-d34796f01d2d',
'paymentPartnerId' => '70cd6bba-7f81-4ac8-9276-d5c0a189f2d4',
'currency' => 'string'
]
]
Get payment partners using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::getPaymentPartners();
# Response
[
[
'logoUrl' => 'string',
'partnerName' => 'string',
'provider' => 0,
'vendorName' => 'string',
'paymentVendorId' => '1213c943-b30e-4c9e-ac2f-d34796f01d2d',
'paymentPartnerId' => '70cd6bba-7f81-4ac8-9276-d5c0a189f2d4',
'currency' => 'string'
]
]
Post checkout using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->postCheckout([
'appName' => 'azampay',
'clientId' => 'e9b57fab-1850',
'vendorId' => 'e9b57fab-1850-44d4-8499-71fd15c845a0',
'language' => 'en',
'currency' => 'TZS',
'externalId' => 'e9b57fab-44d4-71fd15c845a6',
'requestOrigin' => 'dukaspace.com',
'redirectFailURL' => 'dukaspace.com/failure',
'redirectSuccessURL' => 'dukaspace.com/success',
'vendorName' => 'dukaspace',
'amount' => 50000,
'cart' => [
'items' => [
[
'name' => 'dukaspace',
],
],
],
]);
# Response
[ 'transactionId' => 'string', 'message' => 'string' ]
Post checkout using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::postCheckout([
'appName' => 'azampay',
'clientId' => 'e9b57fab-1850',
'vendorId' => 'e9b57fab-1850-44d4-8499-71fd15c845a0',
'language' => 'en',
'currency' => 'TZS',
'externalId' => 'e9b57fab-44d4-71fd15c845a6',
'requestOrigin' => 'dukaspace.com',
'redirectFailURL' => 'dukaspace.com/failure',
'redirectSuccessURL' => 'dukaspace.com/success',
'vendorName' => 'dukaspace',
'amount' => 50000,
'cart' => [
'items' => [
[
'name' => 'dukaspace',
],
],
],
]);
# Response
'string'
When the package the callback from azampay it will
dispatch Event AzampayCallback::class
. You can create a
listener and do further process with the callback data which will
be pass when the event get dispatch.
On you App\Providers\EventServiceProvider
register a listener
for AzampayCallback::class
event.
use Alphaolomi\Azampay\Events\AzampayCallback;
use App\Listeners\YourEventListener;
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
AzampayCallback::class => [
YourEventListener::class,
],
];
Create transfer using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->createTransfer([
'source' => [
'countryCode' => 'string',
'fullName' => 'string',
'bankName' => 'tigo',
'accountNumber' => 'string',
'currency' => 'string',
],
'destination' => [
'countryCode' => 'string',
'fullName' => 'string',
'bankName' => 'tigo',
'accountNumber' => 'string',
'currency' => 'string',
],
'transferDetails' => [
'type' => 'string',
'amount' => 0,
'date' => '2019-08-24T141522Z',
],
'externalReferenceId' => 'string',
'remarks' => 'string',
]);
# Response
[
[
'data' => 'Transaction successful.',
'message' => 'Request successful.',
'success' => true,
'statusCode' => 200
]
]
Create transfer using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::createTransfer([
'source' => [
'countryCode' => 'string',
'fullName' => 'string',
'bankName' => 'tigo',
'accountNumber' => 'string',
'currency' => 'string',
],
'destination' => [
'countryCode' => 'string',
'fullName' => 'string',
'bankName' => 'tigo',
'accountNumber' => 'string',
'currency' => 'string',
],
'transferDetails' => [
'type' => 'string',
'amount' => 0,
'date' => '2019-08-24T141522Z',
],
'externalReferenceId' => 'string',
'remarks' => 'string',
]);
# Response
[
[
'data' => 'Transaction successful.',
'message' => 'Request successful.',
'success' => true,
'statusCode' => 200
]
]
Name lookup using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->nameLookup([
'bankName' => 'string',
'accountNumber' => 'string',
]);
# Response
[
'name' => 'string',
'message' => 'string',
'success' => true,
'accountNumber' => 'string',
'bankName' => 'string'
]
Name lookup using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::nameLookup([
'bankName' => 'string',
'accountNumber' => 'string',
]);
# Response
[
'name' => 'string',
'message' => 'string',
'success' => true,
'accountNumber' => 'string',
'bankName' => 'string'
]
Get transaction status using AzampayService Class
use Alphaolomi\Azampay\AzampayService;
$azampay = new AzampayService();
$data = $azampay->getTransactionStatus([
'bankName' => 'CRDB',
'pgReferenceId' => '10'
]);
# Response
[
[
'data': 'Transaction successful.',
'message': 'Request successful.',
'success': true,
'statusCode': 200
]
]
Get transaction status using Facade Class
use Alphaolomi\Azampay\Facades\Azampay;
$data = Azampay::getTransactionStatus([
'bankName' => 'CRDB',
'pgReferenceId' => '10'
]);
# Response
[
[
'data': 'Transaction successful.',
'message': 'Request successful.',
'success': true,
'statusCode': 200
]
]
You can find more details about azampay on their documentation in this link Azampay Documentation.
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.