SD-Trillion Loans - (Vehicle Loan) - LMS-190824-105638
SD-Trillion Loans - (Vehicle Loan) - LMS-190824-105638
Table Of Contents
3. LMS APIs
End Point -
POST {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/markCollection
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Sample Request -
1 {
2 "transactionAmount": 0,
3 "dateFormat": "string",
4 "timeFormat": "string",
5 "locale": "string",
6 "paymentTypeId": 0,
7 "note": "string",
8 "transactionDate": "03-11-8085",
9 "receiptNumber": "string"
10 }
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "officeId": 1,
3 "clientId": 11,
4 "loanId": 15,
5 "resourceId": 1125,
6 "transactionId": "1125",
7 "changes": {
8 "transactionDate": "04-07-2024",
9 "transactionAmount": "2768.0",
10 "locale": "en",
11 "dateFormat": "dd-MM-yyyy",
12 "paymentTypeId": "1006",
13 "note": "I paid partially",
14 "receiptNumber": "00231111",
15 "principalPortion": 390.0,
16 "interestPortion": 75.0,
17 "penaltyPortion": 180.45,
18 "overpaymentPortion": 0
19 },
20 "additionalResponseData": {
21 "status": 300
22 }
23 }
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
GET {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/foreclosure-details
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Request Params -
1 transactionDate=10-04-2024
2 isTotalOutstandingInterest=true
3 includePreClosureReason=true
Response -
1. SUCCESS 200 OK -
1 {
2 "status": "SUCCESS",
3 "data": {}
4 }
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
POST {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/foreclosure-execute
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Sample Request -
1 {
2 "note": "string",
3 "preClosureReasonId": 0,
4 "transactionAmount": "7408976865",
5 "transactionDate": "string",
6 "paymentTypeId": 0,
7 "interestWaiverAmount": "string",
8 "receiptNumber": "string",
9 "chargeDiscountDetails": [
10 {}
11 ],
12 "waiveCharges": [
13 {}
14 ]
15 }
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "status": "SUCCESS",
3 "data": {}
4 }
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
GET {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/noc
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3.5 Fetch SOA API
This endpoint is used for fetching the SOA against a loan account
End Point -
GET {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/fetchSOA
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Request Params -
1 dateOfGeneration=2025-02-19
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
GET {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/getCharges
Path Variable -
LAN : "{{LOAN ACCOUNT NUMBER}}"
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Request Params -
1 exclude=loanBasicDetails45isFetchSpecificData=true
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "id": 69,
3 "accountNo": "000000069",
4 "status": {
5 "id": 300,
6 "code": "loanStatusType.active",
7 "value": "Active",
8 "pendingApproval": false,
9 "waitingForDisbursal": false,
10 "active": true,
11 "closedObligationsMet": false,
12 "closedWrittenOff": false,
13 "closedRescheduled": false,
14 "closed": false,
15 "overpaid": false,
16 "transferInProgress": false,
17 "transferOnHold": false,
18 "underTransfer": false
19 },
20 "clientId": 260,
21 "clientAccountNo": "000000260",
22 "clientName": "TCFour Topup",
23 "clientOfficeId": 1,
24 "loanProductId": 4,
25 "loanProductName": "Easy Loan Topup",
26 "isLoanProductLinkedToFloatingRate": false,
27 "loanType": {
28 "id": 1,
29 "code": "accountType.individual",
30 "value": "Individual"
31 },
32 "weeksInYearType": {
33 "id": 1,
34 "code": "52",
35 "value": "52"
36 },
37 "currency": {
38 "code": "INR",
39 "name": "Indian Rupee",
40 "decimalPlaces": 2,
41 "inMultiplesOf": 0,
42 "displaySymbol": "₹",
43 "nameCode": "currency.INR",
44 "displayLabel": "Indian Rupee (₹)"
45 },
46 "principal": 15000.0,
47 "approvedPrincipal": 15000.0,
48 "proposedPrincipal": 15000.0,
49 "brokenPeriodInterest": 0.0,
50 "termFrequency": 270,
51 "termPeriodFrequencyType": {
52 "id": 0,
53 "code": "termFrequency.periodFrequencyType.days",
54 "value": "Days"
55 },
56 "numberOfRepayments": 270,
57 "repaymentEvery": 1,
58 "repaymentFrequencyType": {
59 "id": 0,
60 "code": "repaymentFrequency.periodFrequencyType.days",
61 "value": "Days"
62 },
63 "interestRatePerPeriod": 35.14,
64 "interestRateFrequencyType": {
65 "id": 3,
66 "code": "interestRateFrequency.periodFrequencyType.years",
67 "value": "Per year"
68 },
69 "annualInterestRate": 35.14,
70 "isFloatingInterestRate": false,
71 "allowUpfrontCollection": false,
72 "numberOfPaidRepayments": 0,
73 "numberOfDueRepayments": 270,
74 "amortizationType": {
75 "id": 1,
76 "code": "amortizationType.equal.installments",
77 "value": "Equal installments"
78 },
79 "interestType": {
80 "id": 0,
81 "code": "interestType.declining.balance",
82 "value": "Declining Balance"
83 },
84 "interestCalculationPeriodType": {
85 "id": 0,
86 "code": "interestCalculationPeriodType.daily",
87 "value": "Daily"
88 },
89 "allowPartialPeriodInterestCalcualtion": false,
90 "transactionProcessingStrategyId": 6,
91 "transactionProcessingStrategyName": "Interest, Principal, Penalties, Fees Order",
92 "transactionProcessingStrategyCode": "interest-principal-penalties-fees-order-strategy",
93 "graceOnPrincipalPayment": 0,
94 "graceOnInterestCharged": 0,
95 "syncDisbursementWithMeeting": false,
96 "isCancellationAllowed": false,
97 "timeline": {
98 "submittedOnDate": [
99 2024,
100 7,
101 9
102 ],
103 "submittedByUsername": "system",
104 "submittedByFirstname": "system",
105 "submittedByLastname": "system",
106 "approvedOnDate": [
107 2024,
108 7,
109 9
110 ],
111 "approvedByUsername": "system",
112 "approvedByFirstname": "system",
113 "approvedByLastname": "system",
114 "expectedDisbursementDate": [
115 2024,
116 7,
117 9
118 ],
119 "actualDisbursementDate": [
120 2024,
121 7,
122 9
123 ],
124 "disbursedByUsername": "durgesh",
125 "disbursedByFirstname": "durgesh",
126 "disbursedByLastname": "songire",
127 "expectedMaturityDate": [
128 2025,
129 4,
130 5
131 ]
132 },
133 "summary": {
134 "currency": {
135 "code": "INR",
136 "name": "Indian Rupee",
137 "decimalPlaces": 2,
138 "inMultiplesOf": 0,
139 "displaySymbol": "₹",
140 "nameCode": "currency.INR",
141 "displayLabel": "Indian Rupee (₹)"
142 },
143 "principalDisbursed": 15000.0,
144 "principalPaid": 0.0,
145 "principalWrittenOff": 0.0,
146 "principalOutstanding": 15000.0,
147 "principalFromIncomePosting": 0.0,
148 "principalOverdue": 1980.0,
149 "principalNetDisbursed": 4288.5,
150 "interestCharged": 2043.0,
151 "interestPaid": 0.0,
152 "interestWaived": 0.0,
153 "interestWrittenOff": 0.0,
154 "interestOutstanding": 2043.0,
155 "interestOverdue": 540.0,
156 "feeChargesCharged": 706.5,
157 "feeChargesDueAtDisbursementCharged": 706.5,
158 "feeChargesPaid": 706.5,
159 "feeChargesWaived": 0.0,
160 "feeChargesWrittenOff": 0.0,
161 "feeChargesOutstanding": 0.0,
162 "feeChargesOverdue": 0.0,
163 "penaltyChargesCharged": 0.0,
164 "penaltyChargesPaid": 0.0,
165 "penaltyChargesWaived": 0.0,
166 "penaltyChargesWrittenOff": 0.0,
167 "penaltyChargesOutstanding": 0.0,
168 "penaltyChargesOverdue": 0.0,
169 "totalExpectedRepayment": 17749.5,
170 "totalRepayment": 706.5,
171 "totalExpectedCostOfLoan": 2749.5,
172 "totalCostOfLoan": 706.5,
173 "totalWaived": 0.0,
174 "totalWrittenOff": 0.0,
175 "totalOutstanding": 17043.0,
176 "totalOverdue": 2520.0,
177 "overdueSinceDate": [
178 2024,
179 7,
180 10
181 ],
182 "excessAmountPaid": 0,
183 "availableBalance": 0,
184 "upfrontInterestAvilable": 0.0,
185 "rebateApplied": 0.0,
186 "totalAdvanceEmiAmount": 0
187 },
188 "charges": [
189 {
190 "id": 89,
191 "chargeId": 2,
192 "name": "Processing fee",
193 "chargeTimeType": {
194 "id": 1,
195 "code": "chargeTimeType.disbursement",
196 "value": "Disbursement"
197 },
198 "chargeCalculationType": {
199 "id": 2,
200 "code": "chargeCalculationType.percent.of.amount",
201 "value": "% Approved Amount"
202 },
203 "percentage": 4.71,
204 "amountPercentageAppliedTo": 15000.0,
205 "currency": {
206 "code": "INR",
207 "name": "Indian Rupee",
208 "decimalPlaces": 2,
209 "displaySymbol": "₹",
210 "nameCode": "currency.INR",
211 "displayLabel": "Indian Rupee (₹)"
212 },
213 "amount": 706.5,
214 "amountPaid": 706.5,
215 "amountWaived": 0,
216 "amountWrittenOff": 0,
217 "amountOutstanding": 0.0,
218 "amountOrPercentage": 4.71,
219 "penalty": false,
220 "chargePaymentMode": {
221 "id": 0,
222 "code": "chargepaymentmode.regular",
223 "value": "Regular"
224 },
225 "paid": true,
226 "waived": false,
227 "chargePayable": false,
228 "minCap": 1.0,
229 "maxCap": 1000000.0,
230 "isGlimCharge": false,
231 "isCapitalized": false,
232 "taxGroupId": 2,
233 "isMandatory": true,
234 "slabs": [
235 {
236 "id": 0,
237 "type": {
238 "id": 0,
239 "code": "slabChargeType.installment.invalid",
240 "value": "INVALID"
241 },
242 "subSlabs": []
243 }
244 ],
245 "isSlabBased": false,
246 "decimalPlaces": 0,
247 "isAmountNonEditable": false,
248 "amountSansTax": 598.73,
249 "taxAmount": 107.77,
250 "discountData": {},
251 "isUpdateThroughDiscount": false,
252 "isAccruable": true,
253 "accountingType": "ACCRUAL_BASED",
254 "canLendCharge": false,
255 "canAddChargeToPrincipalForComputation": false,
256 "chargeIdentifier": "PF",
257 "netPaid": 706.5,
258 "accountNumber": "000000069",
259 "chargeType": {
260 "id": 1,
261 "code": "USER_CHARGE",
262 "value": "User Charge"
263 },
264 "recognitionType": {
265 "id": 1,
266 "code": "SINGLE",
267 "value": "Single"
268 }
269 },
270 {
271 "id": 90,
272 "chargeId": 7,
273 "name": "Top Up Outstanding",
274 "chargeTimeType": {
275 "id": 1,
276 "code": "chargeTimeType.disbursement",
277 "value": "Disbursement"
278 },
279 "chargeCalculationType": {
280 "id": 1,
281 "code": "chargeCalculationType.flat",
282 "value": "Flat"
283 },
284 "percentage": 0,
285 "amountPercentageAppliedTo": 0,
286 "currency": {
287 "code": "INR",
288 "name": "Indian Rupee",
289 "decimalPlaces": 2,
290 "displaySymbol": "₹",
291 "nameCode": "currency.INR",
292 "displayLabel": "Indian Rupee (₹)"
293 },
294 "amount": 0.0,
295 "amountPaid": 0,
296 "amountWaived": 0,
297 "amountWrittenOff": 0,
298 "amountOutstanding": 0.0,
299 "amountOrPercentage": 0.0,
300 "penalty": false,
301 "chargePaymentMode": {
302 "id": 0,
303 "code": "chargepaymentmode.regular",
304 "value": "Regular"
305 },
306 "paid": true,
307 "waived": false,
308 "chargePayable": false,
309 "isGlimCharge": false,
310 "isCapitalized": false,
311 "taxGroupId": 0,
312 "isMandatory": false,
313 "slabs": [
314 {
315 "id": 0,
316 "type": {
317 "id": 0,
318 "code": "slabChargeType.installment.invalid",
319 "value": "INVALID"
320 },
321 "subSlabs": []
322 }
323 ],
324 "isSlabBased": false,
325 "decimalPlaces": 0,
326 "isAmountNonEditable": false,
327 "discountData": {},
328 "isUpdateThroughDiscount": false,
329 "isAccruable": true,
330 "accountingType": "ACCRUAL_BASED",
331 "canLendCharge": false,
332 "canAddChargeToPrincipalForComputation": false,
333 "chargeIdentifier": "TP",
334 "netPaid": 0,
335 "accountNumber": "000000069",
336 "chargeType": {
337 "id": 1,
338 "code": "USER_CHARGE",
339 "value": "User Charge"
340 },
341 "recognitionType": {
342 "id": 1,
343 "code": "SINGLE",
344 "value": "Single"
345 }
346 }
347 ],
348 "feeChargesAtDisbursementCharged": 706.5,
349 "loanProductCounter": 2,
350 "multiDisburseLoan": false,
351 "canDefineInstallmentAmount": false,
352 "canDisburse": false,
353 "canUseForTopup": true,
354 "isTopup": true,
355 "inArrears": true,
356 "isNPA": false,
357 "overdueCharges": [],
358 "daysInMonthType": {
359 "id": 1,
360 "code": "DaysInMonthType.actual",
361 "value": "Actual"
362 },
363 "daysInYearType": {
364 "id": 365,
365 "code": "DaysInYearType.days365",
366 "value": "365 Days"
367 },
368 "isInterestRecalculationEnabled": false,
369 "createStandingInstructionAtDisbursement": false,
370 "isVariableInstallmentsAllowed": false,
371 "minimumGap": 0,
372 "maximumGap": 0,
373 "brokenPeriodMethodType": {
374 "id": 1,
375 "code": "brokenPeriodMethod.adjust.in.first.emi",
376 "value": "Add to first installment interest"
377 },
378 "considerFutureDisbursmentsInSchedule": false,
379 "considerAllDisbursementsInSchedule": false,
380 "calculatedEmiAmount": 63.0,
381 "isLocked": false,
382 "clientOfficeName": "Head Office",
383 "deferPaymentsForHalfTheLoanTerm": false,
384 "isClientVerified": false,
385 "allowsDisbursementToGroupBankAccounts": false,
386 "isDpConfigured": false,
387 "productInterestRatePerPeriod": 20.0,
388 "productInterestRateFrequencyType": {
389 "id": 3,
390 "code": "interestRateFrequency.periodFrequencyType.years",
391 "value": "Per year"
392 },
393 "productAnnualInterestRate": 20.0,
394 "brokenPeriodInterestCollectAtDisbursement": false,
395 "isUpfrontInterestEnabled": false,
396 "eventBasedCharges": [],
397 "discountTypeOptions": [
398 {
399 "id": 1,
400 "code": "chargeDiscountCalculationType.discountInAmount",
401 "value": "Discount in Amount"
402 },
403 {
404 "id": 2,
405 "code": "chargeCalculationType.discountInPercentage",
406 "value": "Discount in Percentage"
407 }
408 ],
409 "dpdDays": 40,
410 "actualNumberOfRepayments": 270,
411 "loanOfficeName": "Head Office",
412 "loanOfficeId": 1,
413 "loanOfficeHierarchy": ".",
414 "anchors": [],
415 "productType": "PERSONAL LOAN",
416 "mpdDays": 1.0,
417 "currentInterestRate": 35.14,
418 "loanAdditionalDetailsData": {
419 "id": 69,
420 "loanId": 69,
421 "isFldg": false,
422 "additionalInterestComputationType": {
423 "id": 4,
424 "code": "standard",
425 "value": "Standard"
426 },
427 "courseOnInterestPayment": 0,
428 "additionalGraceOnInterestPayment": 0,
429 "courseOnPrincipalPayment": 0,
430 "additionalGraceOnPrincipalPayment": 0
431 }
432 }
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
GET {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/repaymentSchedule
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Sample Response -
1. SUCCESS 200 OK -
1 {}
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
POST {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/save-charges
Path Variable -
LAN : "{{LOAN ACCOUNT NUMBER}}"
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Sample Request -
1 {
2 "amount": 1001,
3 "chargeId": 4,
4 "dueDate": "08-05-2024"
5 }
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "loanId": 2,
3 "resourceId": 222
4 }
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
End Point -
POST {{BASE-URL}}/partners/api/v1/collection/loanAccounts/{{LAN}}/Charges/{{CHARGE-
ID}}/waiveCharge
Path Variable -
Headers -
authorization: "{{AUTH-TOKEN}}"
content-type : "application/json"
partnerId : "{{PARTNER_ID}}"
Sample Request -
1 {
2 "chargeWaiverDate": "18-01-2024"
3 }
Sample Response -
1. SUCCESS 200 OK -
1 {
2 "loanId": 2,
3 "status": "SUCCESS"
4 }
1 {
2 "status": "FAIL/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }
3. ERROR 500 -
1 {
2 "status": "ERROR/SERVER_ERROR",
3 "message": "string",
4 "traceId": "unique id for tracing whole request trace",
5 "data": {}
6 }