Yodlee v1.0
This package provides capabilities that extend the Avoka Transact platform for users wishing to include Envestnet Yodlee services in their forms. Package capabilities include:
-
Account Linking
Linking accounts to transactions using Yodlee Fastlink.
-
Account Retrieval
Retrieving details on accounts linked using Yodlee Fastlink.
-
Transaction Summaries
Retrieving user transaction summaries for accounts linked using Yodlee Fastlink.
-
Networth Summaries
Retrieving user networth for accounts linked using Yodlee Fastlink.
Quick Start
The Quick Account Link component is provided to give a one button integration experience, for Yodlee Fastlink. Data required as part of the submission can be configured on the block. The start button provided in the component will also need to be configured see Starting a Fastlink Session.
Configuring Fastlink
Fastlink integration in this package comes in two flavours :
Integrations for each are as simple as dropping their respective components onto the form, and configuring the Start Fastlink Button with their required properties (found under the Configuration category). Once linking is complete relevant account information will automatically be linked to the transaction to be used for other components and services.NOTE : The linking of accounts MUST occur before any other Yodlee services in this package are used
Starting a Fastlink Session
The Start Fastlink Button is provided to initiate a fastlink session. The same button is used for both the Embedded and Dialog implementations. The button is configured by providing field references to the Fastlink component and dialog if necessary.
Displaying results in the form
The following components are provided to surface results to the form user :
See their respective properties for linking data for display.Licensing
Clients must ensure they are appropriately licensed in order to use this package. Organisations who wish to use this package are required to establish a commercial relationship with Envestnet Yodlee directly.
Compatibility
This package has the following compatibility requirements:
| Module | Compatibility | Notes |
|---|---|---|
| Transact Manager | 5.0.0 or above | |
| Transact Maestro | 5.0.0 or above |
Installation Instructions
To install this package please walk through the following procedure:
- Unzip the package to a directory on your computer
- Import each zip archive found in the services folder to Transact Manager under the Services >> All Services menu item.
- Review the Help Doc tab for each of the imported services and make any required adjustments to service parameters.
- Review the Service Connection requirements under the same Help Doc tab for each of the imported services and make any required configurations to the Service Connection. Service Connections can be configured in Transact Manager under the Services >> Service Connections menu item.
- Import each archive found in the libraries folder to Maestro. Importing these into the Organisation level libraries folder is recommended as this will make the components available to all projects, however they can be imported at the Project level if required.
Maestro Assets
Block for displaying summary information for accounts linked to a transaction using Fastlink
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Account Summaries | Data | Data item containing account summary data | fieldRef | |
| Display Accounts | Configuration | Display account details on the form | boolean |
true
|
An iFrame for starting and displaying a Yodlee Fastlink session
Used In
Rule Templates
You may add your own logic to handle the following rule types triggered by this component:
- On Callback : a script to run when the Frame receives a callback request
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Height | Configuration | The height of the iFrame displaying the fastlink session | integer |
500
|
| Fastlink App | Configuration | The Fastlink App to open
Options:
|
option |
AGGREGATION
|
A dialog with pre-defined styles and buttons designed to host the Yodlee Fastlink application
Uses
For retrieving accounts linked to this transaction using Fastlink
Used In
Service Calls
Rule Templates
You may add your own logic to handle the following rule types triggered by this component:
- On Success : a script to run on success of the dynamic data call, the parameter info contains the response
- On Failure : a script to run on failure of the dynamic data call, the parameter info contains the response
A DDS Button for retrieving networth financial data using the Yodlee APIs
Used In
Service Calls
Rule Templates
You may add your own logic to handle the following rule types triggered by this component:
- On Success : a script to run on success of the dynamic data call, the parameter info contains the response
- On Failure : a script to run on failure of the dynamic data call, the parameter info contains the response
A Dynamic Data Service Button for retrieving transaction summaries for accounts linked to this transaction using Yodlee Fastlink
Used In
Service Calls
Rule Templates
You may add your own logic to handle the following rule types triggered by this component:
- On Success : a script to run on success of the dynamic data call, the parameter info contains the response
- On Failure : a script to run on failure of the dynamic data call, the parameter info contains the response
Yodlee Net Worth Summary
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Net Worth Summary Reference | Data | A field reference to the results of a net worth summary dynamic data call | fieldRef | |
| Display Networth Summary | Configuration | Display the networth summary on the form | boolean |
true
|
A single button component for Yodlee Integration to link accounts and retrieve financial data
Uses
- Yodlee Get Account Details
- Yodlee Get Net Worth
- Yodlee Get Transaction Summaries
- Yodlee Start Fastlink
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Include Linked Accounts | Data | Include linked accounts details in submission data | boolean |
true
|
| Include Transaction Summaries | Data | Include transaction summaries in submission dara | boolean |
true
|
| Include Networth | Data | Include networth summary in submission data | boolean |
true
|
| Income | Transactions | Include income in transaction summaries | boolean |
true
|
| Expenses | Transactions | Include Expenses in Transaction Summaries | boolean |
true
|
| Transfers | Transactions | Include Transfers in Transaction Summaries | boolean |
true
|
| Include Past Days | Transactions | Include a past number of days in the summary | integer | |
| Include Past Days | Networth | Include a number of days past in Networth data | integer |
0
|
A button for opening fastlink
Used In
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Dialog Reference | Configuration | Reference to the dialog the fastlink session is contained in | fieldRef | |
| Fastlink Reference | Configuration | The reference to the fastlink component the session will be opened in | fieldRef | |
| User Email Address | Configuration | The users email address for creating a temporary user account for interacting with Yodlee | fieldRef |
Block for displaying transaction summaries
Properties
| Property | Category | Description | Type | Default |
|---|---|---|---|---|
| Transaction Summaries | Data | Field Reference storing summary transaction data | fieldRef | |
| Transaction Category | Data | Category to display summary data for | text |
INCOME
|
| Display Category Summary | Configuration | Display lower level category summaries | boolean |
true
|
| Display Transaction Summaries | Configuration | Display Transaction Summaries on the form | boolean |
true
|
Shared Styles
-
Category Summary Block Library: exchange.yodlee
-
Summary Detail Container Library: exchange.yodlee
Services
Compatibility
| Module | Compatibility |
|---|---|
| Manager | 5.0.0 |
Service Parameters
| Name | Description | Required | Default |
|---|---|---|---|
| responseContentType | The return type of the callback page (Always text/html) | Yes |
text/html
|
| Page Template | The template of the callback page | Yes |
null
|
Service Connection
Compatibility
| Module | Compatibility |
|---|---|
| Manager | 5.0.0 |
Outputs
| Name | Description |
|---|---|
| status | The status of the DDS call |
| accounts | A list[] of {account} objects |
| {account} |
|
| {account}.status | The status of the account |
| {account}.CONTAINER | The type of container this account has e.g. |
| {account}.providerAccountId | The unique id for |
| {account}.accountName | The name of the account |
| {account}.accountNumber | The number of the account |
| {account}.providerId | The id of the account provider, known by Yodlee |
| {account}.providerName | The name of the account provider |
| {account}.id | |
| {account}.refreshInfo | A {refreshInfo} object representing the state of this accounts last refresh |
| {account}.availableBalance | A {balance} object representing the available balance of the |
| {account}.balance | A {balance} object representing the current balance of the account |
| {balance} |
|
| {balance}.amount | The amount of the balance |
| {balance}.currency | The currency of the balance |
| {refreshInfo} |
|
| {refreshInfo}.statusCode | The status code of the refresh |
| {refreshInfo}.statusMessage | The status message of the refresh |
| {refreshInfo}.lastRefreshed | A date time stamp for the last successful |
| {refreshInfo}.lastRefreshAttempt | A date time stamp of the last request for a refresh of this account |
| {refreshInfo}.nextRefreshScheduled | A date time stamp of for the next time this account will be refreshed |
Service Connection
Compatibility
| Module | Compatibility |
|---|---|
| Manager | 5.0.0 |
Inputs
| Name | Description | Required |
|---|---|---|
| accountIds | A comma separated list of accountIds | No |
| include | Set as 'details' to include a list of historical balance with results | No |
| fromDate | The date to retrieve balances from YYYY-MM-DD | No |
| toDate | The date to retrieve balances to YYYY-MM-DD | No |
| interval | The interval to group results to D-Daily, W-Weekly, M-Monthly | No |
| skip | The starting index of the results (skip results before this index) (Min | No |
| top | Exclude results after this index (Max 500) | No |
Outputs
| Name | Description |
|---|---|
| networth | a list of {worth} objects |
| {worth} |
|
| {worth}.date | The date of the summary (YYYY-MM-DD) |
| {worth}.asset | a {balance} object representing assets |
| {worth}.liability | a {balance} object representing liabilities |
| {worth}.networth | a {balance} object representing networth |
| {balance} |
|
| {balance}.amount | The amount of the amount |
| {balance}.currency | The currency of the amount |
Service Connection
Compatibility
| Module | Compatibility |
|---|---|
| Manager | 5.0.0 |
Inputs
| Name | Description | Required |
|---|---|---|
| groupBy | Logical grouping of results - Valid values are CATEGORY_TYPE, CATEGORY or HIGH_LEVEL_CATEGORY | Yes |
| accountId | Account Id to retrieve transaction summaries for | No |
| categoryType | Category types to retrieve transaction summaries for, required if groupBy is CATEGORY or HIGH_LEVEL_CATEGORY is a comma delimited list of types. Valid values are INCOME, EXPENSE, TRANSER, UNCATEGORIZE, DEFERRED_COMPENSATION | No |
| categoryId | Category ids to retrieve transaction summaries for normally used for user defined categories | No |
| fromDate | The start date to retrieve summaries from | No |
| toDate | The end date to retrieve summaries to | No |
| interval | The interval by which results will be grouped, valid values are D-Daily, W-Weekly, M-Monthly | No |
| include | Set as details to include details of the transactions with the summaries | No |
Outputs
| Name | Description |
|---|---|
| status | The status of the DDS call |
| transactionSummaries | A map of transactions summaries organised by category |
| transactionSummaries.INCOME | Contains a list of {transactionSummary} objects (may not be present in response) |
| transactionSummaries.EXPENSE | Contains a list of {transactionSummary} objects (may not be present in response) |
| transactionSummaries.TRANSFER | Contains a list of {transactionSummary} objects (may not be present in response) |
| transactionSummaries.UNCATEGORIZE | Contains a list of {transactionSummary} objects (may not be present in response) |
| transactionSummaries.DEFERRED_COMPENSATION | Contains a list of {transactionSummary} objects (may not be present in response) |
| {transactionSummary} |
|
| {transactionSummary}.creditTotal | A {balance} containing details of the credit of the category |
| {transactionSummary}.debitTotal | A {balance} containing details of the debit of the category |
| {transactionSummary}.links | A link object containing a URI reference to transaction details resource |
| {transactionSummary}.categorySummary | A list of {categorySummary} for this transaction category |
| {categorySummary} |
|
| {categorySummary}.categoryId | The id of the category |
| {categorySummary}.categoryName | The name of the category |
| {categorySummary}.debitTotal | A {balance} containing details of the debit of this category |
| {categorySummary}.creditTotal | A {balance} containing details of the credit of this category |
| {balance} |
|
| {balance}.amount | The amount of the balance |
| {balance}.currency | The currency of the balance |
Service Connection
Compatibility
| Module | Compatibility |
|---|---|
| Manager | 5.0.0 |
Service Parameters
| Name | Description | Required | Default |
|---|---|---|---|
| Fastlink API Connection Endpoint | The URL of your fastlink connection node | Yes |
https://node.developer.yodlee.com/authenticate/restserver/
|
Inputs
| Name | Description | Required |
|---|---|---|
| The email of the user | No | |
| mode | The mode to launch Fastlink in - AGGREGATION or VERIFICATION | No |
Service Connections
The following service connections are used by this package.
| Property Name | Description | Required |
|---|---|---|
| Type | HTTP Endpoint | Yes |
| Endpoint | Should point to Yodlee APIs | Yes |
| Username | Should contain your cobrand login username for the Yodlee APIs | Yes |
| Password | Should contain your cobrand login password for the Yodlee APIs | Yes |