Create Loan

Description: Profile an employee for loan.

Sample Request

Request Parameters

Parameter	Type	Description	Required
loanRef	String	Unique client loan transaction reference	Yes
employeeID	String	Employee payee ID	No
accountNo	Integer	NUBAN Account No	Yes
bankCode	Integer	Employee bank code	No
businessId	String	eTranzact corporate identifier	Yes
totalAmount	Float	Total loan issued amount	Yes
rentalAmount	Float	Monthly repayable amount	Yes
balance	Float	Loan Balance	No
tenure	Integer	Loan tenure value	Yes
tenureType	String	Loan tenure in days, weeks, month, year	Yes
nextChargeDate	String	Next repayment date	Yes
loanAccountNo	String	Account Provided by client for employee loan repayment.	Yes
loanBankcode	String	The bank code of the bank on which the loan account is domiciled.	Yes

POST {base_url}/loan

curl `${base_url}/loan`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X POST
-d '{
    "loanRef ":"34262333",
    "staffID": "1234",
    "accountNo": 0038392323,
    "bankCode": 123,
    "businessId":"2839202",
    "totalAmount": 250000.00,
    "rentalAmount": 50000.00,
    "balance": 250000.00,
    "tenure": 6,
    "tenureType": "month",
    "nextChargeDate": "25-02-2021",
    "loanAccountNo": "0001980234",
    "loanBankcode ": "044"
}
'

Sample Response

Response Parameters

Parameter	Type	Description	Required
message	String	Description of performed requested action	Yes
status	Integer	HTTP status code	Yes
loanRef	String	Unique client loan transaction reference	Yes
execTime	integer	Time taken for execution in milliseconds	Yes
error	String	Specific errors when request does not return a HTTP status of 201.	No
profile	Object	Response data block for profile	Yes
firstName	String	Employee first name	Yes
lastName	String	Employee last name	No
email	String	Employee email address	No
phoneNo	String	Employee phone number	No
payeeID	String	Employee payee ID	No
accountNo	Integer	Employee account No	Yes
bankCode	Integer	Employee bank code	Yes
businessId	String	eTranzact corporate identifier	Yes
loan	Object	Response data block for loan details	Yes
loanRef	String	Loan unique reference	Yes
totalAmount	Float	Total amount of loan	Yes
rentalAmount	Float	Monthly repayable amount	Yes
balance	Float	Loan balance	Yes
tenure	String	Concatenated loan tenure and tenure type	Yes
loanDate	String	loanDate	Yes
status	Boolean	Loan status. True for active, False for inactive	Yes
loanAccountNo	String	Account Provided by Client for employee	Yes
loanBankcode	String	The bank code of the bank on which the loan account is domiciled.	Yes

POST {base_url}/loan

{
  "status": 201,
  "message": "Employee profiled for loan",
  "loanRef ": "34262333 ",
  "execTime": 1.4888868,
  "error": "",
  "profile": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@etranzact.com",
    "phoneNo": "08093338829",
    "payeeID":"com1234",
    "accountNo":0031038291,
    "bankCode": 123,
    "businessId ":"2839202"
    },
 "loan": {
    "loanRef ": " LOAN1234",
    "totalAmount ": 250000.00,
    "rentalAmount": 50000.00,
    "balance": 250000.00,
    "tenure ": "6 month",
    "loanDate ": "25-02-2021",
    "status": TRUE ,
    "loanAccountNo": "0001980234",
    " loanBankcode": "044"
    }
}