Categorize Transactions
Overview
The Categorize Transactions insight is a schedule-trigger insight that reminds users to categorize all the uncategorized transactions across all the aggregated bank and card accounts.
Following are the additional details for the insight:
| Insight Name | CATEGORIZE_TRANSACTIONS |
|---|---|
| Applicable Entity | ACCOUNT |
| Insight Type | AGGREGATE |
| Trigger Type | SCHEDULE |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- Cleaner user data - Build a better financial picture of the user
- User:
- Better user experience
Suggested Action
Provide the user an option to edit the transaction and update the category using the following Yodlee API v1.1:
PUT /transactions/{transactionId}
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated once per scheduled frequency for a user.
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:
|
|
| 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:
|
|
Insight Dynamic Trigger (On-Demand Evaluation)
The insight can be triggered using the following on-demand insight trigger API:
Method and URL:
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 uncategorized transactions.
- Threshold Name: BASETYPE
- Data Type: STRING
- Range Allowed:
- CREDIT, DEBIT
- CREDIT
- DEBIT
- Default: CREDIT, DEBIT
Note: 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 MONTHLY and the default duration for the insight is THREE_MONTHS.
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}, 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/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": "CATEGORIZE_TRANSACTIONS",
"insightTitle": "Categorize Transactions",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight to alert user that there are uncategorized transactions. If they wish, they can re-categorize those transactions.",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "CATEGORIZE_TRANSACTIONS",
"insightTitle": "Categorize Transactions",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight to alert user that there are uncategorized transactions. If they wish, they can re-categorize those transactions.",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
]
}
]
}
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 Categorize Transactions 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) |
| frequency | The frequency with which an insight will be evaluated. |
|
| duration | The data range that should be considered for evaluating the insight. |
|
| threshold | The threshold (BASETYPE) can be modified. |
|
Sample Request:
{
"customerSubscription":[
{
"insightName": "CATEGORIZE_TRANSACTIONS",
"insightTitle": "Categorize Transactions",
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
]
}
]
}
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 | Invalid value for BASETYPE; Only CREDIT, DEBIT are supported |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying triggerType is not allowed |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying container is not allowed |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, 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 | Y800: Invalid value for frequency; Supported values are MONTHLY, WEEKLY |
| 400 | Y800: Invalid value for duration; Supported values are THIS_MONTH, LAST_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR |
| 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 CATEGORIZE_TRANSACTIONS insight are - [ACCOUNT] |
| 400 | Y802: For CATEGORIZE_TRANSACTIONS insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For CATEGORIZE_TRANSACTIONS 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.
The entityId filter does not apply to this 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:
GET /insights/configs/userSubscriptions?insightName=CATEGORIZE_TRANSACTIONS
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": "CATEGORIZE_TRANSACTIONS",
"insightTitle": "Categorize Transactions",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight to alert user that there are uncategorized transactions. If they wish, they can re-categorize those transactions.",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName": "CATEGORIZE_TRANSACTIONS",
"insightTitle": "Categorize Transactions",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight to alert user that there are uncategorized transactions. If they wish, they can re-categorize those transactions.",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
]
}
]
}
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 Categorize Transactions insight. | true, false |
| frequency | The frequency with which an insight will be evaluated. |
|
| duration | The data range that should be considered for evaluating the insight. |
|
| threshold | The threshold (BASETYPE) can be modified. |
|
Sample Request:
{
"userSubscription":[
{
"insightName":"CATEGORIZE_TRANSACTIONS",
"userConfiguration":[
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"duration": "THREE_MONTHS",
"threshold": [
{
"name": "BASETYPE",
"value": "CREDIT,DEBIT",
"type": "STRING"
}
]
}
]
}
]
}
Response Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in CATEGORIZE_TRANSACTIONS insight |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y800: Invalid value for threshold data in CATEGORIZE_TRANSACTIONS insight |
| 400 | Invalid value for BASETYPE; Only CREDIT, DEBIT are supported |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying triggerType is not allowed |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying container is not allowed |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, modifying description is not allowed |
| 400 | Y800: Invalid value for frequency; Supported values are MONTHLY, WEEKLY |
| 400 | Y800: Invalid value for duration; Supported values are THIS_MONTH, LAST_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y800: Invalid value for isSubscribed; Supported values are true, false |
| 400 | Y825: Update not allowed without a valid request body |
| 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 userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes |
| 400 | Y802: For insight CATEGORIZE_TRANSACTIONS, configurations at an entityId level are not allowed |
| 400 | Y800: Invalid value for entityType. Supported entityType for CATEGORIZE_TRANSACTIONS 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 Categorize Transactions insight can be specifically requested.
The entityId filter does not apply to this 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=CATEGORIZE_TRANSACTIONS
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60d43dbed59fdb46b0c91207",
"insightName":"CATEGORIZE_TRANSACTIONS",
"insightTitle":"Categorize Transactions",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-24T08:09:31Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"MONTHLY",
"duration":"THREE_MONTHS",
"threshold":[
{
"name":"BASETYPE",
"value":"CREDIT,DEBIT",
"type":"STRING"
}
]
}
],
"basicAccount":[
{
"id":13709572,
"providerName":"Dag Site",
"accountName":"PDV Test Data- All Category",
"accountType":"OTHER",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709572"
},
"basicTransaction":[
{
"id":47307072,
"amount":{
"amount":13080.75,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307072"
},
"categoryId":19,
"category":"Other Expenses",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"fdsjhkjfdd",
"simple":"fdsjhkjfdd"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
},
{
"id":47307071,
"amount":{
"amount":1344.75,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307071"
},
"categoryId":32,
"category":"Other Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"fSHDSKJJSKLFJ",
"simple":"fSHDSKJJSKLFJ"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
},
{
"id":47307070,
"amount":{
"amount":9999.99,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307070"
},
"categoryId":19,
"category":"Other Expenses",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"Uncategorized",
"simple":"Uncategorized"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
},
{
"id":47307056,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307056"
},
"categoryId":32,
"category":"Other Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Credit Card Payment",
"simple":"Credit Card Payment"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
},
{
"id":47307040,
"amount":{
"amount":7777.77,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307040"
},
"categoryId":32,
"category":"Other Income",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"fSHDSKJJSKLFJ",
"simple":"fSHDSKJJSKLFJ"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
},
{
"id":47307039,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307039"
},
"categoryId":19,
"category":"Other Expenses",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"Personal",
"simple":"Personal"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
},
{
"id":47307038,
"amount":{
"amount":9999.99,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47307038"
},
"categoryId":19,
"category":"Other Expenses",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"fdsjhkjfdd",
"simple":"fdsjhkjfdd"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
}
]
}
]
}
]
}