Get started

                API Base Endpoint
                https://api.easily.ng/thirdpartyapp/
            

The Easily API is a RESTful API that allows you to integrate our platform services on your application.

To use this API, you need an API Key and API Secret Key. You would also optionally need your Account Code. Please contact us at hello@easily.ng to get your own API key or click here.

Our API gives you access to virtually all user features on your account on our platform and avail them for use in your application.

Easily offers a wider range of services and digital solutions tailored for businesses and enterprises. You can buy power, gas, internet, cable TV, talk-time, and access finance - all in one app.

Easily's target market are individuals and businesses seeking a more convenient way to manage home and business needs.

Sign-up to Easily for Business and earn a commission when customers in your community pay for power, gas, cable TV and more through you.

User Registration


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/adduser 
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'username' 
-D 'email' 
-D 'phone' 
-D 'password'
                

To create a new user account on the platform :
https://api.easily.ng/thirdpartyapp/adduser



Response example :

{ 
    "status" - STRING (action status which is either success or failed) 
    "message" - STRING (server status message e.g "Registration successful!") 
    "userid" - INT (Logged in user's unique ID) 
    "username" - STRING (Logged in user's username) 
    "useremail" - STRING (Logged in user's email) 
    "userimage" - STRING (Logged in user's photo absolute URL) 
    "logintoken" - STRING (Logged in user's authentication login token) 
}
                

QUERY PARAMETERS

Field Type Description
username STRING New user's username
email STRING New user's email address
phone INT New user's phone number
password STRING New user's password
pincode INT (optional - default: 000000) New user's pincode OTP for cash withdrawals from wallet

User KYC & Bank Verification


# Here is a curl example
curl \
-X POST https://:AccountCode.easily.ng/externallink/connectoverdraftbanklinkage/:userId/:returnlink
            

This link, embedable widget or pop-up is for user bank linkage and KYC. This should be called right after the user registration endpoint :
https://:AccountCode.easily.ng/externallink/connectoverdraftbanklinkage/:userId/:returnlink



            

User Login


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/loginuser 
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'username' 
-D 'password'
                

To login a user to his or her account on the platform :
https://api.easily.ng/thirdpartyapp/loginuser



Response example :

{ 
    "status" - STRING (action status which is either success or failed) 
    "message" - STRING (server status message e.g "Registration successful!") 
    "userid" - INT (Logged in user's unique ID) 
    "username" - STRING (Logged in user's username) 
    "useremail" - STRING (Logged in user's email) 
    "userimage" - STRING (Logged in user's photo absolute URL) 
    "logintoken" - STRING (Logged in user's authentication login token) 
}
                

QUERY PARAMETERS

Field Type Description
username STRING User's username
password STRING User's password

User Forgot/Reset Password


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userforgotpassword 
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'email' 
-D 'resetcode'
                

To reset a user password when forgotten :
https://api.easily.ng/thirdpartyapp/userforgotpassword



Response example :

{ 
    "status" - STRING (action status which is either success or failed) 
    "message" - STRING (server status message e.g "Password reset code sent to your email") 
}
                

QUERY PARAMETERS

Field Type Description
email STRING User's email
resetcode STRING Reset code gotten via user's email (optional)

User Change Password


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userchangepassword 
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'email' 
-D 'resetcode'
-D 'password'
-D 'passwordtwo'
                

To change a user password after reset code gotten. Typically called after password reset code gotten above :
https://api.easily.ng/thirdpartyapp/userchangepassword



Response example :

{ 
    "status" - STRING (action status which is either success or failed) 
    "message" - STRING (server status message e.g "Password changed successfully") 
}
                

QUERY PARAMETERS

Field Type Description
email STRING User's email
resetcode STRING Reset code gotten via user's email (optional)
password STRING New user password
passwordtwo STRING Confirm entered new user password

User Account Details


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userdetails
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account details :
https://api.easily.ng/thirdpartyapp/userdetails



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    walletbalance - INT (Logged in user's wallet balance) 
    firstname - STRING (Logged in user's firstname) 
    lastname - STRING (Logged in user's lastname) 
    overdraftbalance - INT (Logged in user's overdraft balance) 
    overdraftlimit - INT (Logged in user's overdraft limit) 
    creditscore - INT (Logged in user's bank credit score) 
    defaultloanoverdraftdailyinterestrate - DOUBLE (Daily loan interest rate percentage e.g 5) 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Account Transactions


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/usertransactions
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account transactions :
https://api.easily.ng/thirdpartyapp/usertransactions



Response example :

{ 
    orderid - INT (Transaction ID) 
    amout - FLOAT (Transaction amount) 
    date - STRING (Transaction date) 
    details - STRING (Transaction details) 
    paymentstatus - STRING (Transaction payment status e.g. paid or unpaid) 
    paymentmethod - STRING (Transaction method e.g card or wallet) 
    type - STRING (Transaction type e.g transfer) 
    loanid - INT (Transaction loan ID if a loan payment)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User View Profile Details


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userprofile/:userEmail
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user to view profile details :
https://api.easily.ng/thirdpartyapp/userprofile/:userEmail



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    walletbalance - INT (Logged in user's wallet balance) 
    firstname - INT (Logged in user's firstname) 
    lastname - INT (Logged in user's lastname) 
    overdraftbalance - INT (Logged in user's overdraft balance) 
    overdraftlimit - INT (Logged in user's overdraft limit) 
    creditscore - INT (Logged in user's bank credit score)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
:userEmail STRING email of the user's profile to view

User Pin Code Reset


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userpincoderesetrequest
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user to reset pin code:
https://api.easily.ng/thirdpartyapp/userpincoderesetrequest



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Pin code reset successful! Check email for reset code.") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Account Update


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/useraccountupdate
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'pincode'
-D 'oldpincode'
-D 'resetcode'
-D 'firstname'
-D 'lastname'
-D 'address'
-D 'city'
-D 'state'
-D 'country'
-D 'gender'
-D 'bvn'
-D 'dob'
                

For user account details update e.g pincode. Typically called after pin code RESET CODE generation :
https://api.easily.ng/thirdpartyapp/useraccountupdate



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Account update successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
pincode INT User pincode (only for subsequent Pin Code changes)
oldpincode INT User old pincode (optional, only for subsequent Pin Code changes)
resetcode STRING User pincode reset code (generated from above pin code generation endpoint)
firstname STRING User firstname
lastname STRING User lastname
address STRING User address
city STRING User city
state STRING User state
country STRING User country
gender STRING User gender e.g male or female
bvn STRING User BVN
dob STRING User date of birth

User Request Overdraft


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userrequestoverdraft
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'loanamount'
-D 'loanpurpose'
-D 'loanrepaymentchoice'
-D 'pincode'
                

For user requesting overdraft :
https://api.easily.ng/thirdpartyapp/userrequestoverdraft



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Posted and pending admin approval") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
loanamount DOUBLE Overdraft amount
loanpurpose STRING Overdraft purpose e.g personal or business
loanrepaymentchoice STRING Overdraft payment option e.g wallet
pincode INT User pincode

User Account Overdrafts


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/useroverdrafts
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account overdrafts :
https://api.easily.ng/thirdpartyapp/useroverdrafts



Response example :

{ 
    id - INT (Overdraft ID) 
    status - STRING (Overdraft status e.g active, pending etc) 
    type - STRING (Overdraft type) 
    details - STRING (Overdraft details) 
    amount - INT (Overdraft amount) 
    paymentstatus - STRING (Overdraft status e.g paid, unpaid, part-payment etc) 
    paymentmethod - STRING (Overdraft repayment method e.g card or wallet) 
    purpose - STRING (Overdraft purpose) 
    charges - INT (Overdraft accrued interest charges) 
    interestrate - INT (Overdraft interest rate) 
    outstandingamount - INT (Overdraft outstanding amount) 
    repaymentamount - INT (Overdraft repayment amount) 
    date - STRING (Overdraft request date) 
    paymentslog - ARRAY (Overdraft repayment history log)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Pay Overdraft


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/useroverdraftpayment
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'loanid'
-D 'loanrepaymentchoice'
-D 'amount'
                

For user paying overdraft :
https://api.easily.ng/thirdpartyapp/useroverdraftpayment



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Payment successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
loanid INT Overdraft ID
loanrepaymentchoice STRING Overdraft payment option e.g wallet
amount DOUBLE Overdraft payment amount

User Post Wishlist


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userpostwishlist
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'title'
-D 'details'
-D 'amount'
                

For user to post wishlist :
https://api.easily.ng/thirdpartyapp/userpostwishlist



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Posted successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
title STRING Title
details STRING Details
amount DOUBLE Amount

User Wishlist


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userwishlists
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account wishlist :
https://api.easily.ng/thirdpartyapp/userwishlists



Response example :

{ 
    id - INT (Pricelist ID) 
    status - STRING (Pricelist status e.g active, disabled etc) 
    title - STRING (Title) 
    details - STRING (Details) 
    price - INT (amount) 
    date - STRING (request date)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Post Gift Voucher


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userpostgiftvoucher
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'type'
-D 'details'
-D 'amount'
                

For user to post gift voucher :
https://api.easily.ng/thirdpartyapp/userpostgiftvoucher



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Posted successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
type STRING Type
details STRING Details
amount DOUBLE Amount

User Gift Vouchers


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/usergiftvouchers
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account gift vouchers :
https://api.easily.ng/thirdpartyapp/usergiftvouchers



Response example :

{ 
    id - INT (Pricelist ID) 
    status - STRING (Pricelist status e.g active, disabled etc) 
    type - STRING (Type) 
    details - STRING (Details) 
    price - INT (amount) 
    status - STRING (status)
    usedby - STRING (used by)
    code - STRING (code)
    date - STRING (request date)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Post Pricelist


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userpostpricelist
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'title'
-D 'details'
-D 'amount'
                

For user to post pricelist :
https://api.easily.ng/thirdpartyapp/userpostpricelist



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Posted successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
title STRING Title
details STRING Details
amount DOUBLE Amount

User Pricelist


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userpricelists
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account wishlist :
https://api.easily.ng/thirdpartyapp/userpricelists



Response example :

{ 
    id - INT (Pricelist ID) 
    status - STRING (Pricelist status e.g active, disabled etc) 
    title - STRING (Title) 
    details - STRING (Details) 
    price - INT (amount) 
    date - STRING (request date)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Post Prayerlist


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userpostprayerlist
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'title'
-D 'details'
-D 'amount'
                

For user to post prayerlist :
https://api.easily.ng/thirdpartyapp/userpostprayerlist



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Posted successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
title STRING Title
details STRING Details
amount DOUBLE Amount

User Prayerlist


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userprayerlists
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user account prayerlist :
https://api.easily.ng/thirdpartyapp/userprayerlists



Response example :

{ 
    id - INT (Pricelist ID) 
    status - STRING (Pricelist status e.g active, disabled etc) 
    title - STRING (Title) 
    details - STRING (Details) 
    price - INT (amount) 
    date - STRING (request date)
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User OTP Code Reset


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userotprequest
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user OTP CODE generation for wallet withdrawal :
https://api.easily.ng/thirdpartyapp/userotprequest



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "OTP code sent to your email") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Wallet Transfer


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userwallettransfer
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'amount'
-D 'details'
                

For user to transfer money from wallet :
https://api.easily.ng/thirdpartyapp/userwallettransfer



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Transfer successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
amount DOUBLE Amount
details STRING Details (optional)

User Add Bank Account


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/useraddbankaccount
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'bankname'
-D 'bankcode'
-D 'bankaccountname'
-D 'bankaccountnumber'
-D 'pincode'
-D 'withdrawamount'
                

For user to add bank account. Click here to view the accepted list of bank codes :
https://api.easily.ng/thirdpartyapp/useraddbankaccount



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Posted successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
bankname STRING Bank name
bankcode STRING Bank code (Click here to view the accepted list of bank codes)
bankaccountname STRING Bank account name
bankaccountnumber STRING Bank account number
pincode INT Pin code
withdrawamount DOUBLE Withdraw amount

User Bank Accounts


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userbankaccounts
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user added bank accounts :
https://api.easily.ng/thirdpartyapp/userbankaccounts



Response example :

{ 
    id - INT (Wishlist ID) 
    bankname - STRING 
    bankcode - STRING 
    bankaccountname - STRING 
    bankaccountnumber - INT 
    date - STRING
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Bank Account Verification


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/verifyuserbankaccount
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'bankcode'
-D 'bankaccountnumber'
                

For user to verify a bank account :
https://api.easily.ng/thirdpartyapp/verifyuserbankaccount



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    bankaccountname- STRING 
    bankaccountnumber- INT
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
bankcode STRING Bank code (Click here to view the accepted list of bank codes)
bankaccountnumber STRING Bank account number

User Bank Withdrawal


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userbankaccountwithdrawal
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'bankid'
-D 'details'
-D 'pincode'
-D 'withdrawamount'
                

For user withdrawal into bank account on profile :
https://api.easily.ng/thirdpartyapp/userbankaccountwithdrawal



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Withdrawal successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
bankid INT Bank ID (gotten from list of user bank accounts)
details STRING Details (optional)
pincode INT Pin code
withdrawamount DOUBLE Withdraw amount

User Bank Bulk Transfer


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userbankbulktransfer
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'totalaccounts'
-D 'bank_code1'
-D 'bank_account_number1'
-D 'bank_account_name1'
-D 'amount1'
-D 'note1'
                

For user bulk transfer into bank accounts :
https://api.easily.ng/thirdpartyapp/userbankbulktransfer



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Transfer successful") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
totalaccounts INT Total accounts count (e.g 5 if transfering to five accounts)
bank_code1 STRING Bank code then array number (e.g bank_code1 or bank_code2, depending on number of array entries)
bank_account_number1 STRING Bank account number then array number (e.g bank_account_number1 or bank_account_number2, depending on number of array entries)
bank_account_name1 STRING Bank account name then array number (e.g bank_account_name1 or bank_account_name2, depending on number of array entries)
amount1 FLOAT Amount to be transfered then array number (e.g amount1 or amount2, depending on number of array entries)
note1 STRING Note then array number (e.g note1 or note2, depending on number of array entries)

User Virtual Bank Account Request


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userrequestvirtualaccount
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user virtual bank account request :
https://api.easily.ng/thirdpartyapp/userrequestvirtualaccount



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Request submitted successfully and awaiting approval") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

User Disable Account


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userdisableaccount
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
                

For user to disable account :
https://api.easily.ng/thirdpartyapp/userdisableaccount



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Account disabled successfully") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration

Utility Bill - Power Purchase


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userutilitybillpurchase
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'type'
-D 'meternumber'
-D 'electricitycompany'
-D 'metertype'
-D 'amount'
-D 'phone'
-D 'paymentmethod'
                

For user to purchase and pay for utility power bills :
https://api.easily.ng/thirdpartyapp/userutilitybillpurchase



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Order submitted successfully") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
type STRING Bill type e.g power
meternumber STRING User meter number
electricitycompany STRING User electricity company e.g either abuja-electric, eko-electric, enugu-electric, ibadan-electric, ikeja-electric, jos-electric, kaduna-electric, kano-electric or portharcourt-electric
metertype STRING User meter type e.g either prepaid or postpaid
amount Double Amount
phone STRING User registered phone number
paymentmethod STRING Payment method, only 'wallet' is accepted

Utility Bill - Gas Purchase


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userutilitybillpurchase
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'type'
-D 'gasvolume'
-D 'deliverylocation'
-D 'deliveryaddress'
-D 'amount'
-D 'phone'
-D 'paymentmethod'
                

For user to purchase and pay for utility gas bills :
https://api.easily.ng/thirdpartyapp/userutilitybillpurchase



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Order submitted successfully") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
type STRING Bill type e.g gas
gasvolume STRING User gas volume
deliverylocation STRING User delivery location company e.g either pick-up or delivery
deliveryaddress STRING User delivery address
amount Double Amount
phone STRING User registered phone number
paymentmethod STRING Payment method, only 'wallet' is accepted

Utility Bill - Phone Purchase


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userutilitybillpurchase
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'type'
-D 'phonetocredit'
-D 'networkprovider'
-D 'airtimeordata'
-D 'dataplan'
-D 'amount'
-D 'phone'
-D 'paymentmethod'
                

For user to purchase and pay for utility phone bills :
https://api.easily.ng/thirdpartyapp/userutilitybillpurchase



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Order submitted successfully") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
type STRING Bill type e.g phone
phonetocredit STRING User recipent's phone to credit
networkprovider STRING Network e.g either mtn, glo, airtel or etisalat
airtimeordata STRING Phone purchase type e.g either airtime or data
dataplan STRING Network dataplan if data selected in the airtimeordata parameter
amount Double Amount
phone STRING User registered phone number
paymentmethod STRING Payment method, only 'wallet' is accepted

Utility Bill - Cable Purchase


# Here is a curl example
curl \
-X POST https://api.easily.ng/thirdpartyapp/userutilitybillpurchase
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
-D 'userid' 
-D 'userlogintoken'
-D 'type'
-D 'cablenumber'
-D 'cabletype'
-D 'cablepackage'
-D 'amount'
-D 'phone'
-D 'paymentmethod'
                

For user to purchase and pay for utility cable bills :
https://api.easily.ng/thirdpartyapp/userutilitybillpurchase



Response example :

{ 
    status - STRING (action status which is either success or failed) 
    message - STRING (server status message e.g "Order submitted successfully") 
}
                

QUERY PARAMETERS

Field Type Description
userid INT User ID gotten from successful login or registration
userlogintoken STRING User login token gotten from successful login or registration
type STRING Bill type e.g cable
cablenumber STRING User recipent's cable number
cabletype STRING Cable type e.g either dstv or gotv
cablepackage STRING Cable package
amount Double Amount
phone STRING User registered phone number
paymentmethod STRING Payment method, only 'wallet' is accepted

APP Web Hook


Header Hash authorization :
{ 
    hash - STRING (a sha512 hash_hmac of the payload and your API Key Secret) 
}
                

For APP webhook especially for overdraft status e.g Approval, sent to your web hook link provided in your account.

You can verify the web hook with the hash gotten in the header as the hash_hmac('sha512', “payload”, “your api key secret”) must match the provided hash in the header.



Payload example :

{ 
    type - STRING (action type e.g overdraftupdate, creditscoreupdate) 
    status - STRING (action status e.g approved, rejected, paid for Overdraft or updated for CS) 
    postid - INT (action posted, e.g overdraft ID for Overdraft or user ID for Credit Score) 
    message - STRING (e.g " Overdraft request approved or Credit score updated")
}
                

List Of Accepted Bank Codes


# Here is a curl example
curl \
-X GET https://api.easily.ng/thirdpartyapp/bankcodeslist
-H 'accept: application/json' 
-H 'content-type: application/json' 
-H 'api-sec-key: string' 
                

For a list of accepted bank codes list:
https://api.easily.ng/thirdpartyapp/bankcodeslist



Response example :

{
    "status": true,
    "message": "Banks retrieved",
    "data": [
        {
            "id": 302,
            "name": "9mobile 9Payment Service Bank",
            "slug": "9mobile-9payment-service-bank-ng",
            "code": "120001",
            "active": true,
            "country": "Nigeria",
            "currency": "NGN",
            "type": "nuban"
        },
        {
            "id": 174,
            "name": "Abbey Mortgage Bank",
            "slug": "abbey-mortgage-bank-ng",
            "code": "404",
            "active": true,
            "country": "Nigeria",
            "currency": "NGN",
            "type": "nuban",
        },
    ]
}
                

QUERY PARAMETERS

Field Type Description

List Of Accepted Overdraft Status


Status value for loan update : 
{ 
    status - STRING (approved, rejected, part-payment, paid, bad ) 
}
            

For user overdraft/loan status update lists :



            

User Journey/Workflow Diagram


            

For user journey and workflow :



            

Errors

Our API uses the following error codes:

Error Code Meaning
X000 Some parameters are missing. This error appears when you don't pass every mandatory parameters.
X001 Unknown or unvalid secret_key. This error appears if you use an unknow API key or if your API key expired.
X002 Unvalid secret_key for this domain. This error appears if you use an API key non specified for your domain. Developper API keys doesn't have domain checker.
X003 Unknown or unvalid user token. This error appears if you use an unknow user token or if the user token expired.