Extend Term Completion
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/ExtendTermCompletion
Use this API to extend the tenure of the plan which is in promo currently using account number or account ID or admin number along with other mandatory fields. This API fetches out the result in the form of success or failure.
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 the account whose interest deferment is to be extended. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 At least one account identifier is required from: 1. Account Number 2. Admin Number 3. Account ID Allowable Values: 19 |
AdminNumber int64 Conditional |
Admin Number of the account whose interest deferment is to be extended. Valid Values:0-9 Format:XXXXX Example:12345 At least one account identifier is required from: 1. Account Number 2. Admin Number 3. Account ID |
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 At least one account identifier is required from: 1. Account Number 2. Admin Number 3. Account ID |
PlanID integer Mandatory |
ID of the plan who's term is to be extended. Valid Values: 0 - 9 Format: xxxx Example: 72456 |
ExtendedTerms integer Mandatory |
Terms to be extended (In cycle). Valid Values: 0-12 Format: xx Example: 12 Allowable Values: 20 |
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, "AccountNumber": "8000000000000235", "AdminNumber": null, "AccountID": null, "PlanID": 101364, "ExtendedTerms": 3 }
Response fields details
Fields | Description |
---|---|
OLDTermCompletionDate datetime |
Term Completion Date before extension Valid Values:0-9 Format:MM/dd/yyyy HH:mm:ss Example:01/02/2020 12:00:00 |
TermCompletionDate datetime |
Term Completion Date after extension. Valid Values:0-9 Format:MM/dd/yyyy HH:mm:ss Example:02/02/2020 12:00:00 |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "ERR01037", "ResponseData": { "OLDTermCompletionDate": "10/02/2016 00:00:00", "TermCompletionDate": "11/02/2016 00:00:00" } }