Transactions Resource

Entity: transaction

Attribute Name Container Type Description Endpoints
accountId  bank
creditCard
investment
insurance
loan
long The account from which the transaction was made. This is basically the primary key of the account resource.  GET transactions
GET dataExtracts/userData
amount bank
creditCard
investment
insurance
loan
money The amount of the transaction as it appears at the FI site. GET transactions
GET dataExtracts/userData
baseType bank
creditCard
investment
insurance
loan
string Indicates if the transaction appears as a debit or a credit transaction in the account.
Valid Values: Transaction Base Type
GET transactions
container  bank
creditCard
investment
insurance
loan
string The account's container.
Valid Values: Container
GET transactions
GET dataExtracts/userData
cusipNumber investment string The CUSIP (Committee on Uniform Securities Identification Procedures) number identifies the financial instruments in the United States and Canada.
Note: The CUSIP number field applies only to trade related transactions.
GET transactions
GET dataExtracts/userData
isin investment string ISIN (International Securities Identification Number) uniquely identifies specific securities and is used worldwide. GET transactions
GET dataExtracts/userData
sedol investment string SEDOL (Stock Exchange Daily Official List) is a list of security identifiers used in the United Kingdom and Ireland for clearing purposes. GET transactions
GET dataExtracts/userData
valoren investment string Valoren is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland. GET transactions
GET dataExtracts/userData
symbol  investment string The symbol of the security being traded. GET transactions
GET dataExtracts/userData
merchantLogoURL  bank
creditCard
investment
loan
string The URL of the merchant’s logo that is associated with the transaction.
Note: The merchantLogoURL field applies only to the US region.
GET transactions
GET dataExtracts/userData
date bank
creditCard
investment
insurance
loan
date The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site. GET transactions
GET dataExtracts/userData
holdingDescription  investment string For transactions involving securities, this captures the securities description. GET transactions
GET dataExtracts/userData
id  bank
creditCard
investment
insurance
loan
long An unique identifier for the transaction. The combination of the id and account container are unique in the system. GET transactions
GET dataExtracts/userData
interest  loan money The portion of interest in the transaction amount. The transaction amount can be the amount due, payment amount, minimum amount, repayment, etc. GET transactions
GET dataExtracts/userData
isManual  bank
creditCard
investment
insurance
loan
Boolean Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API. GET transactions
GET dataExtracts/userData
memo  bank
creditCard
investment
insurance
loan
string Additional notes provided by the user for a particular  transaction through application or API services.  GET transactions
GET dataExtracts/userData
postDate  bank
creditCard
insurance
loan
date The date on which the transaction is posted to the account. GET transactions
GET dataExtracts/userData
price  investment money The price of the security for the transaction.
Note: The price field applies only to the trade related transactions.
GET transactions
GET dataExtracts/userData
principal  loan money The portion of the principal in the transaction amount. The transaction amount can be the amount due, payment amount, minimum amount, repayment, etc. GET transactions
GET dataExtracts/userData
quantity  investment decimal The quantity associated with the transaction.
Note: The quantity field applies only to trade-related transactions.
GET transactions
GET dataExtracts/userData
settleDate  investment date It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date.
Note: The settleDate field applies only to trade-related transactions.
GET transactions
GET dataExtracts/userData
status  bank
creditCard
investment
insurance
loan
string The status of the transaction: pending or posted.
Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.
Valid Values: Transaction Status
GET transactions
GET dataExtracts/userData
transactionDate  bank
creditCard
investment
insurance
loan
date The date the transaction happens in the account.  GET transactions
GET dataExtracts/userData
type  bank
creditCard
investment
string The nature of the transaction, i.e., deposit, refund, payment, etc.
Note: The transaction type field is available only for the United States, Canada, United Kingdom, Australia, and India based provider sites.
GET transactions
GET dataExtracts/userData
description bank
creditCard
investment
insurance
loan
entity Description details GET transactions
GET dataExtracts/userData
isPhysical  bank
creditCard
investment
loan 
boolean Indicates if the transaction is an online or a physical transaction. GET transactions
runningBalance  bank
creditCard
money The running balance in an account indicates the balance of the account after every transaction. GET transactions
GET dataExtracts/userData
parentCategoryId  bank creditCard investment insurance loan  long The parentCategoryId of the category assigned to the transaction.
Note: This field will be provided in the response if the transaction is assigned to a user-created category.
GET transactions
GET dataExtracts/userData
subType bank, creditCard string The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, Australia, and India.
Valid Values: Transaction Subtype
GET transactions
GET dataExtracts/userData
merchantType bank
creditCard
string Provides further information about a transaction, i.e., if the transaction is carried out on a biller or a subscriber.
Valid Values: Merchant Type
GET transactions
merchant bank
creditCard
investment
loan
entity The name of the merchant associated with the transaction.
Note: The merchant name field is available only in the United States, Canada, United Kingdom, Australia, and India.
GET transactions
GET dataExtracts/userData
intermediary  bank
creditCard
investment
loan 
string Indicates if the merchant is an intermediary or a secondary merchant. GET transactions
categoryType bank
creditCard
investment
loan
string The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET transactions
GET dataExtracts/userData
categoryId bank
creditCard
investment
loan
long The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET transactions
GET dataExtracts/userData
category bank
creditCard
investment
loan
string The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET transactions
GET dataExtracts/userData
categorySource bank
creditCard
investment
insurance
loan
string Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories.
Valid Values: Transaction Category Source
GET transactions
GET dataExtracts/userData
highLevelCategoryId bank
creditCard
investment
insurance
loan
Long The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories. GET transactions
GET dataExtracts/userData
detailCategoryId bank
creditCard
long The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories. GET transactions
GET dataExtracts/userData
checkNumber bank string The checkNumber of the transaction. GET transactions
GET dataExtracts/userData
commission investment money A commission or brokerage associated with a transaction.
Additional Details:The commission only applies to trade-related transactions.
GET transactions
GET dataExtracts/userData
sourceType bank
creditCard
investment
insurance
loan
string The source through which the transaction is added to the Yodlee system.
Valid Values: Transaction Source Type
GET transactions
GET dataExtracts/userData
sourceId All containers string A unique ID that the provider site has assigned to the transaction. The sourceId is available for the held-away (only Open Banking) and pre-populated accounts. GET transactions
GET dataExtracts/userData
isDeleted All containers boolean Indicates if the transaction is deleted from the system. GET dataExtracts/userData

Entity: description

Attribute Name Container Type Description Endpoints
original bank
creditCard
investment
insurance
loan
string Original transaction description as it appears at the FI site. GET transactions
consumer bank
creditCard
investment
insurance
loan
string The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field. GET transactions
GET dataExtracts/userData
simple bank
creditCard
string The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field. 
Note: The simple description field is available only in the United States, Canada, United Kingdom, Australia, and India.
GET transactions
GET dataExtracts/userData
security investment string The actual name of the security. GET transactions
GET dataExtracts/userData

Entity: merchant

Attribute Name Container Type Description Endpoints
id  bank
creditCard
investment
loan
string Identifier of the merchant. GET transactions
GET dataExtracts/userData
source  bank
creditCard
investment
loan
string The source through which merchant information is retrieved.
Valid Values: Transaction Merchant Source
GET transactions
GET dataExtracts/userData
name  bank
creditCard
investment
loan
string The name of the merchant. GET transactions
GET dataExtracts/userData
categoryLabel  bank
creditCard
string[] Additional category information from the Yodlee reference data, if available. GET transactions
GET dataExtracts/userData
address  bank
creditCard
address The address of the merchant associated with the transaction is populated in the merchant address field.
Note: The merchant address field is not available by default and customers will have to specifically request the merchant's address (that includes city, state, and ZIP of the merchant). The merchant address field is available for merchants in the United States and Australia.
GET transactions
GET dataExtracts/userData
coordinates bank
creditCard
coordinates The longitude and latitude information of the merchant address. GET transactions
GET dataExtracts/userData
logoURL bank
creditCard
investment
loan
string The URL of the merchant logo. GET transactions

Enums: Transaction Base Type

Base Type Description
CREDIT Denotes that the transactions are being credited to the account.
DEBIT Denotes that the transactions are getting debited to the account.

Enums: Transaction Category Source

Category Source Description
SYSTEM The category assigned to the transaction is a system defined category.
 USER The category assigned to the transaction is a user defined category.

Enums: Transaction Merchant Source

Source Description
YODLEE The source that provided the merchant information is Yodlee.
FACTUAL The source that provided the merchant information is FACTUAL.

Enums: Transaction Type

Container Description
bank, creditCard CHARGES_FEES
DEPOSIT
DEPOSITS_CREDITS
INTEREST
PAYMENT
PURCHASE
REFUND
TRANSFER
WITHDRAWAL
Investment 1035_EXCHANGE
401K_CONTRIBUTION
401K_EMPLOYER_CONTRIBUTION
529_PLAN_CONTRIBUTION
ACCOUNT_FEE
ACCOUNT_MAINTENANCE_FEE
ACCUMULATION
ACH_OUT
ADJUSTED_ASSIGN
ADJUSTED_BUY
ADJUSTED_CREDIT
ADJUSTED_DEBIT
ADJUSTED_SELL
ADJUSTMENT
ADMINISTRATIVE_FEE
ANNUITY_CREDIT
ASSIGN_OPTION
ATM_FEE
ATM_WITHDRAWAL
ATM_WITHDRAWAL_FEE
ATM_WITHDRAWAL_FEE_CREDIT
AUTOMATIC_INVESTMENT
BAD_CHECK
BALANCE_FORWARD
BILL_PAY
BILL_PAY_IN
BILL_PAY_OUT
BOND_CALL
BOND_MATURES
BUY
BUY_ACCRUED_INTEREST
BUY_OPTION
BUY_TO_CLOSE
BUY_TO_COVER
BUY_TO_OPEN
CAPITAL_CALLS
CAPITAL_GAINS_RECEIVED
CAPITAL_GAINS_REINVESTED
CHARGE
CHARGE_CREDIT
CHECK
CHECK_BOOK_REORDER_FEE
CONVERSION
CORPORATE_ACQUISITION
CREDIT_IN_LIEU_OF_FRACTIONAL_SHARE
CS_ADJUSTMENT
DEATH_BENEFIT_PAYOUT
DEFERRED_COMPENSATION_CONTRIBUTION
DEFERRED_COMPENSATION_DISTRIBUTION
DEPOSIT
DIRECT_DEPOSIT
DISTRIBUTIONS_OUT
DIVIDEND_PAYMENT
DIVIDEND_REINVESTMENT
DVP
EDUCATIONAL_PLAN_CONTRIBUTION
ESOP_ALLOCATION
EXCESS_CONTRIBUTION
EXERCISE_OPTION
EXPIRE_OPTION
FED_TAX_WITHHELD
FEDERAL_TAX_FREE_DIVIDEND
FEDERAL_TAX_FREE_INTEREST_INCOME
FEDEX_FEE
FOREIGN_TAX
FOREIGN_TAX_CREDIT
FORFEITURE
FRACTIONAL_SHARE_LIQUIDATION
FUND_EXCHANGE
FUND_EXPENSE
GENERIC_CONTRIBUTION
INTEREST_INCOME
INTEREST_REINVESTMENT
IRA_CONTRIBUTION
IRA_DISTRIBUTION
IRA_NON_QUALIFIED_DISTRIBUTION
LOAN_DISTRIBUTION
LOAN_PAYMENT
LOAN_WITHDRAWAL
LONG_TERM_CAPITAL_GAINS_DISTRIBUTION
MARGIN_INTEREST_EXPENSE
MERGER
MISC_CREDIT
MISC_JRL_CASH_TO_MARGIN
MISC_JRL_MARGIN_TO_CASH
MISCELLANEOUS_EXPENSE
MISCELLANEOUS_INCOME
MMF_DIVIDEND
MMF_IN
MMF_LIQ
MMF_REIN
MMF_SWEEP
MMF_TRANSACTION
MONEY_FUNDS_JOURNAL_CASH_TO_MARGIN
MONEY_FUNDS_JOURNAL_MARGIN_TO_CASH
MORTALITY_AND_EXPENSE_RISK_CHARGE
NAME_CHANGE
NSF_FEE
ORDER_OUT
ORDER_OUT_FEE
OTHER
OTHER_ANNUITY_FEE
PAYOUT
PENALTY
PRINCIPAL_PAYMENT
RECHARACTERIZATION
REINVEST_LONG_TERM_CAPITAL_GAINS
REINVEST_SHORT_TERM_CAPITAL_GAINS
REMINDER
REORGANIZATION_CHARGE
RETURN_OF_CAPITAL
RETURNED_CHECK_FEE
REVERSAL
ROLLOVER_CONTRIBUTION
ROLLOVER_TO_QUAL
ROTH_CONTRIBUTION
RTQ_FEE
RVP
SELL
SELL_ACCRUED_INTEREST
SELL_OPTION
SELL_TO_CLOSE
SELL_TO_OPEN
SEP_CONTRIBUTION
SHARES_IN
SHARES_OUT
SHORT_SELL
SHORT_TERM_CAPITAL_GAINS_DISTRIBUTION
SIMPLE_PLAN_CONTRIBUTION
SPINOFF
STATE_TAX_FREE_DIVIDEND
STATE_TAX_FREE_INTEREST_INCOME
STATE_TAX_WITHHELD
STAX
STOCK_DIVIDEND
STOCK_FUND_OPTION_JOURNAL_CASH_TO_MARGIN
STOCK_FUND_OPTION_JOURNAL_MARGIN_TO_CASH
STOCK_OPTION_EXERCISE
STOCK_OPTION_WITHHOLDING
STOCK_SPLIT
SURRENDER_CHARGE
SWEEP
SYMBOL_CHANGE
TAX_FREE_DIVIDEND
TENDERED
TRANSFER_CASH_IN
TRANSFER_CASH_OUT
TRANSFER_SHARES_IN
TRANSFER_SHARES_OUT
WIRE_FEE
WIRE_FUNDS_IN
WIRE_FUNDS_OUT
WITHDRAWAL
WORTHLESS_SECURITIES

Enums: Transaction Subtype

Container Sub Type
bank, creditCard ANNUAL_FEE 
ATM_CASH_WITHDRAWAL 
AUTO_LOAN 
BALANCE_TRANSFER 
CHILD_SUPPORT 
CONVENIENCE_FEE 
CREDIT 
CREDIT_CARD_PAYMENT 
DEPOSIT 
DIRECT_DEPOSIT_SALARY 
FINANCE_CHARGE 
HOME_LOAN_MORTGAGE 
INSURANCE_PAYMENT 
INTEREST 
INVESTMENT_INCOME_CASH 
LOAN 
NSF_FEES 
ONLINE_PURCHASE 
OTHER_CHARGES_FEES 
OVERDRAFT_CHARGE 
OVERDRAFT_PROTECTION 
PAYMENT 
PAYMENT_BY_CHECK 
PERSONAL_LOAN 
PURCHASE 
RECURRING_SUBSCRIPTION_PAYMENT 
REFUND 
REIMBURSEMENT 
RETURNED_CHECK_CHARGE 
REWARDS 
SERVICE_CHARGE 
SSA 
STOP_PAYMENT_CHARGE 
STUDENT_LOAN 
TAX_PAYMENT 
TAX_REFUND 
TRANSFER 
UTILITIES_PAYMENT 

Enums: Transaction Status

Status Description
POSTED Denotes that the transaction is realized on the account's balance.
PENDING Denotes that the transaction is not yet realized on the account's balance.
SCHEDULED Denotes that the transacation is a future dated transaction.
FAILED Denotes the failed transactions. It is only applicable to rejected claims in a Flexible Spending account.
CLEARED Denotes that the manual transaction is added via Envestnet | Yodlee Financial Wellness Solutions or a transaction that the system has created when an account is closed using API or an application.

Enums: Container

Container Applicable for Aggregated/Manual Accounts
bank  both
creditCard both
investment both
insurance both
loan both
otherAssets manual
otherLiabilities manual
realEstate manual
reward both
bill both

Enums: Transaction Category Type

Category Type Description 
TRANSFER The transaction category belongs to a transfer category type.
DEFERRED_COMPENSATION The transaction category belongs to deferred compensation type.
UNCATEGORIZE The transaction does not seem to be categorized.
INCOME The transaction category belongs to an income type.
EXPENSE The transaction category belongs to an expense type.

Enums: Transaction Source Type

Source Description 
AGGREGATED Indicates that the transaction is aggregated from the provider site.
MANUAL Indicates that the transaction is created manually by the user.

Enums: Merchant Type

Type Description
BILLERS Merchants that are identified as billers in the Yodlee merchant database.
SUBSCRIPTION Merchants that are identified as subscribers in the Yodlee merchant database.
OTHERS No merchant is identified, or the merchant is not a biller or a subscriber.