Account Management Alert
The CoreCard system allows you to set up card account alerts under different categories, such as monetary alerts, account alerts, security alerts, periodic alerts, card alerts, and activity-based alert. When a condition is met, the system assesses the notification rules and triggers an alert linked to the condition. An alert can be delivered to the cardholder in his chosen manner, such as via email or SMS or both. If you do not wish the cardholder to receive alerts or a specific alert message, you can deactivate them in the CoreCard system. You can also obtain details of account alerts that are currently active for any account using the CoreCard API.

Get Account Alerts
Action: POST
Endpoint: /api/CoreCredit/AccountManagementAlert/GetAccountAlerts
Use this API to get all the cardholders alerts. Alerts such as email and SMS alerts are set on a cardholder's account. Alerts for the instances such as status changes, monetary transaction posting, periodic alerts, cards and security instances are sent on registered email ID or mobile phone number.
Request fields detail
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 Default: en - English 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 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 |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
CardNumber string Conditional |
Card Number of account holder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896325874 Allowable Values: 19 |
AdminNumber int64 Conditional |
Admin number. Valid Values: 0-9 Example: 12345 |
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": "9000000500000170", "CardNumber": null, "AdminNumber": null }
Response fields detail
Fields | Description |
---|---|
AlertStatus string |
It shows current Alert status for particular user account. 1 - Active Alert and 2 - Stop Alert. Allowable Values: 2 |
PeriodAlertsCount integer |
Total Period Self Service Group returned count |
MonetaryAlertsCount integer |
Total Monetary Self Service Group returned count |
SecurityAlertsCount integer |
Total Security Self Service Group returned count |
CardAlertsCount integer |
Total Cards Self Service Group returned count |
StatusAlertsCount integer |
Total Status Self Service Group returned count |
MobileNumber string |
Mobile Phone Number in which SMS Alert need to be send Allowable Values: 10 |
MobileCarrier string |
Carrier of Mobile Phone number Allowable Values: 30 |
MarketingSource string |
Marketing Source Allowable Values: 1 |
AlertDate datetime |
Date in which alert setup process being invoke |
EmailID string |
Email Id in which Email Alerts need to be send Allowable Values: 300 |
AlertList array |
Account Alerts List |
Sample response body
{ "application/json": { "Message": "Record Found", "Status": true, "ErrorCode": "ERR01520", "ResponseData": { "AlertStatus": "0", "PeriodAlertsCount": 2, "MonetaryAlertsCount": 14, "SecurityAlertsCount": 4, "CardAlertsCount": 6, "StatusAlertsCount": 7, "MobileNumber": "", "MobileCarrier": null, "MarketingSource": null, "AlertDate": null, "EmailID": "CH7@mail1.com", "AlertList": [ { "MessageID": "1036", "MessageCategory": "MONETARY", "MessageStatus": "Active", "MessageTemplate": "Transaction activity", "Operand": "GREATER THAN", "Amount": -1.0, "AtWhatTime": "", "StatusCHUpdate": false, "ThresholdDays": null, "IsEmailAlert": false, "IsMobileAlert": false } ] } } }
Update Account Alerts
Action: POST
Endpoint: /api/CoreCredit/AccountManagementAlert/UpdateAccountAlerts
Use this API to opt-in the account alerts and update the alert parameters to Active or Stop for a particular account or to change the mobile number or email id.
Request fields detail
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 Default: en - English 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 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 |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 |
EmailID string Mandatory |
Email Id in which Email Alerts need to be send Allowable Values: 50 |
AlertDate datetime Optional |
Date in which alert setup process being invoke |
MobileCarrier string Conditional |
Carrier of Mobile Phone number Allowable Values: 30 |
MobilePhoneNumber string Conditional |
Mobile Phone Number in which SMS Alert need to be send Allowable Values: 15 |
AlertStatus string Optional |
It shows current Alert status for particular user account. 1 - Active Alert and 2 - Stop Alert. Allowable Values: 2 |
AccountAlertsList array |
AccountAlertsList |
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": "5000000000011204", "AdminNumber": null, "EmailID": "abc@abc.abc", "AlertDate": null, "MobileCarrier": "12345", "MobilePhoneNumber": "9876543210", "AlertStatus": "1", "AccountAlertsList": [ { "MessageID": "1288", "MessageCategory": "MONETARY", "MessageStatus": "1", "MessageTemplate": null, "Operand": "LT", "Amount": 10.0, "AtWhatTime": "12:00", "StatusCHUpdate": 1, "ThresholdDays": "7", "IsEmailAlert": true, "IsMobileAlert": true } ] }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Record Updated successfully", "Status": true, "ErrorCode": "ERR01045", "ResponseData": null } }
Get Pause Alerts
Action: POST
Endpoint: /api/CoreCredit/AccountManagementAlert/GetPauseAlerts
Use this API to obtain the Active or Disabled status for the Paused Alerts setting. Paused Alerts is a functionality or setting through which a cardholder can pause the alerts for a specific date range. Additionally, the API retrieves the Paused Alerts start date and Paused Alerts end date.
Request fields detail
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 Default: en - English 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 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 |
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
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, "AdminNumber": 5820 }
Response fields detail
Fields | Description |
---|---|
PauseAlertStartDate datetime |
Date from when no alerts should be send to the Customer. Format:YYYYMMDDHHMMSS Example:20200103110000 |
PauseAlertEndDate datetime |
Date till when no alerts should be send to the Customer. Format:YYYYMMDDHHMMSS Example:20200203110000 |
PauseAlertStatus integer |
Status of Pause Alerts,whether it is active or disabled. Valid Values:0 Or 1 Example:0 |
Sample response body
{ "application/json": { "Message": "Record Found", "Status": true, "ErrorCode": "ERR01520", "ResponseData": { "PauseAlertStartDate": "06/05/2020 00:00:00", "PauseAlertEndDate": "07/31/2020 23:59:57", "PauseAlertStatus": 0 } } }
Manage Paperless Alerts
Action: POST
Endpoint: /api/CoreCredit/AccountManagementAlert/ManagePaperlessAlerts
Use the API to opt-in or opt-out paperless alert settings on the account. On providing conditional fields such as account number or admin number along with mandatory field Decision Flags such as Get or Set, this API will set the alerts.
Request fields detail
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 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
DecisionFlag integer Optional |
Flag to decide if request should be process for Set or Get paper less settings. Valid Values:0-Get 1-Set Example: 1 |
PaperLessValue integer Optional |
Tag to opt-in/opt-out from Paperless alert setting. Valid Values: 0-Opt-in 1-Opt-out Example:1 -Opt-out Condition:This required field when DecisionFlag =1. |
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 Default: en - English 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 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 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
DecisionFlag integer Optional |
Flag to decide if request should be process for Set or Get paper less settings. Valid Values:0-Get 1-Set Example: 1 |
PaperLessValue integer Optional |
Tag to opt-in/opt-out from Paperless alert setting. Valid Values: 0-Opt-in 1-Opt-out Example:1 -Opt-out Condition:This required field when DecisionFlag =1. |
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, "AdminNumber": 6148, "AccountNumber": null, "DecisionFlag": 0, "PaperLessValue": null }
Response fields detail
Fields | Description |
---|---|
PaperLessValue integer |
Tag to opt-in/opt-out from Paperless alert setting. Valid Values: 0-Opt-in 1-Opt-out Example:1 -Opt-out |
PaperLessValue integer |
Tag to opt-in/opt-out from Paperless alert setting. Valid Values: 0-Opt-in 1-Opt-out Example:1 -Opt-out |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "PaperLessValue": 1 } } }
Update Pause Alerts
Action: POST
Endpoint: /api/CoreCredit/AccountManagementAlert/UpdatePauseAlerts
Use this API to pause or remove an optional Paused Alerts based on a cardholder request. The API provides options such as Paused Alerts status, Paused Alerts start date, and Paused Alerts End Date.
Request fields detail
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 Default: en - English 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 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 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required. |
PauseAlertStatus integer Mandatory |
Status of Pause Alerts,whether it is active or disabled. Valid Values:0- Disabled 1-Active Example:1 |
PauseAlertStartDate datetime Conditional |
Date from when no alerts should be send to the Customer. Format: MM/dd/yyyy HH:mm:ss Example: 01/01/2020 00:00:00 Condition:If PauseAlertStatus is set as 1, then thie field becom mandatory |
PauseAlertEndDate datetime Conditional |
Date till when no alerts should be send to the Customer. Format: MM/dd/yyyy HH:mm:ss Example: 01/30/2020 00:00:00 Condition:If PauseAlertStatus is set as 1, then thie field becom mandatory |
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition: At least one account identifier is required. Allowable Values: 19 |
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, "AdminNumber": 129414, "AccountNumber": null, "PauseAlertStatus": 1, "PauseAlertStartDate": "06/01/2017 00:00:00", "PauseAlertEndDate": "06/30/2017 00:00:00" }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Record Updated successfully", "Status": true, "ErrorCode": "ERR01045", "ResponseData": {} } }