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
  1. Overdraft
  2. Overdraft API

Create Overdraft

This API sends an Overdraft request for a customer

PreviousOverdraft APINextGet Overdraft Interests

Last updated 3 years ago

To create an overdraft, you first need to build the complete create overdraft endpoint by passing version in to the url path and authtoken in the query params.

Then pass AccountNumber, Limit, Tenure, CommencementDate, CollateralType and other required payload in the request body.

We have a Production URL and Staging URL you are advised to use the staging during development.

Production URL

Staging URL

Here is an example request with sample payload to the staging endpoint.

POST http://staging.mybankone.com/BankOneWebAPI/api/Overdraft/Create

Path Parameters

Name
Type
Description

version*

Int

Current API version

Query Parameters

Name
Type
Description

authtoken*

String

Auth token for this request

Request Body

Name
Type
Description

AccountNumber*

String

Customer Account number to be granted an Overdraft

Limit*

long

This is the maximum amount the customer can overdraw in naira.

Tenure *

Int

Duration in which the overdrawn amount is authorized

CommencementDate*

Date

Overdraft start date (if a future date is specified, overdraft will be inactive till said date)

CollateralType

String

The type of asset deposit as collateral (eg Automobile, Forestry, Agriculture)

SecurityPledged*

String

The description of the asset pledged as collateral (eg 2yrs old Benz S500...)

InterestRate*

Int

Interest rate in which the interest amount will be calculated (specify –1 to use the rate in the interest ID. )

InterestId*

Int

ID of the applicable interest configuration (see before for the endpoint to get this). Override the rate attached to this interest by specifying a value other than –1 in InterestRate.

FeeId*

Int

ID of the applicable fee attached to this OD (see before for the endpoint to get list of all fees configured on bankone.)

{
    
 "IsSuccessful": true,
 "CustomerIDInString": null,
 "Message": "Overdraft created successfully",
 "TransactionTrackingRef": null,
 "Page": null


}
http://api.mybankone.com/BankOneWebAPI/api/Overdraft/Create/version?authToken={{auth_token}}
http://staging.mybankone.com/BankOneWebAPI/api/Overdraft/Create/version?authToken={{auth_token}}