GetLoanPlanSchedule
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetLoanPlanSchedule
The Purpose of this API is to get the plan schedule of Equal Payment Plan
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format: XXXXXXXXXX Example: 8000000000000110 Condition: At least one account identifier is required. Allowable Values: 16 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format: XXXXX Example:12345 Condition: At least one account identifier is required. |
PlanID integer Optional |
ID of the plan whose information is required.This API is for Equal Payment Plan only. Valid Values:0-9 Format: xxxx Example:72456 |
ScheduleType string Optional |
Schedule type of Institution Reports. Valid Values: 0 = Dynamic, 1 = Static Allowable Values: 2 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AccountNumber": "9110000000000040", "AdminNumber": null, "PlanID": null, "ScheduleType": "0" }
Response fields details
Fields | Description |
---|
Sample response body
{ "Message": "Return Successfully.", "Status": true, "ErrorCode": "ERR01093", "ResponseData": { "AccountNumber": "2020040000000016", "PlanList": [ { "PlanSequence": 1, "PlanID": 101441, "CurrentBalance": 7500.0, "LoanCreationDate": "01/18/2017", "OriginalLoanTerm": 24, "CurrentTerm": 24, "OriginalTotalPrincipal": 1000.0, "OriginalTotalInterest": 129.14, "OriginalEqualPayment": 562.96, "RevisedEqPmtAfterReschedule": 421.22, "PrincipalPaidToDate": 2500.0, "InterestPaidToDate": 0.0, "InvoiceID": "170118170216982", "PlanPaymentList": [ { "PaymentNumber": 1, "StatementDate": "01/18/2017", "PaymentDueDate": "02/18/2017", "AmountDue": 0.0, "PrincipalPayment": 0.0, "InterestPayment": 0.0, "InterestLeftOver": 2.05 } ] } ], "ResponseID": null } }