Statement Amortization
Action: POST
Endpoint: /api/CoreCredit/Statement/StatementAmortization
Use this API to retrieve anticipated card account balances, such as statement balance, minimum due, ADB for the past 30 days, approximate interest due, and minimum due percentage of the balance for future cycles until the balance is paid off (provided there are no additional purchases posted to the card account).
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 Conditional |
This tag reflects the Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Example: 12345 |
|
AccountNumber string Conditional |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
|
StatementDate datetime Optional |
Date when Statement is generated. Format: MM/DD/YYYY Example: 11/30/2019 |
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,
"AccountID": null,
"AccountNumber": "5000000000011550",
"StatementDate": "12/31/2019 00:00:00"
}
Response fields details
| Fields | Description |
|---|---|
|
AccountID integer |
This tag reflects the Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Example: 12345 |
|
AccountNumber string |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
|
StatementDate datetime |
Date when statement is generated Format: MM/DD/YYYY Example: 11/30/2019 |
|
PutMinDueValueFromStatement array |
PutMinDueValueFromStatement |
Sample response body
{
"Message": "Amortization Schedule has been Returned Successfully",
"Status": true,
"ErrorCode": "ERR01087",
"ResponseData": {
"AccountID": 5722,
"AccountNumber": "1000000700000052",
"StatementDate": "11/30/2016 00:00:00",
"PutMinDueValueFromStatement": [
{
"Balance": "862.90",
"MinimumDue": "140.00",
"AppoxIntDue": "12.87",
"MinDuePercentageOfBal": "16.22%",
"ADB30Day": "858.23"
},
{
"Balance": "735.77",
"MinimumDue": "35.00",
"AppoxIntDue": "11.02",
"MinDuePercentageOfBal": "4.76%",
"ADB30Day": "734.61"
}
]
}
}