Create Loan

To use MidaCollect, you start by creating a loan record.

Field description

#	Field	Description	Type	Optional?
1	loanAccountNumber	Unique loan account identifier from lenders system	string
2	loanAmount	Total value of the loan in minor	string
3	email	Lender's client's email	string
4	isNewLoan	true if loan is a new loan	boolean
5	loanType	Loan to salary earners ("pl") or loan to non-salary earners, self-employed or businesses ("sel")	enum
6	customer	Lenders client's details	object
7	address	Lenders client's address details	object
8	nok	Lenders client's next of kin details	object
9	schedule	Loan schedule	array

Customer Object

#	Field	Description	Type	Optional?
1	fullname	Lender's client's fullname	string
2	BVN	Lender's client's BVN	string
3	Sex	Lender's client's Sex	string
4	phoneNumber	Lender's client's Phone Number	string

Address Object

#	Field	Description	Type	Optional?
1	address	Lender's client's full address	string
2	state	Lender's client's state of residence	string
3	lga	Lender's client's lga of residence	string

NOK Object

#	Field	Description	Type	Optional?
1	nokFullname	Client's next of kin's fullname	string
2	nokBVN	Client's next of kin's BVN	string
3	nokPhoneNumber	Client's next of kin's Phone Number	string
4	nokAddress	Client's next of kin's full address	string
5	nokState	Client's next of kin's state of residence	string
6	nokLga	Client's next of kin's lga of residence	string

Account Object

#	Field	Description	Type	Optional?
1	bankName	Name of bank	string
2	accountNumber	Clients account number	string
3	accountName	Name associated with the account number	string

Security

The API security is a bearer token using your organisation's API Key obtained here

API url

{baseUrl}/external/loan

Sample Request:

{
 "loanAccountNumber":"423456789",
 "loanAmount": "50000",
 "email": "[e-mail]",
 "isNewLoan": false,
 "loanType": "pl",
 "customer":{
    "fullname": "Dave Omo",
    "BVN": "2323232322",
    "sex": "male",
    "phoneNumber": "08055309113,08055623778"
 },
 "address": {
    "address" : "2a stong iron steet surulere",
    "state" : "lagos",
    "lga" : "lagos mainland"
 },
 "nok": {
    "nokFullname" : "Jane Omo",
    "nokBVN" : "2390857192",
    "nokPhoneNumber" : "0987768899",
    "nokAddress" : "15 maryland avenue, off thomson street.",
    "nokState" : "lagos",
    "nokLga" : "ikeja"
 },
 "account": {
    "bankName" : "Providus MFB",
    "accountNumber" : "2390857192",
    "accountName" : "John Doe",
 },
 "schedule":[
   {
      "dueDate": "2023-08-01",
      "amount": "15000",
      "status": "pending"
   },{
      "dueDate": "2023-09-01",
      "amount": "15000",
      "status": "pending"
   },{
      "dueDate": "2023-10-01",
      "amount": "15000",
      "status": "pending"
   },{
      "dueDate": "2023-11-01",
      "amount": "15000",
      "status": "pending"
   }
  ]
}