Alert Management
The CoreCard system allows you to set up card account alerts under different categories, such as monetary alerts, security alerts, periodic alerts, card alerts, and activity-based alerts. 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.
GetSMSAvailability_CM
Action: POST
Endpoint: /api/GetSMSAvailability_CM
Use this API to retrieve all the alerts present for cardholder.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition : At least one of Card Number/Proxy Number is required. Allowable Values: 16 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition : At least one of Card Number/Proxy Number is required. Allowable Values: 19 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "4066836120006028", "ProxyNumber": "1316619" }
Response Fields Detail
Fields | Description |
---|---|
AccountNumber string |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 |
ProxyNumber string |
Proxy Number of the cardholder Valid values:0-9 Example:1005 |
AlertStatus string |
Alert status of Customer. Valid Values : 1=SMS Alerts Opt-In 2=No Alerts 3=Email Alerts Opt-in 4=SMS and Email Alerts Opt-In 5=In-App Alerts Opt-In 6=SMS and In-App Alerts Opt-In 8=Email and In-App Alerts Opt-In 9=SMS and Email and In-App Alerts Opt-In |
MobileCarrier string |
Carrier of Mobile Phone number. Valid Values:a-z,0-9 Example: T-Mobile |
MobilePhoneCountryCode string |
Cardholder's Mobile Phone Country Code. Valid Values: 0-9 Example: 91 |
MobileNumber string |
Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 |
AlertEmailAddress string |
Email address of the cardholder where alert should be sent Valid Values: A-Z,a-z,0-9 Example : Core @gmail.com |
AlertDate string |
Date of alert creation or updation Format : MM/DD/YYYY HH:MM:SS:sss |
MESSAGEDefinition array |
Sample Response Body
{ "Message": "Processed Successfully.", "Status": true, "ErrorCode": "00000", "ResponseData": { "AccountNumber": "60000000027166", "ProxyNumber": "1316619", "AlertStatus": "", "MobileCarrier": "", "MobilePhoneCountryCode": "", "MobileNumber": "8547536956", "AlertEmailAddress": "new.untwal@corecard.com", "AlertDate": "", "MESSAGEDefinition": [ { "MessageID": "1163", "MessageCategory": "MONETARY", "MessageStatus": "Inactive", "Template": "Alerts for Withdrawal", "Operand": "GREATER THAN", "Amount": "0.00", "AtWhatTime": "6 PM EST", "SSAlertManagement": "2" }, { "MessageID": "1164", "MessageCategory": "MONETARY", "MessageStatus": "Inactive", "Template": "Alerts for Withdrawal Denied", "Operand": "GREATER THAN", "Amount": "0.00", "AtWhatTime": "7 PM EST", "SSAlertManagement": "2" } ] } }
GetSMSSetup_CM
Action: POST
Endpoint: /api/GetSMSSetup_CM
Use this API to set up alert\notification for the cardholder.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Optional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 16 |
ProxyNumber string Optional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 19 |
AlertStatus string Optional |
Alert status of Customer. Valid Values : 1=SMS Alerts Opt-In 2=No Alerts 3=Email Alerts Opt-in 4=SMS and Email Alerts Opt-In 5=In-App Alerts Opt-In 6=SMS and In-App Alerts Opt-In 8=Email and In-App Alerts Opt-In 9=SMS and Email and In-App Alerts Opt-In Allowable Values: 2 |
MobileCarrier string Conditional |
Carrier of Mobile Phone number. Valid Values:a-z,0-9 Example: T-Mobile Condition: Depends on product setup Either Optional else mandatory ( only with AlertStatus value 1 or 4) Allowable Values: 30 |
MobilePhoneCountryCode string Conditional |
Cardholder's Mobile Phone Country Code. Valid Values: 0-9 Example: 91 Condition: Mandatory when AlertStatus value is 1,4 and 6 Allowable Values: 2 |
MobileNumber string Conditional |
Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition: Mandatory when AlertStatus value is 1 and 4 Allowable Values: 10 |
AlertEmailAddress string Conditional |
Email address of the cardholder where alert should be sent Valid Values: A-Z,a-z,0-9 Example : Core @gmail.com Condition: Mandatory when AlertStatus value is 3. Allowable Values: 100 |
MarketingSource string Optional |
Marketing related alerts can be sent or not Valid values : 0 = Inactive 1= active Allowable Values: 30 |
MESSAGEDefinition
Optional |
MESSAGEDefinition |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "4066836120006028", "ProxyNumber": "1316619", "AlertStatus": "", "MobileCarrier": "", "MobilePhoneCountryCode": "", "MobileNumber": "5421563259", "AlertEmailAddress": "new.untwal@corecard.com", "MarketingSource": "", "MESSAGEDefinition": { "Message": [ { "MessageID": "194469", "ParameterValueSet": "", "ParameterValueAmount": "", "ParameterValueTime": "", "MessageStatusSet": "1" } ] } }
Response Fields Detail
Fields | Description |
---|
Sample Response Body
{ "Message": "Processed Successfully.", "Status": true, "ErrorCode": "00000", "ResponseData": {} }