Get Statement Messages
Action: POST
Endpoint: /api/CoreCredit/ControlParameters/GetStatementMessages
This API shall be used to get the statement message details.
Request fields details
| Fields | Description |
|---|---|
|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 ---- es: means Spanish Allowable Values: 10 |
|
ExternalIP string |
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 |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
|
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 |
|
SearchCriteria
|
Get or Set SearchCriteria |
|
BatchSize integer Optional |
Number of Transaction which can be view in one Batch 50 is default value Valid Values:0-9 Format:XX Example:20 |
|
PageIndex integer Optional |
Number of page. 0 is default value. Valid Values:0-9 Format:XX Example:12 |
|
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 |
|
SearchCriteria
Optional |
Get or Set SearchCriteria |
|
BatchSize integer Optional |
Number of Transaction which can be view in one Batch 50 is default value Valid Values:0-9 Format:XX Example:20 |
|
PageIndex integer Optional |
Number of page. 0 is default value. Valid Values:0-9 Format:XX Example:12 |
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,
"SearchCriteria": {
"InstitutionID": 3235,
"StatementMessageGroupCode": null,
"StatementMessageTypeCode": null,
"StatementType": null,
"StatementMessageCode": null,
"MessagePeriod": null,
"LanguageIndicator": null,
"CurrentBalance": null,
"Priority": null,
"LastDigitOfAccountNumber": null
},
"BatchSize": null,
"PageIndex": null
}
Response fields details
| Fields | Description |
|---|---|
|
StatementMessageList array |
Array to list the statement messages. |
|
StatementMessageList array |
Array to list the statement messages. |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"StatementMessageList": [
{
"StatementMessageGroupCode": "0",
"StatementMessageGroup": "First Group",
"LanguageIndicator": "en",
"StatementMessageTypeCode": "20",
"StatementMessageType": "Generic Message",
"StatementType": "7",
"StatementTypeName": "All",
"StatementMessageCode": "1",
"StatementMessage": "LOOKING FOR WEDDING OR ANNIVERSARY BANDS? COME TO xyz TO DISCOVER THE PERFECT SYMBOL OF YOUR LOVE.\r\nYOUR ACCOUNT REFLECTED DUE AMOUNT OF <Total Amount Due>. PLEASE REMIT AMOUNT DUE TODAY.<Account Open Date>",
"Priority": 1,
"CurrentBalance": null,
"LastDigitOfAccountNumber": null,
"MessagePeriodCode": null,
"MessagePeriod": null
}
]
}
}