Description

---

This API will be used to fetch the loan schedule for the proposed loan. The request will need the rule ID obtained in Fetch Transactions API and the corresponding external transaction ID for the loan amortization schedule for available tenures to be returned. The information in the API is recommended to be displayed to borrower(s) and necessary consent is obtained before initiating loan booking.

 

URL: https://DomainName/api/v1/loans?command=calculateLoanSchedule

Headers

---

Content-Type: application/JSON

client_id: To be shared at the time of integration

client_secret: To be shared at the time of integration

Request Body

---

{ "dateFormat": "dd MMMM yyyy", "locale": "en_GB", "productId": 1, "principal": "100,000.00", "loanTermFrequency": 12, "loanTermFrequencyType": 2, "numberOfRepayments": 12, "repaymentEvery": 1, "repaymentFrequencyType": 2, "interestRatePerPeriod": 2, "amortizationType": 1, "interestType": 0, "interestCalculationPeriodType": 1, "expectedDisbursementDate": "20 September 2011", "transactionProcessingStrategyId": 2 }

Response Body

---

{ "currency": { "code": "UGX", "name": "Uganda Shilling", "decimalPlaces": 2, "displaySymbol": "USh", "nameCode": "currency.UGX", "displayLabel": "Uganda Shilling (USh)" }, "loanTermInDays": 366, "totalPrincipalDisbursed": 100000, "totalPrincipalExpected": 100000, "totalPrincipalPaid": 0, "totalInterestCharged": 13471.52, "totalFeeChargesCharged": 0, "totalPenaltyChargesCharged": 0, "totalWaived": 0, "totalWrittenOff": 0, "totalRepaymentExpected": 113471.52, "totalRepayment": 0, "totalOutstanding": 0, "periods": [ { "period": 0, "dueDate": [ 2011,9,20 ], "principalDisbursed": 100000, "principalLoanBalanceOutstanding": 100000, "feeChargesDue": 0, "feeChargesOutstanding": 0, "totalOriginalDueForPeriod": 0, "totalDueForPeriod": 0, "totalOutstandingForPeriod": 0, "totalOverdue": 0, "totalActualCostOfLoanForPeriod": 0 }, { "period": 1, "fromDate": [ 2011,9,20 ], "dueDate": [ 2011,10,20 ], "daysInPeriod": 30, "principalOriginalDue": 7455.96, "principalDue": 7455.96, "principalOutstanding": 7455.96, "principalLoanBalanceOutstanding": 92544.04, "interestOriginalDue": 2000, "interestDue": 2000, "interestOutstanding": 2000, "feeChargesDue": 0, "penaltyChargesDue": 0, "totalOriginalDueForPeriod": 9455.96, "totalDueForPeriod": 9455.96, "totalPaidForPeriod": 0, "totalOutstandingForPeriod": 9455.96, "totalOverdue": 9455.96, "totalActualCostOfLoanForPeriod": 2000 }, ... ... { "period": 12, "fromDate": [ 2012, 8, 20 ], "dueDate": [ 2012,9,20 ], "daysInPeriod": 31, "principalOriginalDue": 9270.56, "principalDue": 9270.56, "principalOutstanding": 9270.56, "principalLoanBalanceOutstanding": 0, "interestOriginalDue": 185.4, "interestDue": 185.4, "interestOutstanding": 185.4, "feeChargesDue": 0, "penaltyChargesDue": 0, "totalOriginalDueForPeriod": 9455.96, "totalDueForPeriod": 9455.96, "totalPaidForPeriod": 0, "totalOutstandingForPeriod": 9455.96, "totalOverdue": 9455.96, "totalActualCostOfLoanForPeriod": 185.4 } ] }

Create a Client

---

URL: https://DomainName/api/v1/clients

Headers

---

Content-Type: application/JSON

client_id: To be shared at the time of integration

client_secret: To be shared at the time of integration

Request Body

---

{ "officeId": 1, "firstname": "Petra", "lastname": "Yton", "externalId": "786YYH7", "dateFormat": "dd MMMM yyyy", "locale": "en", "active": true, "activationDate": "04 March 2009", "submittedOnDate":"04 March 2009", "savingsProductId" : 4, "datatables": [{ "registeredTableName": "Family Details", "data": { "locale": "en", "Number of members": "5", "Number of dependents": "3", "No of Children": "2", "Date of verification": "14 December 2016", "dateFormat": "dd MMMM yyyy" } }, { "registeredTableName": "Residency Address", "data": { "locale": "en", "Address Line": "Basavana Gudi Road", "Street": "Gandhi Bazaar", "Landmark": "Aashrama", "COUNTRY_cd_Country": 17, "STATE_cd_State": "7", "DISTRICT_cd_District": "13", "Pincode": "560040" } }] }

Response Body

---

{ "officeId": 1, "clientId": 1, "resourceId": 1, "savingsId": 10 }