Get Instalment Loan Details
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetInstalmentLoanDetails
Use this API to obtain details of an installment loan. The API fetches installment loan details such as principal amount, loan term, interest rate, EMI amount, and optional payment to avoid interest.
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 |
AccountID integer Optional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 |
CPMID string Optional |
Unique identifier for credit plan master applied on account. Allowable Values: 500 |
TransactionAmount decimal Optional |
Transaction Amount Valid Values:0-9 Format:XXX.XX Example:200.00 |
LowRate decimal Conditional |
Low Rate of CreditPlanMaster (This will contain APR for Deferred plan if this is Deferred Plan). Valid Values:0-9 Format:XXX Example:29.9900 |
HighRate decimal Conditional |
High Rate of CreditPlanMaster (This will not have any value if it is a deferred plan) Valid Values:0-9 Format:XXXExample:29.9900 |
BillingTable integer Optional |
Billing Table ID in which Account to be assign after transfer. Valid Values:0-9 Format:XXXXX Example:12365 Allowable Values: 25 |
MerchantID string Optional |
Unique number of merchant account. Valid Values:0-9 Format:XXXXX Example:12345 |
Sample request body
{ "Source": "Web", "IPAddress": null, "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.205.0.56", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AccountID": 167509, "CPMID": "6065,6059", "TransactionAmount": 1000.0, "LowRate": null, "HighRate": null, "BillingTable": null, "MerchantID": null }
Response fields details
Fields | Description |
---|---|
CPMDetails array |
CPMDetails |
CurrencySymbol string |
This tag reflects the currency symbol |
Sample response body
{ "Message": "Installment Loan details have been return successfully.", "Status": true, "ErrorCode": "ERR01095", "ResponseData": { "CPMDetails": [ { "AccountID": 167509, "CPMID": "6065", "LoanTerm": "60", "FirstPaymentDate": "05/12/2017 00:00:00", "FinalPaymentDate": "04/17/2017 00:00:00", "FirstCycleDate": "04/17/2017 00:00:00", "NetPrincipal": "$ 1000.00", "InterestRate": "12.9900", "TotalInterestAmount": "358.05", "EMIAmount": "$ 22.63", "DefermentPeriod": null, "OptionalPymtToAvoidInterest": null, "RequiredPayment": "10", "PromoPlanName": "Fixed APR of 12.99% for 60 Months" } ] } }