Yodlee APIs – New Features/Enhancements
Get Transaction Categorization Rules Service Enhancements
In the GET transaction categorization rule API, a new field parentCategoryId has been introduced that will help locate the parent category ID information for the transactionCategorisationId.
| Impacted API URL: |
GET /transactions/categories/rules |
Important Bug Fix - Get Transaction Categorization Rules Service
Existing functionality: In the GET transaction categorization rules service, the existing attribute transactionCategorisationId provides the parent category ID even if the rule is created for a user category.
Change done: If the rule is created for a user category, the transactionCategorisationId attribute will return the user category ID.
| Impacted API URL: |
GET /transactions/categories/rules |
Financial Wellness – New Features/Enhancements
Utilized Categories API Enhancement
The GET utilized categories API retrieves the list of utilized transaction categories for a user for the last one year. An existing filter in API has been renamed from groupBy to categoryFamily while retaining the functionality.
| Impacted API URL: |
GET /transactions/utilizedCategories |
Utilized Merchants API Enhancement
The GET utilized merchant API that retrieves the list of utilized merchants for a user for the last one year has been enhanced to return the associated categories for each of the merchant.
| Impacted API URL: |
GET /transactions/utilizedMerchants |
Financial Insights – New Features/Enhancements
Configure Customer Preferences for Insights
For each insight, the customer can use the API to set preferences such as change the insight title, subscription for each insight, and all applicable thresholds. The preferences set by the customer for each insight impact all the users subscribed to that insight. These preferences are inherited by the users for whom the specific insight is enabled.
| API URL: |
PATCH /insights/configs/customerSubscriptions |
Configure User Preferences for Insights
The customer can enable their users to set preferences for each insight using the API. The preferences set by the user using this API impacts only the specific user. If a preference is set by the user, the user preference overrides the customer preferences while generating an insight. For example, For LOW_BALANCE_WARNING insight, the customer might set the minimum balance for insight generation at $1,000. However, the user can override this and configure his/her personal threshold as $500. The user also has the ability to specify preferences at an entity ID level i.e., account or view specific. Account ID 1 can have preference set A while Account ID 2 can have preference set B.
Only the insights enabled by the customer will be available to the user.
| API URL: |
PATCH /insights/configs/userSubscriptions |
Fetch Insights Generated for a Customer
The API retrieves all the user subscribed insights for a specified duration. Currently, insights generated up to a year ago can be retrieved using this API. By default, the API returns details of all the insights that the customer has subscribed to. However, if the user has unsubscribed to a particular insight, then that insight will not be returned in the API response.
| API URL: |
GET /insights/configs/customerSubscriptions |
Fetch Insights Generated for a User
The API retrieves all customer subscribed insights for a specified duration. Currently, insights generated up to a year ago can be retrieved using this API.
| API URL: |
GET /insights/configs/userSubscriptions |
UI-based Configuration Tool for Customers
Instead of using the API, the customer can use the Insights Configuration tool UI to set preferences for each insight. The underlying API remains the same.
Create, Update, Delete, and Read a View
A view is a logical collection of transactions based on rules - any combination of accounts, categories, merchants, locations, transaction types, and more, that are of interest to consumers. The views APIs provide an ability to create, get, delete, or update a view.
API URLs:
POST /view
GET /view
PUT /views/{viewId}
DELETE /views/{viewId}
Fetch View Recommendations Based on User Transactions
To make it easier for users to start using views, the GET recommended views API recommends views for the user. The recommendation service looks at the transactions for a user for the last 90 days. Based on the transactions, one or more views can be recommended for a user. If there is not enough data or the user’s transactions does not match any views for recommendation, the API might return an empty response.
| API URL: |
GET /views/recommendations |
Fetch Transactions for a View
Since views are made up of rules, each view will have a dynamic list of transactions associated with it. The GET views transactions API returns all the transactions associated with the view based on the rules, for the specified duration. By default, the last 30 days of data is returned.
| API URL: |
GET /views/{viewId}/transactions |
Fetch Transaction Summary for a View
Since views are made up of rules, each view will have a dynamic list of transactions associated with it. The GET views transaction summary API summarizes the information and returns data such as credit total, debit total, and net total grouped by merchant, category, or category type depending on the parameter value provided. By default, data for the last 30 days is returned.
| API URL: |
GET /views/{viewId}/transactionSummary |
Fetch Peer Data for a View
The GET views with peer benchmarking API returns the peer benchmarking data associated with merchants or category IDs explicitly mentioned as part of the view rule. The peer benchmarking attributes are returned only when the peer benchmarking feature is enabled for the customer.
| API URL: |
GET /views/{viewId}/peerData |