Get Plan And Payment By Amount
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetPlanAndPaymentByAmount
Use this API to get the plan details attached to the provided amount. To get the plan details such as CPM, Total Interest Amount, Minimum Required Payment, Interest Rate, EMI amount, and Loan term, the user needs to provide Merchant Number, Transaction Amount, and Product Mapping Code.
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 |
MerchantNumber string Mandatory |
Number which is assgined to a Merchant. Valid Values- 0-9 Format:XXXXXX Example: 92234 Allowable Values: 9 |
TransactionAmount decimal Mandatory |
Amount of Transaction Valid Values:0-9 Format:XXX.XX Example:200.00 |
ProductMapping string Mandatory |
Product Mapping Code Valid Values: 0-9, A-Z Format: XXXX Example: 3399 Allowable Values: 100 |
PreQualID string Optional |
This tag refers to Pre-qualification ID of corecard Application Valid Values: 0-9, A-Z Format: XXXX Example: 3399 Allowable Values: 100 |
ApplicationID int64 Optional |
This tag reflects the Application ID of an application. Valid Values: 0-9 Format: XXXX Example: 3399 Allowable Values: 100 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "MerchantNumber": "11111111", "TransactionAmount": 1000.0, "ProductMapping": "ABC Patient Solutions Revolving", "PreQualID": "", "ApplicationID": null }
Response fields details
Fields | Description |
---|---|
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique.API is returned from our external server Valid Values:0-9,a-z Format: XXX Example:200 Allowable Values: 10 |
CreditPlanMasterAndPaymentInformationDetails array |
Sample response body
{ "Message": "Processed Successfully.", "Status": true, "ErrorCode": "ERR01149", "ResponseData": { "ResponseID": "56882604", "CreditPlanMasterAndPaymentInformationDetails": [ { "CreditPlanMaster": "6071", "CreditPlanDescription": "Fixed APR of 5.99%-28.99% for 48 Months", "CreditPlanType": "EPP", "LoanTerm": "48", "LowRate": "5.99%", "HighRate": "28.99%", "InterestRate": "5.99% - 28.99%", "TotalInterestAmount": "$127.04 - $700.16", "EMIAmount": "$23.48 - $35.42", "DefermentPeriod": null, "OptionalPaymentToAvoidInterest": null, "MonthlyMinimumRequiredPayment": null } ] } }