Create Overdraft

The "Create Overdraft" endpoint allows customers to add overdrafts to their accounts. Customers can request to add an overdraft by providing the necessary account information, the desired overdraft limit, and other required parameters.

POST /api/accountoverdraft/v1/add Upon successful completion, the overdraft will be added to the customer's account, giving them access to additional funds up to the specified limit.

Headers

Name	Value
Content-Type*	application/json
Authorization*	Bearer <token>
Request-Reference	{unique-reference}

Body

Name	Data Type (length)	Required	Description
accountNumber	string		The customer's account number (NUBAN) for the overdraft
limit	integer		The overdraft limit amount The amount should be sent in the currency base unit. For example, 1000 naira will be sent as 1000 * 100
tenure	integer		The tenure or duration of the overdraft in months
commencementDate	date		The start date of the overdraft
useDefaultFee	boolean		Indicates whether to use the default fee. Set true to use default and false to set your fee
feeCodes	array of objects		A list of fee codes must be provided if not using the default. Overdraft fees can be configured in the Fee Section on Udara 360.
└─ feeCode	string		Specific fee code
feeAmount	integer		The fee amount, if not using the default
useDefaultInterest	boolean		Indicates whether to use the default interest rate
interestCode	string		If you don't want to use the default settings, you can customize the interest code. Credit interest configuration is available in the Fee Section of Udara 360
interestAmount	integer		Interest amount, if not using default
securityPledged	boolean		Indicates whether security is pledged for the overdraft by setting true for yes and false for no
securityType	string		Type of security pledged The enumerations are: 1 = RealEstateAndLandAndBuilding 2 = Automobile 3 = PlantAndEquipment 4 = NaturalReserves 5 = MarketableSecurities 6 = AccountsReceivableAndInventory 7 = Cash 8 = PersonalGuarantees 9 = PostDatedCheques 10 = Dormicilliation 11 = HouseholdItems
securityValuation	integer		Valuation of the pledged security
description	string		Description or purpose of the overdraft
guarantorName	string		Name of the guarantor for the overdraft
guarantorPhoneNumber	string		Phone number of the guarantor

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/accountoverdraft/v1/add' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "accountNumber": "string",
  "limit": 0,
  "tenure": 0,
  "commencementDate": "2023-01-20T23:33:10.339Z",
  "useDefaultFee": true,
  "feeCodes": [
    {
      "feeCode": "string"
    }
  ],
  "feeAmount": 0,
  "useDefaultInterest": true,
  "interestCode": "string",
  "interestAmount": 0,
  "securityPledged": true,
  "securityType": "string",
  "securityValuation": 0,
  "description": "string",
  "guarantorName": "string",
  "guarantorPhoneNumber": "string"
}'

Respose: 200

{
  "status": true,
  "message": "string",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}