Yodlee APIs – New Features/Enhancements
Standardizing Yodlee API v1.1 and v1.0 Error Messages
As part of an initiative to standardize the Yodlee API v1.1 and v1.0 error messages and to make it more intuitive, the term cobrand has been replaced with client.
Existing Error Messages | New Error Message |
Y011=Invalid cobrand or incorrectly configured cobrand | Y011=Invalid client or client configured incorrectly |
Y014=Cobrand configuration missing | Y014=Client configuration missing Note: This error message is returned for the authentication methods other than the JSON Web Token (JWT). |
Y022= Configuration missing, contact Yodlee Customer Services | Y022=Client configuration missing Note: This error message is returned only for the JWT authentication method. |
Data Extract Notification Enhancement
When data updates notification is unsubscribed during your maintenance windows and is subscribed back again, Yodlee will sends notification of a maximum of six hours with a one-hour interval to help to retrieve the missing data.
Important Notes and Bug Fixes
- The Yodlee API v1.0 and v1.1 get transaction categorization rules API has been enhanced. The API response had two arrays –
ruleClauses
andruleClauseArray
– that contained the same transaction rules. The enhanced API response will now only have theruleClauses
array. - A typo in the transaction type that is returned in both Yodlee API v1.0 and v1.1 get transactions and get userData APIs has been rectified. The transaction type
CAPITAL_GAINS_RECIEVED
is corrected toCAPITAL_GAINS_RECEIVED
.
Data Access and FastLink – New Features/Enhancements
Stop Screen Scraping Solution – API-level Exceptions
When an end-user attempts to add, edit, or refresh a site/provider/item that belongs to the UK and EU region, where screen-scraping is no longer allowed for PSD2 (second Payment Services Directive) sites, the following exceptions will be thrown:
- Add account flow –
API Version API-level Exception Yodlee API v1.1 Provider Not Supported
Yodlee API v1.0 Provider Not Supported
- Edit account flow –
API Version API-level Exception Yodlee API v1.1 Provider Not Supported
Yodlee API v1.0 Provider Not Supported
- Refresh account flow –
API Version API-level Exception Yodlee API v1.1 Provider Not Supported
Yodlee API v1.0 Provider Not Supported
All these exceptions are already in place and were implemented as a part of the March 2020 release.
Account Verification – New Features/Enhancements
Routing Number Format for Canada Sites
The format in which Yodlee returns routing numbers for the Canada locale sites has been normalized. This enhancement applies to customers using routing numbers for the Canada locale sites. The new format ensures that the Yodlee-returned routing number for Canada adheres to the industry standards and can be directly used for electronic funds transfer.
Old Format | New Format |
BBBBB-III The five digit transit number ‘BBBBB’ is followed by the three digit ‘III’ financial institution number. This is the MICR number. |
0IIIBBBBB Starting with a zero, then the three digit ‘III’ financial institution number followed by the five digit ‘BBBBB’ transit number. This is the routing number. |
Payment Profile for Student Loan Verification
In Yodlee API v1.1, the PAYMENT_PROFILE
dataset attribute has been enhanced to ensure that the data returned for the student loan verification customers is crisp and not redundant, and satisfies the business need of the customer.
A new field paymentBankTransferCode
had been introduced as part of PAYMENT_PROFILE dataset attribute. The paymentBankTransferCode
field will be present in the paymentProfile
entity of the GET accounts and GET accounts/{accountId} API response.
Balance Refresh Verification Enhancement
Balance refresh verification allows the customer to verify accounts by performing an on-demand refresh to get the latest account balance. Enhancements have been made in Yodlee API v1.1 to allow applications to trigger a balance refresh without the end-user engagement.
To trigger a balance refresh without an end-user engagement, in the PUT/providerAccounts API, pass SYSTEM
in the newly introduced initiatingSource
parameter.
Stability Fixes
SORT_CODE
availability fix – The bank transfer code type is specific to the region the account originates from. It was identified that the bank transfer code type SORT_CODE that applies only to the UK sites was not being returned. This issue has been fixed to ensure that the bank transfer code type is returned as SORT_CODE for the UK sites.- Challenge Deposit Verification (CDV) fixes – To optimize user experience, stabilization fixes have been made in the complete verification page of the CDV FastLink flow.
The message displayed in the FastLink 3.0 Complete Verification page for wrong CDV attempt has also been updated to provide the exact number of attempts remaining.- Message after first incorrect attempt –
Old Message New Message You have three attempts before your account is disabled. Please enter the two small deposits and withdrawal we made to your account. You have two more attempts before your account is disabled. Please enter the two small deposits and withdrawal we made to your account. - Message after second incorrect attempt –
Old Message New Message You have three attempts before your account is disabled. Please enter the two small deposits and withdrawal we made to your account. You have one more attempt before your account is disabled. Please enter the two small deposits and withdrawal we made to your account.
- Message after first incorrect attempt –
Transaction Data Enrichment – New Features/Enhancements
Detail Categories
To provide more granular-level categorization and deep insights into the consumer’s income and spending behavior, the following changes have been made to the detail or granular transaction categories:
- Enabled by default – Detail or granular categories, by default, have been enabled for all Transaction Data Enrichment (TDE) V2 and Yodlee API v1.1 customers across regions (i.e., wherever TDE is available). Enabling detail categories by default will help customers reap the benefits of detail categories in their applications.
- New categories added – Eight new granular categories that have been added to identify income related transactions follow: Wages Paid, Disability Benefits, Spousal Support Benefit, Business Transfers, Overdraft Protection Transfer, Potential Recurring Income, Non-recurring Direct Deposits, and Small Savings.
- Categories renamed – The two details categories of the expense categories group have been renamed from Repair and Sales to Motorcycle Repair and Motorcycle Sales, respectively.
For the complete list of transaction categories, refer to the Transaction Category Hierarchy page.
Enhancements for Hybrid Accounts
Support of the detail categories and the bills and subscription features have been extended to the following hybrid accounts:
- Loan container:
- LOC (line of credit)
- HELOC (home equity line of credit)
- SBLOC (securities-backed lines of credit)
- Investment container:
- CMA (cash management account)