Insufficient Balance to Cover Upcoming Bills and Subscriptions

Overview

The Insufficient Balance to Cover Upcoming Bills and Subscriptions insight is a schedule-trigger insight that looks ahead for a specific duration for an account and informs the users when they might not have enough funds to cover the upcoming bills and subscription payments.

The insight will generate only if the projected balance available is below the threshold and there are projected bills and subscriptions for the evaluated duration.

The Predicted Cash Flow feature has to be enabled as a pre-requisite for this insight.

Following are the additional details for the insight:

Insight Name	PROJECTED_INSUFFICIENT_BALANCE
Applicable Entity	ACCOUNT
Insight Type	OTHER
Trigger Type	SCHEDULE
Supported Container	BANK

Use Cases

Customer:
- User engagement
- Cross-Sell / Up-Sell opportunity - Prompt users for shot-term loan or other relevant products to cover up the shortfall.
User:
- Financial wellness - Avoid late payment fees.

Suggested Action

Offer relevant products or suggest transfering funds from another account to meet the payment needs.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for an entity ID.

The following are the applicable frequencies for this insight:

Frequency	Description
WEEKLY	The insight will be triggered once every Monday. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar week (Monday to Sunday). For example: Normal scenario: If the calendar week starts from 1st January to 7th January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar week starts from 1st January to 7th January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
MONTHLY	The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month). For example: Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

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 projected balance. If the projected balance is below the MINIMUM threshold configured, an insight is generated for the user.

Threshold Name: MINIMUM
Data Type: AMOUNT
Range Allowed: 0.00 <= MINIMUM <= 1000000.00
Default: 10.00

Note: Only USD currency is currently supported. Depending on the customer segment and account, 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 WEEKLY.

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": "PROJECTED_INSUFFICIENT_BALANCE",
            "insightTitle": "Insufficient Balance To Cover Upcoming Bills And Subscriptions",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight when an account is projected to have a balance insufficient to cover upcoming bills and subscriptions.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "10",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
    {
            "insightName": "PROJECTED_INSUFFICIENT_BALANCE",
            "insightTitle": "Insufficient Balance To Cover Upcoming Bills And Subscriptions",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight when an account is projected to have a balance insufficient to cover upcoming bills and subscriptions.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "10",
                            "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 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)
frequency	The frequency at which an insight will be evaluated.	WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning)
threshold	The threshold value (minimum amount) for generating the insight can be changed.	Any number between 0.00 and 1000000.00

Sample Request:

{
    "customerSubscription": [
     {
            "insightName": "PROJECTED_INSUFFICIENT_BALANCE",
            "insightTitle": "Insufficient Balance To Cover Upcoming Bills And Subscriptions",
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "100.00",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ]
        }
    ]
}

Error 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 frequency Supported values are WEEKLY, MONTHLY
400	Y802: Specifying duration attribute for PROJECTED_INSUFFICIENT_BALANCE insight is not allowed
400	Y800: Invalid value for MINIMUM in PROJECTED_INSUFFICIENT_BALANCE insight Min =0.00 and Max = 1000000.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying applicableEntity is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying triggerType is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying container is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, 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	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 PROJECTED_INSUFFICIENT_BALANCE insight are - [ACCOUNT]
400	Y802: For PROJECTED_INSUFFICIENT_BALANCE insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For PROJECTED_INSUFFICIENT_BALANCE 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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

/insights/configs/userSubscriptions?insightName=PROJECTED_INSUFFICIENT_BALANCE

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": "PROJECTED_INSUFFICIENT_BALANCE",
            "insightTitle": "Insufficient Balance To Cover Upcoming Bills And Subscriptions",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight when an account is projected to have a balance insufficient to cover upcoming bills and subscriptions.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "10",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "10",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "userSubscription": [
   {
            "insightName": "PROJECTED_INSUFFICIENT_BALANCE",
            "insightTitle": "Insufficient Balance To Cover Upcoming Bills And Subscriptions",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight when an account is projected to have a balance insufficient to cover upcoming bills and subscriptions.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "10",
                            "type": "AMOUNT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "10",
                            "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
entityId	The ID of the account for which account gets evaluated.	Valid IDs for accounts belonging to the user
isSubscribed	Subscribes or unsubscribes from the insight.	true, false
frequency	The frequency at which an insight will be evaluated.	WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning)
threshold	The threshold value (minimum amount) for generating the insight can be changed.	Any number between 0.00 and 1000000.00

Sample Request:

{
    "userSubscription": [
        {
            "insightName": "PROJECTED_INSUFFICIENT_BALANCE",
            "userConfiguration": [
               {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "frequency": "WEEKLY",
                    "threshold": [
                        {
                            "name": "MINIMUM",
                            "value": "500.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 PROJECTED_INSUFFICIENT_BALANCE insight
400	Y800: Invalid value for frequency; Supported values are WEEKLY, MONTHLY
400	Y802: Specifying duration attribute for PROJECTED_INSUFFICIENT_BALANCE insight is not allowed
400	Y800: Invalid value for entityId; This id is either invalid or not supported for this insight.
400	Y800: Invalid value for MINIMUM in PROJECTED_INSUFFICIENT_BALANCE insight Min =0.00 and Max = 1000000.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: Modifying insightTitle using this API is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying applicableEntity is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying triggerType is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying container is not allowed
400	Y802: For insight PROJECTED_INSUFFICIENT_BALANCE, modifying description is not allowed
400	Y802: Duplicate entityId entries within userConfiguration 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 PROJECTED_INSUFFICIENT_BALANCE insight are - [ACCOUNT]
400	Y800: Invalid value for threshold data in PROJECTED_INSUFFICIENT_BALANCE insight
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, you can specifically request for the insight.

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=PROJECTED_INSUFFICIENT_BALANCE

Sample Response:

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

{
   "feed":[
      {
         "id":"60d442bdd59fdb46b0c91771",
         "insightName":"PROJECTED_INSUFFICIENT_BALANCE",
         "insightTitle":"Insufficient Balance To Cover Upcoming Bills And Subscriptions",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-24T08:30:53Z",
         "subscription":[
            {
               "entityId":"13709585",
               "entityType":"ACCOUNT",
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"10.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "bankAccount":[
            {
               "id":13709585,
               "providerName":"Dag Site",
               "accountName":"Projected Low Balance negative",
               "accountType":"SAVINGS",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709585"
               },
               "availableBalance":{
                  "amount":5.0,
                  "currency":"USD"
               },
               "currentBalance":{
                  "amount":5.0,
                  "currency":"USD"
               },
               "balance":{
                  "amount":5.0,
                  "currency":"USD"
               },
               "lastUpdated":"2021-06-24T08:28:39Z",
               "predictedInfo":{
                  "date":"2021-06-26",
                  "predictedBalance":{
                     "amount":-2495.0,
                     "currency":"USD"
                  }
               },
               "basicTransaction":[
                  {
                     "id":19505021,
                     "amount":{
                        "amount":1500.0,
                        "currency":"USD"
                     },
                     "date":"2021-06-26",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=19505021"
                     },
                     "categoryId":39,
                     "category":"Utilities",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "simple":"Duke Bill Energy",
                        "consumer":"Duke Bill Energy"
                     },
                     "sourceType":"SYSTEM_PREDICTED",
                     "merchantType":"BILLERS",
                     "basicMerchant":{
                        "name":"Duke Energy"
                     }
                  },
                  {
                     "id":19505000,
                     "amount":{
                        "amount":1000.0,
                        "currency":"USD"
                     },
                     "date":"2021-06-26",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=19505000"
                     },
                     "categoryId":7,
                     "category":"Entertainment",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "simple":"Netflix subscription",
                        "consumer":"Netflix subscription"
                     },
                     "sourceType":"SYSTEM_PREDICTED",
                     "merchantType":"SUBSCRIPTION",
                     "basicMerchant":{
                        "name":"Netflix"
                     }
                  }
               ]
            }
         ]
      }
   ]
}