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") and corperate("corp")	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
10	directors	Loan directors	array
11	managementTeam	Loan management team	array
12	employer	Employer information of the loan	object
13	isSignedMandate	Automatically create signed repayment mandate after loan creation	boolean
14	signature	Base64-encoded signature image (Required if isSignedMandate is true)	string
15	accountNumber	Bank account number (Required if isSignedMandate is true or if loanType is "sel" or "corp")	string
16	bankCode	Bank code (Required if isSignedMandate is true or if loanType is "sel" or "corp")	string

Schedule

#	Field	Description	Type	Optional
1	dueDate	Schedule repayment date	string
2	amount	Total amount due on the schedule (major)	string
3	principal	Principal component of the schedule (major)	string
4	interest	Interest component of the schedule (major)	string
5	fees	Fees component of the schedule (major)	string
6	status	Collection status of the schedule ("pending","paid","partially_paid")	string

Director's object (For LoanType "corp")

#	Field	Description	Type	Optional
1	name	Director's Name	string
2	phoneNumber	Director's phone number	string
3	email	Director's Email	string
4	documents	Director's documents	array

Management Team's Object (For LoanType "corp")

#	Field	Description	Type	Optional
1	name	Management team's name	string
2	phoneNumber	Management team's phone number	string
3	email	Management team's email	string
4	title	Management team's title	string
5	workEmail	Management team's email	string
6	workPhoneNumber	Management team's work phone number	string
7	state	Management team's state (Abia, Abuja, Adamawa, Akwa Ibom, Anambra, Bauchi, Bayelsa, Benue, Borno, Cross River, Delta, Ebonyi, Edo, Ekiti, Enugu, Gombe, Imo, Jigawa, Kaduna, Kano, Katsina, Kebbi, Kogi, Kwara, Lagos, Nasarawa, Niger, Ogun, Ondo, Osun, Oyo, Plateau, Rivers, Sokoto, Taraba, Yobe, Zamfara)	enum
8	address	Management team's address	string
9	lga	Management team's lga	string
10	documents	Management team's documents	array

Document Object

#	Field	Description	Type	Optional
1	name	Document name	string
2	url	Document url (A documents needs to be uploaded)	string

Upload form-data

	Field	Description	Type	Optional
1	file	Select file	file

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	enum
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 (Abia, Abuja, Adamawa, Akwa Ibom, Anambra, Bauchi, Bayelsa, Benue, Borno, Cross River, Delta, Ebonyi, Edo, Ekiti, Enugu, Gombe, Imo, Jigawa, Kaduna, Kano, Katsina, Kebbi, Kogi, Kwara, Lagos, Nasarawa, Niger, Ogun, Ondo, Osun, Oyo, Plateau, Rivers, Sokoto, Taraba, Yobe, Zamfara)	enum
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 (Abia, Abuja, Adamawa, Akwa Ibom, Anambra, Bauchi, Bayelsa, Benue, Borno, Cross River, Delta, Ebonyi, Edo, Ekiti, Enugu, Gombe, Imo, Jigawa, Kaduna, Kano, Katsina, Kebbi, Kogi, Kwara, Lagos, Nasarawa, Niger, Ogun, Ondo, Osun, Oyo, Plateau, Rivers, Sokoto, Taraba, Yobe, Zamfara)	enum
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

Employer Object

#	Field	Description	Type	Optional?
1	name	Name of employer	string
2	address	Address of employer	string
3	state	Employer state	string
4	lga	Employer lga	string
5	phoneNumber	Empoyer phone 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",
 "isSignedMandate": true,
 "accountNumber": "8378883748",
 "bankCode": "000021",
 "signature": "/9j/4AAQSkZJRgABAQAAAQ2Q==",
 "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"
 },
  "directors":[
    {
       "name":"Olajumoke",
       "phoneNumber":"081336887060",
       "email":"[e-mail]",
       "documents":[
         {
            "name":"Bank statement.pdf",
            "url":"https://storage.googleapis.com/8062287c-7f7d-491d-a62d-6c60d16348f5"
         }
       ]     
    }
 ],
 "managementTeam":[
   {
       "name":"Olajumoke",
       "phoneNumber":"081336887060",
       "email":"[e-mail]",
        "title":"CEO",
        "workEmail":"[e-mail]",
        "workPhoneNumber":"081275757392",
        "state":"Lagos",
        "address":"Lekki phase one",
        "lga":"Eti Osa",
       "documents":[
         {
            "name":"Bank statement.pdf",
            "url":"https://storage.googleapis.com/8065697c-7f7d-491d-a62d-6c60d16348f5"
         }
        ]     
   }
 ],
 "account": {
    "bankName" : "Providus MFB",
    "accountNumber" : "2390857192",
    "accountName" : "John Doe",
 },
  "employer": {
    "name" : "Mida technologies inc",
    "adddress" : "14 Jone doe street",
    "state" : "Lagos",
    "lga" : "Ikeja",
    "phoneNumber" : "080123456789"
 },
 "schedule":[
   {
      "dueDate": "2023-08-01",
      "amount": "15000",
      "principal": "10000",
      "interest": "4000",
      "fees": "1000",
      "status": "pending"
   },{
      "dueDate": "2023-09-01",
      "amount": "15000",
      "principal": "10000",
      "interest": "4000",
      "fees": "1000",
      "status": "pending"
   },{
      "dueDate": "2023-10-01",
      "amount": "15000",
      "principal": "10000",
      "interest": "4000",
      "fees": "1000",
      "status": "pending"
   },{
      "dueDate": "2023-11-01",
      "amount": "15000",
      "principal": "10000",
      "interest": "4000",
      "fees": "1000",
      "status": "pending"
   }
  ]
}