Overview
Data extract procedures allow fetching the consumer’s latest financial data from the Yodlee financial cloud when Yodlee refreshes the consumer’s accounts. The latest data can be fetched using getRefreshedUserItems API in tandem with the DataService and TransactionSearchService APIs.
Customers who store a consumer’s data like account details and transactions in their local databases (i.e., instead using Yodlee API in real time) should use data extract procedures. This will enable customers to keep their local databases in sync with the latest data present in the Yodlee financial cloud.
Synchronized Data Extract Implementation
Customers will have to call the getRefreshedUserItems API every minute to get the latest refreshed items from Yodlee, and then call the DataService and TransactionSearchService APIs to fetch the most recent account details and transactions respectively. The procedure is designed to run throughout the day, providing customers with the capability to keep their local data store in sync with Yodlee.
Note: Customers using their local databases to store the consumer’s account data and transactions should build their own logic for account and transaction matching or reconciliation.
Benefits of Synchronized Data Extract Implementation
The benefits of synchronized data extraction are:
- Integration via Web service.
- Allows customers to keep their databases in sync with Yodlee database.
- No file delivery system is required to keep data updated in customers’ databases.
Steps for Synchronized Data Extraction
To use synchronized data extraction, perform the following steps:
- Check if the cobrand session is valid, if not, create a cobrand session.
- Call the Refresh API (getRefreshedUserItems) in loop every minute.
- Get the consumer’s username and items from the response where errorCode=0 (i.e., success).
- Log in on behalf of the consumer and create a user session with Yodlee.
- Call the DataService API (getItemSummaryForItem1) to retrieve account level information.
- Call the TransactionSearchService API (executeUserSearchRequest) to retrieve transactions.
- Repeat steps 4 to 6 for each item.
- Start with step 1 to 7.
Best Practices
Here are some best practices to be followed for synchronized data extracts implementations:
- Set the duration to one minute in the getRefreshedUserItems API call.
- In the getItemSummaryForItem1 API, pass data extent level 0 to get account level data. For an investment account, pass data extents 0 and 2 to get account and holding level details.
- Retrieve the previous seven days of transactions from the last successful synchronization, using the executeUserSearchRequest API. If needed, up to fourteen days of transaction data can be retrieved.
- To optimize data transfers, use gzip compression for all the API calls.
- For items that have failed to refresh, the procedure will automatically pick up the next refresh attempt scheduled by Yodlee. In the meantime, customers can use the error code received from the getRefreshedUserItems API response to display the appropriate status message to consumers.
Example
