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 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 |
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 this field becomes 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 this field becomes 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 details
Fields | Description |
---|
Sample response body
{ "Message": "Record Updated successfully", "Status": true, "ErrorCode": "ERR01045", "ResponseData": {} }