Yodlee v1.2

This Exchange package provides the capability to verify and retrieve a bank account details through Yodlee services.

In order to perform funding through an external account, it is recommended to verify the account details with the applicant's details.

Yodlee services offer 2 ways to perform account verification.

  1. Link accounts through Yodlee using the FastLink UI (immediate verification).
  2. Perform a challenge deposit (3-5 working days verification).

The first option is to open an iframe with the FastLink UI. This option will allow the applicants to log in to their bank account through Yodlee. In this case, Yodlee can verify the account immediately.

However, there are some applicants who might resist entering their bank details through the application. For these applicants, Yodlee are offering the Challenge deposit account option.

In this case, the applicant will provide the bank account details they wish to use for funding, and Yodlee will perform 2 deposits and 1 credit into those accounts.

Once the transactions have been completed, the applicants will be required to provide the exact amount for each deposit and credit that was done through Yodlee to their Bank account.

Upon a successful verification of the deposit and credit amounts, Yodlee will confirm that the account is verified and the request for funding through the account can be initiated.

Note: In the latest Fastlink version 3.0, Yodlee can configure FastLink to allow the applicants to perform challenge deposits. This option is not is not supported within this package. From an onboarding perspective, we recommend not using this feature as it makes the onboarding process longer.

Process Flow

Below are the process flow diagrams for Yodlee services. This gives an insight into the design of the Exchange components.

Yodlee verification - Fastlink

Yodlee verification - Challenge Deposit

Yodlee Delete User

Note: The generated Yodlee user must be deleted after the verification, using the Yodlee delete user service.

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, or purchase a license from Avoka in a reseller capacity, as applicable.

Compatibility

This package has the following compatibility requirements:

ModuleCompatibilityNotes
Transact Manager17.10.5 or above
Transact Maestro18.05.5 or above
Narrator Componentlatest with support of form actions

Installation Instructions

This package should be installed as a single archive via the Avoka Exchange. Once installed you should walk through the following procedure to ensure you complete any required configuration:

  1. Review the documentation below for each of the imported services and make any adjustments necessary to service parameters.
  2. Review the documentation below for any Service Connections and add your credentials as required.
  3. Review the Help Doc tab for each of the imported services and make any required adjustments to service parameters.
  4. 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.
  5. Installation of any included Maestro libraries requires you to login to you Maestro server and import them either into your organization (for global availability) or to your specific project.

Configure Yodlee API version


If you choose to use Yodlee API ver 1.0 with Fastlink ver 2.0 follow the below steps:
  • For each of the services change the service parameter apiVersion to version 1.0.
  • For the service Yodlee - Get User Session change the service parameter appId to 10003620.

If you choose to use Yodlee API ver 1.1 with Fastlink ver 3.0 follow the below steps:
  • For each of the services change the service parameter apiVersion to version 1.1.
  • For the service Yodlee - Get User Session change the service parameter appId to 10003600.

Note: This package is configured by default to use Yodlee API ver 1.1 with Fastlink ver 3.0.

Configure Yodlee - Challenge Deposit

Note: Yodlee Challenge Deposit contains Fluent Functions that run from Transact Manager(Server side) and should be triggered using the Narrator.

Use the following procedure to configure Yodlee Challenge Deposit:

  • From Transact Manager menu go to Forms and search for your form.
  • Open the form version you are working on.
  • Tick the checkbox called Unified App Data.
  • Press the button Edit Form Data Config and set the field Contact Email XPath to the XPath of the user email address field. This email address will be used for creating the user in Yodlee. Another option would be to pass the emailAddress as a parameter to the Fluent Functions.
  • Use the Narrator to trigger the Fluent Function Yodlee - Init CDV and make sure you pass the required parameters:
    • accountNumber
    • routingNumber
    • accountType
    • accountName
    • emailAddress (Optional - you can use instead the Contact Email XPath field)
  • After the user comes back to the form and fills the challenge deposit amounts, trigger the Fluent Function Yodlee - Verify CDV make sure to pass the required parameters:
    • creditOne
    • creditTwo
    • debit
    • emailAddress (Optional - you can use instead the Contact Email XPath field)
  • Note: You can use the component Yodlee Challenge Deposits to input the user challenge deposit amounts.

Yodlee Challenge Deposit - Form XML result

The table bellow describes Yodlee Challenge Deposit - Form XML/ Server VO fields stored in the Form XML Data.

.
NameDescriptionFormatNotes
YodleeCDV.ProviderAccountIdThe provider account idString
YodleeCDV.AccountIdThe account idString
YodleeCDV.VerificationStatusThe verification statusString

Possible options:
INITIALIZED - The verification process is in initialized stage
VERIFIED - The verification is successful
NOT_VERIFIED - The verification has failed
VERIFICATION_AMOUNTS_NOT_SENT - Yodlee hasn't deposit the amounts
FAILED_MAX_ATTEMPTS - The user has reached the max attempts

Milestone and segments events

Milestone events are automatically generated to show milestones on the User Journey view in Transact Insights, the Transact platform analytics tool.

Yodlee FastLink

TypeNameTrigger
MilestoneYodlee Fastlink startWhen loading the Yodlee iframe.
Yodlee Fastlink status segmentCan't startThe initial status.
Yodlee Fastlink status segmentStartedupon successful handshake with Yodlee.
MilestoneYodlee Fastlink completedUpon retrieving and storing the accounts in TM.
Yodlee Fastlink status segmentSuccessUpon retrieving and storing the accounts in TM.

Yodlee Challenge Deposit

TypeNameTrigger
MilestoneYodlee CDV InitializedWhen challenge deposit was initialized.
MilestoneYodlee CDV VerifiedWhen challenge deposit was verified.
MilestoneYodlee CDV Not verifiedWhen challenge deposit verification has failed.
MilestoneYodlee CDV Verification amounts not sentYodlee hasn't deposit the amounts.

Release Notes

Version 1.2 Nov 13, 2019

  • Use Narrator form action.
  • Add execution status, error code and error message to server and client VO's.

Version 1.1 Feb 1, 2019

  • Upgrade to support the latest Yodlee FastLink version 3.0 with the latest API’s.

Version 1.0 Jan 16, 2019

  • Baseline release.

Maestro Assets

Dynamic iFrame Library: exchange-yodlee-ach-verification Category: Frames

iFrame which can support a static id and a load event.

Used In

Rule Templates

You may add your own logic to handle the following rule types triggered by this component:

  • load : A script to run when the iFrame loads

Properties

Property Category Description Type Default
Width Configuration

Sets the iFrame width attribute

text
Height Configuration

Sets the iFrame height attribute

text
Yodlee Account Selector Library: exchange-yodlee-ach-verification Category: Yodlee Account Verification

This component allows the user to select account from a list of accounts returned from a successful Yodlee Fastlink verification.

Properties

Property Category Description Type Default
Account Number Path Yodlee Account Selector

Reference to account number field.

fieldRef
Account Type Path Yodlee Account Selector

Reference to account type field.

fieldRef
Routing Number Path Yodlee Account Selector

Reference to routing number field.

fieldRef
Yodlee Challenge Deposits Library: exchange-yodlee-ach-verification Category: Yodlee Account Verification

This component contains the user challenge deposit amounts two credits and one debit for performing the verification.

Account Verification Library: exchange-yodlee-ach-verification Category: Yodlee Account Verification

This component loads the Yodlee Fastlink Iframe.

Uses

Rule Templates

You may add your own logic to handle the following rule types triggered by this component:

  • On Failure : On Failure
  • On Success : On Success

Properties

Property Category Description Type Default
yodleeAccountVerificationServiceName Configuration

Account verification service name

text Yodlee - Get User Session
yodleeAccountVerificationServiceVersion Configuration

Account verification service version

text 1.2.0
Yodlee Fastlink Loading Message Configuration

text Loading ...
Yodlee Get Account Loading Message Configuration

text
yodleeGetAccountsServiceName Configuration

Get accounts service name

text Yodlee - Get Accounts
Yodlee Show Dialog Library: exchange-yodlee-ach-verification Category: Yodlee Account Verification

This component allows you to display a dialog screen. This dialog should contain the Account Verification component.

Properties

Property Category Description Type Default
Yodlee Account Verification Dialog ID Configuration

Reference of the modal which will be displayed when the login button is clicked

text

Services

Yodlee - Verify CDV v1.2.0
Fluent Function service for preforming the Yodlee challenge deposits verification.

Service Connection

Compatibility

Module Compatibility
Manager 17.10.5

Service Parameters

Name Description Required Default
apiVersion Yodlee API version Yes 1.1
coBrandName This name is provided by Yodlee during the sign-up process Yes avokabase
resultsXpath The Xpath to store the CDV result Yes /Root/YodleeCDV
challengeDepositsXpath The Xpath to store the client side challenge deposit Yes /Root/AvokaSmartForm/YodleeChallengeDeposit

Inputs

Name Description Required
emailAddress The user email address. This is field is required if you haven't set the Contact Email XPath on the Form Data Config. No
creditOne The frist credit amount. Yes
creditTwo The second credit amount. Yes
debit The debit amount. Yes

Outputs

Name Description
data.verificationStatus The status of the CDV Verification [ VERIFIED | NOT_VERIFIED | VERIFICATION_AMOUNTS_NOT_SENT | FAILED_MAX_ATTEMPTS ]
data.executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.

data.errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.
data.errorCode When a DATA_ERROR is experienced, this value provides the error code.
Yodlee - Init CDV v1.2.0
Fluent Function service for initialize Yodlee challenge deposits verification.

Service Connection

Compatibility

Module Compatibility
Manager 17.10.5

Service Parameters

Name Description Required Default
apiVersion Yodlee API version Yes 1.1
coBrandName This name is provided by Yodlee during the sign-up process Yes avokabase
resultsXpath The Xpath to store the CDV result Yes /Root/YodleeCDV

Inputs

Name Description Required
emailAddress The user email address. This is field is required if you haven't set the Contact Email XPath on the Form Data Config. No
accountNumber The account number. Yes
routingNumber The routing number. Yes
accountType The account type (SAVING, CHECKING). Yes
accountName The account name. Yes

Outputs

Name Description
data.CDVInitialization is the challenge deposit initialized. [ true | false ]
data.executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.

data.errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.
data.errorCode When a DATA_ERROR is experienced, this value provides the error code.
Yodlee - DeleteUser v1.2.0
The delete user service is used to delete or unregister a user from Yodlee. Once deleted, the information related to the users cannot be retrieved.

Service Connection

Compatibility

Module Compatibility
Manager 17.10.5

Service Parameters

Name Description Required Default
apiVersion Yodlee API version Yes 1.1
coBrandName This name is provided by Yodlee during the sign-up process Yes avokabase

Inputs

Name Description Required
emailAddress The user email address. This is field is required if you haven't set the Contact Email XPath on the Form Data Config. No

Outputs

Name Description
data.userDeleted Is user deleted [ true | false ]
data.executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.

data.errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.
data.errorCode When a DATA_ERROR is experienced, this value provides the error code.
Yodlee - Get User Session v1.2.0
Provides a Fluent Function service for retrieving tokens necessary for starting a Yodlee Fastlink session

Service Connection

Compatibility

Module Compatibility
Manager 17.10.5

Service Parameters

Name Description Required Default
fastLinkUrl The URL for Yodlee FastLink Yes https://finapp.avokabasestage.yodlee.com/authenticate/avokabase
appId The app id to retrieve the access tokens. Yes 10003600
apiVersion Yodlee API version Yes 1.1
coBrandName This name is provided by Yodlee during the sign-up process Yes avokabase

Inputs

Name Description Required
emailAddress The user email address. This is field is required if you haven't set the Contact Email XPath on the Form Data Config. No

Outputs

Name Description
data.dataSet Used to customize FastLink and allows password copy paste.
data.appId The Fastlink appId.
data.nodeUrl The Fastlink URL.
data.userSession The user session is required to open the Fastlink IFrame.
data.cobrandSession The cobrand session is required to open the Fastlink Iframe.
data.token The Fastlink token is required to open the Fastlink IFrame.
data.returnUrl The callback URL to your form.
data.executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.

data.errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.
data.errorCode When a DATA_ERROR is experienced, this value provides the error code.
Yodlee - Get Accounts v1.2.0
Provides a Fluent Function service for retrieving accounts

Service Connection

Compatibility

Module Compatibility
Manager 17.10.5

Service Parameters

Name Description Required Default
clientResultsXpath The Xpath to store the client accounts result Yes /Root/AvokaSmartForm/Yodlee/Result
serverResultsXpath The Xpath to store the server accounts result Yes /Root/Yodlee/Result
apiVersion Yodlee API version Yes 1.1
coBrandName This name is provided by Yodlee during the sign-up process Yes avokabase

Inputs

Name Description Required
emailAddress The user email address. This is field is required if you haven't set the Contact Email XPath on the Form Data Config. No
accountId Comma separated No
providerAccountId Provider account No

Outputs

Name Description
data.accounts A list[] of {account} objects

Note: The list of accounts is also stored in the Form XML in the server side.

{account}

{account}.id The account id
{account}.label The label of the account
{account}.accountName The name of the account
{account}.accountNumber The number of the account
{account}.accountType The account type (SAVING, CHECKING)
{account}.accountStatus The account status (ACTIVE, ..)
{account}.providerId The id of the account provider, known by Yodlee
{account}.availableBalance A {balance} object representing the available balance of the account
{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
data.executionStatus The status of the service execution [ SUCCESS | DATA_ERROR | SYSTEM_ERROR ].

Successful execution will be denoted by a SUCCESS value. DATA_ERROR will indicate that there was an issue identified with the input data that may be resolved and potentially retried by the user. SYSTEM_ERROR indicates that there was an unrecoverable system fault and the form should fall-back gracefully to an alternative path.

data.errorMessage When a DATA_ERROR is experienced, this value may provide more detail on the nature of the error.
data.errorCode When a DATA_ERROR is experienced, this value provides the error code.

Service Connections

The following service connections are used by this package.

Yodlee
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