Balance Above Threshold

Overview

The Balance Above Threshold insight is a refresh-triggered insight that alerts the user when the balance of a bank account is above a user-configured threshold.

Following are the additional details for the insight:

Insight Name	BALANCE_ABOVE_THRESHOLD
Applicable Entity	ACCOUNT
Insight Type	OTHER
Trigger Type	REFRESH
Supported Container	BANK

Use Cases

Customer:
- Cross-Sell/Up-Sell opportunity - Prompt users to move money to any of the FI's investment offerings.
User:
- Take prudent financial decisions - Don't let the money sit idle. Move money to opportunities that can grow wealth.

Suggested Action

Recommend the user to move the money to an appropriate investment account.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated once every 16 days (including the date of insight evaluation) for each of the applicable entity ID.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight cannot be triggered on-demand using any of the on-demand trigger mechanisms currently available.

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold lets the customer or the user decide when insight has to be generated to inform the user about the account balance. If the account balance exceeds the configured threshold BALANCE, then the insight will be generated.

Threshold Name: BALANCE
Data Type: AMOUNT
Range Allowed: 1.00 <= BALANCE <= 1000000.00
Default: 50000

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.

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`	`2.1`
`Api-Version`	`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 2.1 Response

{
  "customerSubscription": [
   {
            "insightName": "BALANCE_ABOVE_THRESHOLD",
            "insightTitle": "Balance Above Threshold",
            "insightType": "OTHER",
            "triggerType": "REFRESH",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight when the balance of a bank account is above a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "customerSubscription": [
   {
            "insightName": "BALANCE_ABOVE_THRESHOLD",
            "insightTitle": "Balance Above Threshold",
            "insightType": "OTHER",
            "triggerType": "REFRESH",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight when the balance of a bank account is above a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes all the users from the Balance Above Threshold insight.	true, false
insightTitle	The title returned in the GET feed API as well as the insights configuration tool can be changed.	Alphanumeric characters up to 100 characters (including spaces)
threshold	The threshold (BALANCE) can be modified.	Any number between 1.00 to 1000000.00

Sample Request:

{
    "customerSubscription": [
        {
           "insightName": "BALANCE_ABOVE_THRESHOLD",
           "insightTitle": "Balance Above Threshold",
           "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "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 BALANCE_ABOVE_THRESHOLD insight Min = 1.00 and Max = 1000000.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, modifying applicableEntity is not allowed
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, modifying triggerType is not allowed
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, modifying container is not allowed
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, 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 BALANCE_ABOVE_THRESHOLD insight is not allowed
400	Y802: Specifying duration attribute for BALANCE_ABOVE_THRESHOLD 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 BALANCE_ABOVE_THRESHOLD insight are - [ACCOUNT]
400	Y802: For BALANCE_ABOVE_THRESHOLD insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For BALANCE_ABOVE_THRESHOLD 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 user defaults set for the insight.

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/userSubscriptions?insightName=BALANCE_ABOVE_THRESHOLD

Sample Response:

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

Api-Version 2.1 Response

{
  "userSubscription": [
   {
            "insightName": "BALANCE_ABOVE_THRESHOLD",
            "insightTitle": "Balance Above Threshold",
            "insightType": "OTHER",
            "triggerType": "REFRESH",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight when the balance of a bank account is above a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "userSubscription": [
   {
            "insightName": "BALANCE_ABOVE_THRESHOLD",
            "insightTitle": "Balance Above Threshold",
            "insightType": "OTHER",
            "triggerType": "REFRESH",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight when the balance of a bank account is above a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
entityId	The ID of the account for which account balance gets evaluated.	Valid IDs for accounts belonging to the user
isSubscribed	Subscribes or unsubscribes from the Balance Above Threshold insight.	true, false
threshold	The threshold (BALANCE) can be modified.	Any number between 1.00 to 1000000.00

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"BALANCE_ABOVE_THRESHOLD",
         "userConfiguration":[
            {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "BALANCE",
                            "value": "50000",
                            "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 BALANCE_ABOVE_THRESHOLD insight
400	Y800: Invalid value for threshold data in BALANCE_ABOVE_THRESHOLD insight
400	Y800: Invalid value for BALANCE in BALANCE_ABOVE_THRESHOLD insight Min = 1.00 and Max = 1000000.00
400	Y800: Invalid value for entityId; This id is either invalid or not supported for this insight.
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 BALANCE_ABOVE_THRESHOLD, modifying applicableEntity is not allowed
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, modifying triggerType is not allowed
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, modifying container is not allowed
400	Y802: For insight BALANCE_ABOVE_THRESHOLD, modifying description is not allowed
400	Y802: Duplicate entityId entries within userConfiguration is not allowed
400	Y802: Specifying frequency attribute for BALANCE_ABOVE_THRESHOLD insight is not allowed
400	Y802: Specifying duration attribute for BALANCE_ABOVE_THRESHOLD 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 BALANCE_ABOVE_THRESHOLD 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 Balance Above Threshold 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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=BALANCE_ABOVE_THRESHOLD

Sample Response:

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

{
   "feed":[
      {
         "id":"60d43d99d59fdb46b0c910cd",
         "insightName":"BALANCE_ABOVE_THRESHOLD",
         "insightTitle":"Balance Above Threshold",
         "insightType":"OTHER",
         "triggerType":"REFRESH",
         "createdDate":"2021-06-24T08:08:48Z",
         "subscription":[
            {
               "entityId":"13709568",
               "entityType":"ACCOUNT",
               "threshold":[
                  {
                     "name":"BALANCE",
                     "value":"50000",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "bankAccount":[
            {
               "id":13709568,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountType":"CHECKING",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709568"
               },
               "availableBalance":{
                  "amount":180000.0,
                  "currency":"USD"
               }
            }
         ]
      }
   ]
}