Income Exceeded Threshold
Overview
The Income Exceeded Threshold insight is a schedule-trigger insight that alerts users when the total income tracked as part of a VIEW is above a user-configured threshold.
Following are the additional details for the insight:
Insight Name | INCOME_THRESHOLD |
---|---|
Applicable Entity | VIEW |
Insight Type | OTHER |
Trigger Type | SCHEDULE |
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 enable the money to grow faster.
Suggested Action
Recommend to 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 only once per scheduled frequency for an entity ID.
Following is the applicable frequency 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 dynamic trigger is applicable to the insight. Depending on the configuration, this insight can be invoked dynamically when:
- A new View is created
OR - A View ID is patched using the user subscription API
The insight is generated dynamically using any of the above two methods only if the view is eligible and the other insight generation checks are passed.
Note: By default, the configuration is set to dynamically trigger insight evaluation every time a new entityId (view ID) is added using the PATCH userSubscription API. During onboarding, this preference can be changed.
In addition to the dynamic trigger capability chosen, this 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 the income in an account. If the total income credit amount in the month is above the MINIMUM threshold configured, an insight is generated for the user.
- Threshold Name: MINIMUM
- Data Type: AMOUNT
- Range Allowed: 1.00 <= MINIMUM <= 1000000.00
- Default: 500.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 DAILY
and the default duration for the insight is THIS_MONTH
.
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 |
|
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": "INCOME_THRESHOLD",
"insightTitle": "Income Exceeded Threshold",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"containers": [
"BANK"
],
"description": "Generates an insight when income for the current month is more than a configured threshold.",
"applicableEntity": [
"VIEW"
],
"customerConfiguration": [
{
"entityType": "VIEW",
"isSubscribed": true,
"frequency": "DAILY",
"duration": "THIS_MONTH",
"threshold": [
{
"name": "MINIMUM",
"value": "500.00",
"type": "AMOUNT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "INCOME_THRESHOLD",
"insightTitle": "Income Exceeded Threshold",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"container": [
"BANK"
],
"description": "Generates an insight when income for the current month is more than a configured threshold.",
"applicableEntity": [
"VIEW"
],
"customerConfiguration": [
{
"entityType": "VIEW",
"isSubscribed": true,
"frequency": "DAILY",
"duration": "THIS_MONTH",
"threshold": [
{
"name": "MINIMUM",
"value": "500.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 |
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 Income Exceeded 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 value (minimum amount) for generating the Income Exceeded Threshold insight can be changed. | Any number between 1.00 and 1000000.00 |
Sample Request:
{
"customerSubscription": [
{
"insightName": "INCOME_THRESHOLD",
"insightTitle": "Income Exceeded Threshold",
"customerConfiguration": [
{
"entityType": "VIEW",
"isSubscribed": true,
"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 insightTitle; special characters ><\""'%{}|^~[] are not supported. |
400 | Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed. |
400 | Y802: For insight INCOME_THRESHOLD, modifying frequency is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, modifying duration is not allowed |
400 | Y800: Invalid value for MINIMUM in INCOME_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 INCOME_THRESHOLD, modifying applicableEntity is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, modifying triggerType is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, modifying container is not allowed |
400 | Y802: For insight INCOME_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 | 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 INCOME_THRESHOLD insight are - [VIEW] |
400 | Y802: For INCOME_THRESHOLD insight, {Invalid String} inside the threshold is either repeated or not allowed |
400 | Y802: For INCOME_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 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Sample Request:
GET /insights/configs/userSubscriptions?insightName=INCOME_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": "INCOME_THRESHOLD",
"insightTitle": "Income Exceeded Threshold",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"containers": [
"BANK"
],
"description": "Generates an insight when income for the current month is more than a configured threshold.",
"applicableEntity": [
"VIEW"
],
"userConfiguration": [
{
"entityType": "VIEW",
"entityId": "10255809",
"isSubscribed": true,
"frequency": "DAILY",
"duration": "THIS_MONTH",
"threshold": [
{
"name": "MINIMUM",
"value": "500.00",
"type": "AMOUNT"
}
]
}
],
"customerConfiguration": [
{
"entityType": "VIEW",
"isSubscribed": true,
"frequency": "DAILY",
"duration": "THIS_MONTH",
"threshold": [
{
"name": "MINIMUM",
"value": "500.00",
"type": "AMOUNT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription": [
{
"insightName": "INCOME_THRESHOLD",
"insightTitle": "Income Exceeded Threshold",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"container": [
"BANK"
],
"description": "Generates an insight when income for the current month is more than a configured threshold.",
"applicableEntity": [
"VIEW"
],
"userConfiguration": [
{
"entityType": "VIEW",
"entityId": "10255809",
"isSubscribed": true,
"frequency": "DAILY",
"duration": "THIS_MONTH",
"threshold": [
{
"name": "MINIMUM",
"value": "500.00",
"type": "AMOUNT"
}
]
}
],
"customerConfiguration": [
{
"entityType": "VIEW",
"isSubscribed": true,
"frequency": "DAILY",
"duration": "THIS_MONTH",
"threshold": [
{
"name": "MINIMUM",
"value": "500.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 view, then add that view 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 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Editable Parameters:
Editable Attributes | Impact | Allowed Values |
---|---|---|
entityId | The ID of the view for which income threshold gets evaluated. | Valid IDs for view belonging to the user |
isSubscribed | Subscribes or unsubscribes from the Income Exceeded Threshold insight. | true, false |
threshold | The threshold value (minimum amount) for generating the Income Exceeded Threshold insight can be changed. | Any number between 1.00 and 1000000.00 |
Sample Request:
{
"userSubscription": [
{
"insightName": "INCOME_THRESHOLD",
"userConfiguration": [
{
"entityType": "VIEW",
"entityId": "10255809",
"isSubscribed": true,
"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 INCOME_THRESHOLD insight |
400 | Y802: For insight INCOME_THRESHOLD, modifying frequency is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, modifying duration 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 INCOME_THRESHOLD insight Min =1.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 INCOME_THRESHOLD, modifying applicableEntity is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, modifying triggerType is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, modifying container is not allowed |
400 | Y802: For insight INCOME_THRESHOLD, 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 INCOME_THRESHOLD insight are - [VIEW] |
400 | Y800: Invalid value for threshold data in INCOME_THRESHOLD 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 Income Exceeded Threshold insight.
Calculation Logic for Derived Attributes:
changePercent
= (currentAmount
- previousAmount
)/abs(previousAmount)
*100
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 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Sample Request:
GET /insights/feed?insightName=INCOME_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":"6433c8e790e416200f53c955",
"insightName":"INCOME_THRESHOLD",
"insightTitle":"Income Exceeded Threshold",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"createdDate":"2023-04-10T08:29:27Z",
"subscription":[
{
"entityId":"6433c8a28dc40d47eed85d5f",
"entityType":"VIEW",
"frequency":"DAILY",
"duration":"THIS_MONTH",
"threshold":[
{
"name":"MINIMUM",
"value":"500.00",
"type":"AMOUNT"
}
]
}
],
"basicView":[
{
"id":"6433c8a28dc40d47eed85d5f",
"name":"Default View",
"link":{
"entityName":"view",
"url":"/views/6433c8a28dc40d47eed85d5f"
},
"basicAccount":[
{
"id":16145092,
"providerName":"Dag Site",
"accountName":"PDV Test Data- All Category",
"accountStatus":"ACTIVE",
"accountType":"OTHER",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=16145092&status=ACTIVE"
},
"basicTransaction":[
{
"id":68707842,
"amount":{
"amount":1344.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707842"
},
"categoryId":32,
"category":"Other Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"fSHDSKJJSKLFJ",
"simple":"fSHDSKJJSKLFJ"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707830,
"amount":{
"amount":1344.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707830"
},
"categoryId":27,
"category":"Deposits",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"BKOFAMERICA ATM 06/10 #XXXXX2354 DEPOSIT LUSBY-SOLOMONS B LUSBY MD",
"simple":"Bank of America Deposit"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"Bank of America",
"address":{
"zip":"20657",
"city":"Lusby",
"state":"MD",
"country":"US"
}
}
},
{
"id":68707827,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707827"
},
"categoryId":32,
"category":"Other Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Credit Card Payment",
"simple":"Credit Card Payment"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707811,
"amount":{
"amount":7777.77,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707811"
},
"categoryId":32,
"category":"Other Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"fSHDSKJJSKLFJ",
"simple":"fSHDSKJJSKLFJ"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707802,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707802"
},
"categoryId":225,
"category":"Rewards",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"ATM REDEMPTION TO ACCOUNT - 2/22 MACH ID 0660E 1220 GUADALUPEE ST LAREDO TX FROM REWARDS ID XXXXXXX2002",
"simple":"ATM REDEMPTION TO ACCOUNT - 2/22 MACH ID 0660E 1220 GUADALUPEE ST LAREDO TX FROM REWARDS ID XX2002"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"city":"Laredo",
"country":"US"
}
}
},
{
"id":68707797,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707797"
},
"categoryId":31,
"category":"Retirement Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Retirement Contributions",
"simple":"Retirement Contributions"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707794,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707794"
},
"categoryId":225,
"category":"Rewards",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Cash Rewards",
"simple":"Cash Rewards"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707792,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707792"
},
"categoryId":96,
"category":"Interest",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"interest income",
"simple":"Interest Income"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707790,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707790"
},
"categoryId":225,
"category":"Rewards",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"rewards",
"simple":"rewards"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707788,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707788"
},
"categoryId":96,
"category":"Interest",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"interest",
"simple":"Interest Income"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707768,
"amount":{
"amount":1344.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707768"
},
"categoryId":27,
"category":"Deposits",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Insurance",
"simple":"Insurance"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707757,
"amount":{
"amount":1344.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707757"
},
"categoryId":29,
"category":"Paychecks/Salary",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"PAYROLL",
"simple":"PAYROLL"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
},
{
"id":68707756,
"amount":{
"amount":1344.75,
"currency":"USD"
},
"date":"2023-04-10",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=68707756"
},
"categoryId":31,
"category":"Retirement Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Direct Credit Pension 015XX4 051G3XXXX0354X545K",
"simple":"Direct Credit Pension 015XX4 051G3XX0354X545K"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"address":{
"country":"US"
}
}
}
]
}
],
"basicCategoryTypeDetail":[
{
"categoryType":"INCOME",
"creditTotal":{
"amount":23662.77,
"currency":"USD"
}
}
]
}
]
}
]
}