Getting Started

Quickly get started using our API

Yaaay 🥳🥳 you are about to kick off the development of your super digital banking application and cannot wait to start writing those lines of code Here are the key steps you'll need to follow to integrate to our Digital Banking Enabler APIs;


You have to get authenticated to use the API this means you need an auth token to make your request.
There are two different types of users the Enterprise User and Other Users

Enterprise User

To get your auth token as an enterprise user follow the steps below

  • Log into iRestrict
  • Set up your account
  • Get your authentication token
  • Join skype group provided by the Implementation support team

Other User

To get your authtoken as other user follow the steps below

  • Contact the Business or Implementation team
  • Sign SOW & provide your authorised token custodian
  • Your authtoken will be provided for you by the implementation support team.
  • Join the Implementation support team on skype

Testing your actions.

After successfully getting your auth token and setting up your account, you might want to confirm your API actions.

For instance, after creating an account via API, user can view this account on Bankone to confirm the account was created as required.

To do this, login into BankOne using the Institution code: 4-digit institution code, Username: Username and Password provided by the implementation team


API Environment

ProductionThis is the environment where real action and transaction occur and should be used when you are ready to put your application into operation for the intended users. An auth-token would be provided for this environment following sign-off of staging test
StagingThis is the environment where you are required to conduct your test. A staging auth token would be generated for your institution and should be used for this purpose

What You Should Know About Our APIs

The Qore API is categorised into two main types namely;

  • Corebanking APIs
  • Channels APIs

You are required required to use the correct Base URL else you would get error messages. We have listed the APIs and their category for your information (refer to API category table below)



The Corebanking & Channels API have different base URL; hence it is important to take note of this difference when integrating or conducting your integration



Account and Customer CreationCorebanking
Customer Information UpdateCorebanking
Account Tier UpdateCorebanking
Fetch Account DetailsCorebanking
Retrieve Customer InformationCorebanking
Account Statement GenerationCorebanking
Balance EnquiryCorebanking
Account statementCorebanking
Active Savings AccountCorebanking
Search TransactionsCorebanking
Generate Account StatementCorebanking
Account Name UpdateCorebanking
Close AccountCorebanking
Account EnquiryChannels
Freeze AccountChannels
Unfreeze AccountChannels
Check Freeze StatusChannels
Place Lien on AccountChannels
Remove Lien on AccountChannels
Check Lien StatusChannels
Activate Post-No-Debit on AccountChannels
Deactivate Post-No-Debit on AccountChannels
Check Post-No-Debit StatusChannels
Retrieve BVN DetailsChannels
Get Customer by Account NoCorebanking
Create CustomerCorebanking
Update CustomerCorebanking
Get Account OfficerCorebanking
Get ProductsCorebanking
Create Standing OrderCorebanking
Get Standing ordersCorebanking
Cancel Standing OrderCorebanking
Get Loans By Customer IDCorebanking
Get Loan Repayment ScheduleCorebanking
Loan Creation ApplicationCorebanking
Loan Account balanceCorebanking
Create Fixed DepositCorebanking
Create Fixed Depsoit AccountCorebanking
Get Fixed Deposit Account by Account NumberCorebanking
Get Fixed Deposit Account by LiquidationCorebanking
Get Fixed Depsoit Account by Phone NumberCorebanking
Get Overdraft InterestCorebanking
Get Overdraft FeeCorebanking
Get Overdraft OutstandingCorebanking
Create overdraftCorebanking
Get OverdraftCorebanking
Name EnquiryChannels
Intra Bank (Local) Fund TransferChannels
Intra Bank TransferChannels
Transaction Status ConfirmationChannels
Credit Customer AccountChannels
Debit Customer AccountChannels
Get Commercial BankChannels
Get BillersChannels
Get Billers CategoryChannels
Get Payment ItemsChannels
Initiate Bills Payment TransactionChannels
Get Card Delivery OptionsChannels
Retrieve Institution ConfigurationsChannels
Card RequestChannels
Get Customer CardsChannels
Hotlist Customer CardChannels
Retrieve Institution ConfigurationsChannels
Batch Cards RequestChannels
Check Card Generation StatusChannels
Link Card to Customer AccountChannels
Retrieve Customer CardsChannels
Freeze CardChannels
UnFreeze CardChannels
Add Transaction Limit to Customer CardChannels
View Transaction Limit on Customer CardChannels
Update Transaction Limit on Customer CardChannels
Disable channel for customer cardChannels
Re-Enable channel for customer cardChannels