Get Loan Details
Description: Get employee loan details. Order by recent payment.
- Sample Request
- Sample Response
Request Parameters
Parameter | Type | Description | Required |
---|---|---|---|
loanRef | String | Unique existing loan reference | Yes |
GET {base_url}/loan/details?loanRef=LOAN1234
curl `${base_url}/loan/details?loanRef=LOAN1234`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
Response Parameters
Parameter | Type | Description | Required |
---|---|---|---|
status | Integer | HTTP status code | Yes |
message | String | Description of HTTP status code | Yes |
profile | Object | Response data block for profile | Yes |
firstName | String | Employee first name | Yes |
lastName | String | Employee last name | Yes |
String | Employee email address | Yes | |
phoneNo | String | Employee phone number | Yes |
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 |
repayment | Array of Object | Response data block for repayment details | Yes |
paymentRef | String | Unique repayment reference | No |
amount | Integer | Repayment Amount | No |
paymentChannel | String | Repayment Channel | No |
paymentDate | String | Repayment Date | No |
POST {base_url}/loan/details?loanRef=LOAN1234
{
"status": 200,
"message": "Loan Details",
"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"
},
"repayment": [
{
"paymentRef ": "36478HJK",
"amount":2000,
"paymentChannel ": "ETranzact",
"paymentDate": "25-02-2021"
},
]
}