1APP Laravel Library
Learn how to integrate our APIs to build a web or mobile integration to accept payments, make payment of Bills and as well custom integration for your application and businesses. On this page, we'll go over some payment services we offer to give you a quick overview of what is obtainable with 1app.
## Installation
composer require oneapp/oneapp
Configuration
You can publish the configuration file using this command:
php artisan vendor:publish --provider="Oneapp\Oneapp\OneappServiceProvider"
A configuration-file named oneapp.php with some sensible defaults will be placed in your config directory:
<?php
return [
/**
* The secret key from 1app Dashboard
*/
'secretKey' => getenv('ONEAPP_SECRET_KEY'),
/**
* the public key from 1app Dashboard
*/
'publicKey' => getenv('ONEAPP_PUBLIC_KEY'),
/**
* 1app Payment gateway url
*/
'baseUrl' => getenv('ONEAPP_PAYMENT_URL'),
];
# Usage
Open your .env file and add your public key, secret key, payment url like so:
ONEAPP_SECRET_KEY=
ONEAPP_PUBLIC_KEY=
ONEAPP_PAYMENT_URL=https://api.1app.online/v1
If you are using a hosting service like heroku, ensure to add the above details to your configuration variables.
Bills
Instantiate 1app
$oneapp = new Oneapp();
Check Account Balance
$oneapp->checkBalance();
Send Money
//defined request types
$moneypayload = [
'amount' => '', //string
'bankcode'=> '', //string
'bankname'=> '', //string
'reference'=> '', //string
'accountno'=> '', //string
'narration'=> '', //string
'currency'=> '', //string
'acctname'=> '' //string
];
$oneapp->sendMoney(array $moneypayload);
//sample request
$moneypayload = [
'amount' => '100',
'bankcode'=> '000013',
'bankname'=> 'GT BANK',
'reference'=> 'shudgyutg876542',
'accountno'=> '0245000000',
'narration'=> 'Transfer to client',
'currency'=> 'NGN',
'acctname'=> 'John Doe'
];
Data Plans
Get Data List for the provided Provider
//providers 'MTN' || 'GLO' || 'AIRTEL' || '9MOBILE'
$ntwk = 'MTN';
$oneapp->dataPlans($ntwk);
Purchase Data Bundle
//defined request types
$dataB = [
'datacode' => '', //string
'network_id' => '', //string
'phoneno' => '', //string
'reference' => '' //string
];
$oneapp->dataBundle(array $dataB);
//sample request
// Network ID - GLO = 1, MTN = 2, AIRTEL = 3, 9MOBILE = 4
$dataB = [
'datacode' => '1000',
'network_id' => '2',
'phoneno' => '07012345678',
'reference' => 'DJIEJ2MEUE2EN34'
];
Purchase Airtime
$phoneDet = [
'phoneno' => '', //string
'network_id' => '', //string
'reference' => '', //string
'amount' => '' //string
];
$oneapp->airtime($phoneDet);
//Sample Request
// Network ID - GLO = 1, MTN = 2, AIRTEL = 3, 9MOBILE = 4
$phoneDet = [
'phoneno' => '07012345678',
'network_id' => '2',
'reference' => 'O4I3U8SRNYOIYT',
'amount' => '100'
];
Verify Electricity
$electDet = [
'meterno' => '', //string
'provider' => '', //string
];
$oneapp->verifyElectricity($electDet);
//Sample Request
$electDet = [
'meterno' => '78632746282',
'provider' => 'KANO',
];
Buy Electricity
$vendDet = [
'meterno' => '', //string
'metername' => '', //string
'provider' => '', //string
'amount' => '', //string
'vendtype' => '', //string
'reference' => '' //string
];
$oneapp->vendElect($vendDet);
$vendDet = [
'meterno' => '67537283728',
'metername' => 'JOHN DOE',
'provider' => 'KANO',
'amount' => '100',
'vendtype' => 'PREPAID',
'reference' => 'O4I3U8SRNYOIYT'
];
Get Cable TV Lists
Get Cable TV List for the provided Provider
//providers 'DSTV' || 'GOTV' || 'STARTIMES'
$tv = 'STARTIMES';
$oneapp->getCableTV($tv);
Verify IUC
$iuc = ''; //string
$type = ''; //string
$oneapp->verifyCable($type, $iuc);
//Sample Request
$iuc = '87675656325',
$type = 'DSTV'
Purchase Cable TV
$buyCable = [
'tvno' => '', //string
'tv' => '', //string
'custname' => '', //string
'custno' => '', //string
'amount' => '', //string
'reference' => '' //string
];
$oneapp->buyCableTV($buyCable);
//sample request
$buyCable = [
'tvno' => '87675656325',
'tv' => 'DSTV',
'custname' => 'JOHN DOE',
'custno' => '171747582',
'amount' => '50',
'reference' => 'OI8UYTEFYDTYTG7'
];
Get Bank Lists
$oneapp->getBankList();
Payments
Initialize Payments
$trans = [
'amount' => '', // string,
'fname' => '', // string,
'lname' => '', // string,
'customer_email' => '', // string,
'phone' => '', // string,
'reference' => '', // string,
'currency' => '', // string,
'redirecturl' => '', // string
];
$oneapp->initTrans($trans);
//sample request
$trans = [
"amount"=> '1000',
"fname"=> 'John',
"lname"=> 'Doe',
"customer_email"=> '[email protected]',
"phone"=> '0801234567789',
"reference"=> 'OI8UYTEFYDTYTG7',
"currency"=> 'NGN', //NGN or USD supported for now
"redirecturl"=> 'https://mywebsite.com'
];
Verify transaction
$reference = ''; //string
$oneapp->verifyTrans($reference);
//sample request
'reference' = 'OI8UYTEFYDTYTG7';
Transaction Lists
//Get Transaction List
$oneapp->transList();
Get Transaction Details
$reference = ''; //string
$oneapp->getTrans($reference);
//sample request
'reference'=> 'OI8UYTEFYDTYTG7';
Get Customers
$oneapp->getCusts();
Get Payouts / Settlements
$oneapp->payouts();
Get Payouts / Settlements Transactions
$reference = ''; //string
$oneapp->getPayoutTrans($reference);
//sample request
'reference'=> 'OI8UYTEFYDTYTG7';
Disputes
$oneapp->disputes();
Accept Disputes
$accept = [
'sesscode' => '', //string,
'userid' => '', // int,
'businessid' => '', //int,
'disputeid' => '', // int,
'transref' => '', // string,
'customername' => '', // string,
'customeremail' => '',// string,
'customerphone' => '', // string,
'dclaim' => '', // string,
'torefund' => '', // int,
];
$oneapp->acceptDispute($accept);
//sample request
$accept = [
'sesscode' => '123456',
'userid' => 1,
'businessid' => 2,
'disputeid' => 1,
'transref' => 'OI8UYTEFYDTYTG7',
'customername' => 'John Doe',
'customeremail' => '[email protected]',
'customerphone' => '09034568931',
'dclaim' => 'shoe purchase', //service offered
'torefund' => 10000, //amount to refund
];
Decline Disputes
$decline = [
'sesscode' => '', //string
'userid' => '', //string
'businessid' => , //int
'disputeid' => , //int
'txref' => '', //string
'name' => '', //string
'email' => '', //string
'phone' => '', //string
'claim' => '', //string //service offered
'descres' => '', //string //decline reason
'receipt' => '', //string //evidence of decline, File Upload
];
$oneapp->rejectDispute($decline);
//sample request
$decline = [
'sesscode' => '12345',
'userid' => '1234',
'businessid' => 3,
'disputeid' => 3,
'txref' => 'OI8UYTEFYDTYTG7',
'name' => 'John Doe',
'email' => '[email protected]',
'phone' => '080XXXXXX98',
'claim' => 'shoe purchase', //service offered
'descres' => 'no error in transaction', //decline reason
'receipt' => 'receipt.jpeg', //evidence of decline, File Upload
];
Wallet
Create Wallet
$details = [
'apptoken' => '', //string
'fname' => '', //string
'sname' => '', //string
'email' => '', //string
'phoneno' => '', //string
'auth' => '', //string
'referby' => ''
];
$oneapp->createWallet($details);
//Sample Request
$details = [
'apptoken' => 'APPID',
'fname' => 'testname',
'sname' => 'testsurname',
'email' => '[email protected]',
'phoneno' => '08000000000',
'auth' => 'D@tqj8265',
'referby' => ''
];
1app Web Documentation
Credits
License
The MIT License (MIT). Please see License File for more information.
119 Nov 25, 2022
3 Sep 10, 2022
2.5k Jan 6, 2023
5.8k Jan 3, 2023
2 Sep 25, 2021
17 Dec 27, 2022
5 Jun 27, 2022
7 Sep 29, 2022
31 Oct 13, 2022
2 Oct 25, 2022
16 Nov 3, 2022
2.4k Jan 9, 2023
1 Oct 19, 2021
2 May 19, 2022
11 Dec 20, 2022
6 Aug 11, 2022
11 Aug 27, 2022
117 Dec 26, 2022
8.4k Dec 30, 2022