Sorry, you need to enable JavaScript to visit this website.
Skip to main content

Low Balance Warning - All Accounts

Overview

The Low Balance Warning - All Accounts insight is a schedule-triggered insight that alerts users whenever the balance across all the accounts falls below a user-configured threshold.

Following are the additional details for the insight:

Insight Name LOW_BALANCE_WARNING_ALL_ACCOUNTS
Applicable Entity ACCOUNT
Insight Type AGGREGATE
Trigger Type SCHEDULE
Supported Container BANK

Use Cases

  • Customer:
    • User engagement
  • User:
    • Financial wellness - Keep a track of account balance.

Suggested Action

Suggest the user to move money from another account.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.

Following are the applicable frequencies for this insight:

Frequency Description
DAILY The insight will be triggered daily. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current day from 12:00 AM same day to the time of insight evaluation.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight can be triggered using the following on-demand insight trigger API:

POST   /insights/trigger

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold lets the customer or the user decide when the user has to be alerted about a low balance for each account. If the account balance falls below the BALANCE threshold configured, an insight is generated for the user.

  • Threshold Name: BALANCE
  • Data Type: AMOUNT
  • Range Allowed: 1.00 <= CHANGE <= 1000000.00
  • Default: 200.00

Note: Only USD currency is currently supported. Depending on the customer segment and account, the threshold might need to be different for different users. If the default value is insufficient, the users can set a threshold they are comfortable tracking.

GET Customer Subscription

The GET customer subscription API provides all the information about the defaults set for the insights that are subscribed by the customer. The default frequency for the insight is DAILY.

Method and URL:

GET   /insights/configs/customerSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}
Content-Type application/json
Api-Version 3.0
2.1
2
Cobrand-Name {Name of the Customer}

Sample Request:

GET /insights/configs/customerSubscriptions

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

  • Api-Version 3.0 and 2.1 Response
{
   "customerSubscription":[
      {
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "insightTitle":"Low Balance Warning-All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK"
         ],
         "description":"Generates an insight when the balance across all the accounts falls below the threshold.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":false,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}
  • Api-Version 2 Response
{
   "customerSubscription":[
      {
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "insightTitle":"Low Balance Warning-All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK"
         ],
         "description":"Generates an insight when the balance across all the accounts falls below the threshold.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":false,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

PATCH Customer Subscription

Using the PATCH API for customer subscription, customers can change the defaults for each insight. Alternatively, customers can use the insights configuration tool to achieve the same result.

Warning! Changing any defaults can potentially impact all users who have subscribed to this insight. If the user has overridden the customer threshold, then the user preference will be applied. For all other users, the new defaults will apply.

Method and URL:

PATCH   /insights/configs/customerSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}
Content-Type application/json
Api-Version 3.0
2.1
2
Cobrand-Name {Name of the Customer}

Editable Parameters:

Editable Attributes Impact Allowed Values
isSubscribed Subscribes or unsubscribes all the users from the Low Balance Warning - All Accounts insight. true, false
insightTitle The title returned in the GET feed API as well as the insights config tool can be changed. Alphanumeric characters up to 100 characters (including spaces)
threshold The threshold value (minimum balance) for generating the Low Balance Warning - All Accounts insight can be changed. Any number between 1.00 and 1000000.00

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

Response Messages:

HTTP Status Code Reason
400 Y806: Invalid Input
400 Y800: Invalid value for insightName
400 Y800: Invalid value for insightTitle; special characters ><\""'%{}|^~[] are not supported.
400 Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed.
400 Y800: Invalid value for BALANCE in LOW_BALANCE_WARNING_ALL_ACCOUNTS insight Min = 1.00 and Max = 1000000.00
400 Y813: Invalid request. The entire object within threshold should be provided
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying applicableEntity is not allowed
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying triggerType is not allowed
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying container is not allowed
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying description is not allowed
400 Y800: Invalid value for isSubscribed; Supported values are true, false
400 Y825: Update not allowed without a valid request body
400 Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required.
400 Y802: Specifying frequency attribute for LOW_BALANCE_WARNING_ALL_ACCOUNTS insight is not allowed
400 Y802: Specifying duration attribute for LOW_BALANCE_WARNING_ALL_ACCOUNTS insight is not allowed
400 Y812: Required field/value - insightName missing in the request
400 Y802: Modifying InsightType attribute is not allowed
400 Y813: entityType should be provided
400 Y803: At least one additional attribute is required in addition to entityType.
400 Y800: Invalid value for customerConfiguration; customerConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes.
400 Y800: Invalid value for entityType. Supported entityType for LOW_BALANCE_WARNING_ALL_ACCOUNTS insight are - [ACCOUNT]
400 Y802: For LOW_BALANCE_WARNING_ALL_ACCOUNTS insight, {Invalid String} inside the threshold is either repeated or not allowed
400 Y802: For LOW_BALANCE_WARNING_ALL_ACCOUNTS insight, {Invalid String} inside the threshold is not allowed
400 Y800: Invalid value for input json
401 Y020: Invalid token in authorization header
401 Y020: Token has expired

GET User Subscription

The GET user subscription API provides all the information about the defaults set for the insights that are subscribed by the customer.

Method and URL:

GET   /insights/configs/userSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 3.0
2.1
2
Cobrand-Name {Name of the Customer}

Sample Request:

GET /insights/configs/userSubscriptions?insightName=LOW_BALANCE_WARNING_ALL_ACCOUNTS

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

  • Api-Version 3.0 and 2.1 Response
{
   "userSubscription":[
      {
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "insightTitle":"Low Balance Warning-All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK"
         ],
         "description":"Generates an insight when the balance across all the accounts falls below the threshold.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}
  • Api-Version 2 Response
{
   "userSubscription":[
      {
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "insightTitle":"Low Balance Warning-All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK"
         ],
         "description":"Generates an insight when the balance across all the accounts falls below the threshold.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

PATCH User Subscription

Using the PATCH user subscription API for user subscription, users can change the defaults for each insight. If the user wants the insight to be evaluated for a new account, then add that account using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.

Method and URL:

PATCH   /insights/configs/userSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 3.0
2.1
2
Cobrand-Name {Name of the Customer}

Editable Parameters:

Editable Attributes Impact Allowed Values
isSubscribed Subscribes or unsubscribes from the Low Balance Warning - All Accounts insight. true, false
threshold Overrides the customer default threshold for generating the Low Balance Warning - All Accounts insight. Any number between 1.00 and 1000000.00

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"200.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

Error Messages:

HTTP Status Code Reason
400 Y806: Invalid input
400 Y800: Invalid value for insightName
400 Y800: Invalid value for input param in LOW_BALANCE_WARNING_ALL_ACCOUNTS insight
400 Y800: Invalid value for threshold data in LOW_BALANCE_WARNING_ALL_ACCOUNTS insight
400 Y800: Invalid value for BALANCE in LOW_BALANCE_WARNING_ALL_ACCOUNTS insight Min = 1.00 and Max = 1000000.00
400 Y802: Modifying insightTitle using this API is not allowed
400 Y813: Invalid request. The entire object within threshold should be provided
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying applicableEntity is not allowed
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying triggerType is not allowed
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying container is not allowed
400 Y802: For insight LOW_BALANCE_WARNING_ALL_ACCOUNTS, modifying description is not allowed
400 Y802: Specifying frequency attribute for LOW_BALANCE_WARNING_ALL_ACCOUNTS insight is not allowed
400 Y802: Specifying duration attribute for LOW_BALANCE_WARNING_ALL_ACCOUNTS insight is not allowed
400 Y800: Invalid value for isSubscribed; Supported values are true, false
400 Y825: Update not allowed without a valid request body
400 Y800: Invalid value for userConfiguration; entityId should be provided.
400 Y812: Required field/value - insightName missing in the request
400 Y802: Modifying InsightType attribute is not allowed
400 Y813: entityType should be provided
400 Y802: Duplicate entityId entries is not allowed
400 Y803: At least one additional attribute is required in addition to entityType.
400 Y800: Invalid value for userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes
400 Y800: Invalid value for entityType. Supported entityType for LOW_BALANCE_WARNING_ALL_ACCOUNTS insight are - [ACCOUNT]
400 Y800: Invalid value for input json
401 Y020: Invalid token in authorization header
401 Y020: Token has expired

GET Insight Feeds

The GET insights feed API retrieves all or a subset of the valid insight notifications generated for a particular user. However, using the insightName filter, the Low Balance Warning - All Accounts insight can be specifically requested.

Method and URL:

GET   /insights/feed

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 3.0
2.1
2
Cobrand-Name {Name of the Customer}

Sample Request:

GET /insights/feed?insightName=LOW_BALANCE_WARNING_ALL_ACCOUNTS

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "feed":[
      {
         "id":"625e9d96b9917055383b4445",
         "insightName":"LOW_BALANCE_WARNING_ALL_ACCOUNTS",
         "insightTitle":"Income Exceeded Threshold-All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2022-04-19T11:31:34Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"300000000",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "bankAccount":[
            {
               "id":10384828,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- Account Balance",
               "accountStatus":"ACTIVE",
               "accountType":"SAVINGS",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10384828&amp;status=ACTIVE"
               },
               "availableBalance":{
                  "amount":51999.99,
                  "currency":"USD",
                  "convertedAmount":3537257.72,
                  "convertedCurrency":"INR"
               },
               "currentBalance":{
                  "amount":51999.99,
                  "currency":"USD",
                  "convertedAmount":3537257.72,
                  "convertedCurrency":"INR"
               },
               "balance":{
                  "amount":51999.99,
                  "currency":"USD",
                  "convertedAmount":3537257.72,
                  "convertedCurrency":"INR"
               },
               "lastUpdated":"2022-04-19T08:48:05Z"
            },
            {
               "id":10384829,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
               "accountStatus":"ACTIVE",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10384829&amp;status=ACTIVE"
               },
               "availableBalance":{
                  "amount":18000,
                  "currency":"USD",
                  "convertedAmount":1224435.6,
                  "convertedCurrency":"INR"
               },
               "currentBalance":{
                  "amount":18000,
                  "currency":"USD",
                  "convertedAmount":1224435.6,
                  "convertedCurrency":"INR"
               },
               "balance":{
                  "amount":18000,
                  "currency":"USD",
                  "convertedAmount":1224435.6,
                  "convertedCurrency":"INR"
               },
               "lastUpdated":"2022-04-19T08:48:05Z"
            },
            {
               "id":10384826,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountStatus":"ACTIVE",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10384826&amp;status=ACTIVE"
               },
               "availableBalance":{
                  "amount":180000,
                  "currency":"USD",
                  "convertedAmount":12244356,
                  "convertedCurrency":"INR"
               },
               "currentBalance":{
                  "amount":180000,
                  "currency":"USD",
                  "convertedAmount":12244356,
                  "convertedCurrency":"INR"
               },
               "balance":{
                  "amount":180000,
                  "currency":"USD",
                  "convertedAmount":12244356,
                  "convertedCurrency":"INR"
               },
               "lastUpdated":"2022-04-19T08:48:05Z"
            },
            {
               "id":10384827,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- Account Balance",
               "accountStatus":"ACTIVE",
               "accountType":"SAVINGS",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10384827&amp;status=ACTIVE"
               },
               "availableBalance":{
                  "amount":5,
                  "currency":"USD",
                  "convertedAmount":340.12,
                  "convertedCurrency":"INR"
               },
               "currentBalance":{
                  "amount":5,
                  "currency":"USD",
                  "convertedAmount":340.12,
                  "convertedCurrency":"INR"
               },
               "balance":{
                  "amount":5,
                  "currency":"USD",
                  "convertedAmount":340.12,
                  "convertedCurrency":"INR"
               },
               "lastUpdated":"2022-04-19T08:48:05Z"
            },
            {
               "id":10384825,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data_Sch/Ref",
               "accountStatus":"ACTIVE",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10384825&amp;status=ACTIVE"
               },
               "availableBalance":{
                  "amount":50,
                  "currency":"USD",
                  "convertedAmount":3401.21,
                  "convertedCurrency":"INR"
               },
               "currentBalance":{
                  "amount":50,
                  "currency":"USD",
                  "convertedAmount":3401.21,
                  "convertedCurrency":"INR"
               },
               "balance":{
                  "amount":50,
                  "currency":"USD",
                  "convertedAmount":3401.21,
                  "convertedCurrency":"INR"
               },
               "lastUpdated":"2022-04-19T08:48:05Z"
            }
         ],
         "accountDerived":{
            "totalAvailableBalance":{
               "amount":17009790.65,
               "currency":"INR"
            }
         }
      }
   ]
}