Category links

API Links

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

POST /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

This tag indicates the Card Number of the cardholder Valid values:0-9 Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition : At least one of CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition : Atleast either of card number or 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 Example: 4377490000000047 Valid values are 0-9

ProxyNumber

string

Proxy Number of the cardholder Example: 1050 Valid values are 0-9

AlertStatus

string

SMSStatus(inherit)

MobileCarrier

string

Sms Address

MobilePhoneCountryCode

string

Mobile Phone Country Code

MobileNumber

string

Mobile Number

AlertEmailAddress

string

Alert Email Address

AlertDate

string

This tag indicates the date when the alert was created or updated

MESSAGEDefinition

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "60000000027166",
    "ProxyNumber": "1316619",
    "AlertStatus": "",
    "MobileCarrier": "",
    "MobilePhoneCountryCode": "",
    "MobileNumber": "8547536956",
    "AlertEmailAddress": "new.untwal@corecard.com",
    "AlertDate": "",
    "MESSAGEDefinition": [
      {
        "MessageID": "194469",
        "MessageCategory": "CARD",
        "MessageStatus": "Acive",
        "Template": "",
        "Operand": "",
        "Amount": "20",
        "AtWhatTime": "",
        "SSAlertManagement": ""
      }
    ]
  }
}

GetSMSSetup_CM

Action: POST

Endpoint: /api/GetSMSSetup_CM

POST /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

Card Number of card Example: *********1234567[For Compliance masked BIN and Extended BIN] Valid values are 0-9 Clear Card Number Condition:At least one of Card Number/ Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Optional

Proxy Number of card Example: 1001741741741 Valid values are 0-9 Condition:At least one of Card Number/ Proxy Number is required.

Allowable Values:

19

AlertStatus

string

Optional

AlertStatus Set that is set on Customer.It have below possilbe 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

Optional

MobileCarrier that is Set on Customer. Example:Weblink Wireless Verizon Wireless(formerly Airtouch) Bellsouth BellSouth Mobility

Allowable Values:

30

MobilePhoneCountryCode

string

Optional

MobilePhoneCountryCode

Allowable Values:

2

MobileNumber

string

Optional

Mobile Phone Number of the card holder . Valid values are 0-9 Example:8527411231

Allowable Values:

10

AlertEmailAddress

string

Optional

An email address of cardholder.

Allowable Values:

100

MarketingSource

string

Optional

This tag is used for displaying marketing related information on the alerts that are sent. This is derived from product set up. Possible 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": {}
}