Alerts Manager
| Name | Description | Introduced In |
|---|---|---|
| getCount | This API fetches the count of unread notifications. This API is used in Online Banking (OLB). | 2020.04 |
| getCustomerAccountAlertPreference | This API fetches the account alert preferences of the customer. | 2020.04 |
| GET(Notifications) | This API fetches the list of notifications of the signed-in user. | 2021.07 |
| PATCH (updateReadCount) | This API update the notification read status of the signed-in user. | 2021.07 |
| deleteNotification | This API is used to delete a particular notification. | 2021.07 |
getCount
|
Description: |
This API fetches the count of unread notifications. This API is used in Online Banking (OLB). |
|
Method: |
Custom Verb |
|
URL: |
/services/data/v1/Notifications/objects/UnreadNotifications/getCount |
|
Security Level: |
Authenticated App User |
|
Body Request: |
None |
|
Response |
Parameters unreadNotificationCount Specifies the count of unread notifications. Notifications Specifies a collection of notifications. {
"Notifications":[
{
"unreadNotificationCount":"192"
}
],
"opstatus":0,
"httpStatusCode":0
}
|
getCustomerAccountAlertPreference
|
Description: |
This API fetches the count of unread notifications. This API is used in Online Banking (OLB). |
|
Method: |
Custom Verb |
|
URL: |
/v1/RBObjects/operations/DbxUserAlerts/getCustomerAccountAlertPreference |
|
Security Level: |
Authenticated App User |
|
Body Request: |
None |
|
Response |
Parameters /accountInfo Specifies an array of the accounts JSON object. /accountInfo/accountID Specifies the unique ID of the account. /accountInfo/transactionCurrency Specifies the currency used while performing the transactions. /accountInfo/nickName Specifies the nickname of the account. /accountInfo/accountType Specifies the type of account such as Savings account, Debit account, Loans account, and so on. /accountInfo/isEnabled Specifies whether the Alerts feature is enabled. The value is Boolean. /accountInfo/bankName Specifies the name of the bank. {
"accountInfo":[
{
"accountID":"190128223241502",
"transactionCurrency":"USD",
"nickName":"My Checking",
"accountType":"Savings",
"isEnabled":"true",
"bankName":"Infinity"
},
{
"accountID":"190128223242830",
"transactionCurrency":"USD",
"nickName":"My Checking",
"accountType":"Checking",
"isEnabled":"false",
"bankName":"Infinity"
},
{
"accountID":"190128223244156",
"transactionCurrency":"USD",
"nickName":"My Credit Card",
"accountType":"CreditCard",
"isEnabled":"false",
"bankName":"Infinity"
},
{
"accountID":"190128223246822",
"transactionCurrency":"USD",
"nickName":"Turbo Auto Loan",
"accountType":"Loan",
"isEnabled":"false",
"bankName":"Infinity"
},
{
"accountID":"190128223245490",
"transactionCurrency":"USD",
"nickName":"12 Months Term Deposit",
"accountType":"Deposit",
"isEnabled":"false",
"bankName":"Infinity"
}
],
"isAlertsAccountNumberLevel":"true",
"opstatus":0,
"httpStatusCode":"0"
}
|
GET(Notifications)
|
Description: |
This API fetches the list of notifications of the signed-in user. |
||
|
Method: |
GET |
||
|
URL: |
/services/data/v1/Notifications/objects/NotificationList |
||
|
Security Level: |
Authenticated App User |
||
| Header Request |
|
||
|
Body Request: |
None |
||
|
Response |
Parameters isRead Specifies whether the notification is read notificationId Specifies the unique ID of the notification notificationSubject Specifies the subject of the notification notificationText Specifies the description of the notification receivedDate Specifies the notification received date userNotificationId Secifies the user notification ID notificationCategory Specifies the category of received notification records Specifies the collection of notifications
{
"records": [
{
"isRead": "0",
"notificationId": "451",
"notificationSubject": "Sign In Successful",
"notificationText": "You have successfully signed in to your online banking profile.",
"receivedDate": "2021-07-15T05:04:49Z",
"userNotificationId": "1059",
"notificationCategory": "ALERT_CAT_SECURITY"
},
{
"isRead": "1",
"notificationId": "450",
"notificationSubject": "Sign In Successful",
"notificationText": "You have successfully signed in to your online banking profile.",
"receivedDate": "2021-07-15T04:27:51Z",
"userNotificationId": "1058",
"notificationCategory": "ALERT_CAT_SECURITY"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
|
||
| Service Flow: |
|
PATCH (updateReadCount)
|
Description: |
This API update the notification read status of the signed-in user. |
||
|
Method: |
POST |
||
|
URL: |
/services/data/v1/Notifications/objects/UnreadNotifications |
||
|
Security Level: |
Authenticated App User |
||
| Header Request |
|
||
|
Body Request: |
Parameters userNotificationId (Mandatory) Specifies the notification ID of message that must be updated as read. {
"userNotificationId": "1035"
}
|
||
|
Response |
Parameters totalRecords Specifies the total records of notifications updatedRecords Specifies the count of updated records notificationId Specifies the notification ID of updated records {
"totalRecords": 1,
"updatedRecords": 1,
"notificationId": null,
"opstatus": 0,
"httpStatusCode": 0
}
|
||
| Service Flow: |
|
deleteNotification
|
Description: |
This API is used to delete a particular notification. |
||
|
Method: |
POST |
||
|
URL: |
/services/data/v1/Notifications/operations/NotificationList/deleteNotification |
||
|
Security Level: |
Authenticated App User |
||
| Header Request |
|
||
|
Body Request: |
Parameters userNotificationId (Mandatory) Specifies the notification ID of message that must be deleted. {
"userNotificationId": "1035"
}
|
||
|
Response |
Parameters result Specifies the result of the deleted notification {
"result": "Notification is deleted",
"opstatus": 0,
"httpStatusCode": 0
}
|
||
| Service Flow: |
|
In this topic