AppZone API Documentation
  • Overview
    • Welcome
    • Getting Started
    • Enterprise User Oauth
  • Account
    • Account API
      • Create Account
      • Account Enquiry
      • Freeze Account
      • Unfreeze Account
      • Check Freeze Status
      • Place Lien on Account
      • Remove Lien on Account
      • Check Lien Status
      • Activate Post-No-Debit on Account
      • Deactivate Post-No-Debit on Account
      • Check Post-No-Debit Status
      • Retrieve BVN Details
      • Create Customer and Account
      • Update Account Tier2
      • Get Bank One Balance Enquiry
      • Generate Account Statement
      • Get Active Savings Accounts by CustomerID
      • Search Transactions
      • Get Transactions
  • Customer
    • Customer API
      • Create Customer
      • Update Customer
      • Get Customer by Account Number
  • Loans
    • Loan API
      • Get Loans By Customer Id
      • Get Loan Repayment Schedule
      • Loan Creation Application 2
      • Get Loan Account Balance 2
  • Account Officer
  • Standing Order
    • Standing Order API
      • Standing Order Creation Application2
      • Get Standing Orders By Debit Account Number
      • Cancel Standing Order
  • Fixed Deposit
    • Fixed Deposits API
      • Create Fixed Deposit Account
      • Get Fixed Deposit Account By Account Number
      • Get Fixed Deposit Account By Liquidation Account
      • Get Fixed Deposit Account By Phone Number
  • Transfers
    • Transfer API
      • Name Enquiry
      • Intra Bank (Local) Fund Transfer
      • Intra Bank Transfer
  • Cards
    • Cards API
      • Retrieve Institution Configurations
      • Card Request
      • Get Customer Cards
      • Hotlist Customer Card
      • Check Card Generation Status
      • Link Card to Customer Account
      • Freeze Cards
      • Unfreeze Cards
      • Add Transaction Limit to Customer Card
      • View Transaction Limit on Customer Card
      • Update Transaction Limit on Customer Card
      • Disable channel for customer card
      • Get Card Delivery Options
      • Re-Enable Channel for Customer Card
  • Overdraft
    • Overdraft API
      • Create Overdraft
      • Get Overdraft Interests
      • Get Overdraft Fees
  • Transactions
    • Transactions API
      • Transaction Status Confirmation
      • Credit Customer Account
      • Debit Customer Account
      • Reversals
  • Bills Payment
    • Bills Payment API
      • Get Commercial Bank
      • Get Billers
      • Get Billers Category
      • Get Payment Items
      • Initiate Bills Payment Transaction
  • Messaging
    • Save Bulk SMS
    • Save Email
Powered by GitBook
On this page
  • Authentication
  • Testing your actions.
  • API Environment
  • What You Should Know About Our API
  1. Overview

Getting Started

Quickly get started using our API

PreviousWelcomeNextEnterprise User Oauth

Last updated 3 years ago

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;

Authentication

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

  • Join skype group provided by the Implementation support team

Other User

To get your authtoken as other user follow the steps below

  • Join the Implementation support team on skype

  • Your authtoken will be provided for you by the implementation support team.

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

Name

Description

Production

This 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

Staging

This 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 API

The Appzonecore API is categorized into two main types namely;

  • Corebanking APIs

  • Channels APIs

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

Corebanking API

http:// staging.mybankone.com /BankOneWebAPI/

Channels API

https://staging.mybankone.com/thirdpartyapiservice/apiservice/

🎉
authentication token
BankOne - Login Page
Logo