Transactions Resource - v1.0

Entity: transaction

Attribute Name Container Type Description
accountId  bank
creditCard
investment
insurance
loan
long The account from which the transaction was made. This is basically the primary key of account resource. 
amount  bank
creditCard
investment
insurance
loan
money The amount of the transaction as it appears at the FI site.
baseType  bank
creditCard
investment
insurance
loan
string Determines if the transaction is an expense or income.
category  bank
creditCard
investment
insurance
loan
string The category name of the transaction. This is the category attribute provided in the TransactionCategory resource. The supported values are provided by GET transactions/categories.
CONTAINER bank
creditCard
investment
insurance
loan
string The container to which the account belongs to.
cusipNumber investment string The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.
Note: The CUSIP number field is only applicable to the trade related transactions.
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.
holdingDescription  investment string For transactions involving securities, this will capture the securities description.
id  bank
creditCard
investment
insurance
loan
long An unique identifier for the transaction. A combination of the id and container of the account are unique in the system.
interest  loan money The portion of interest in the transaction amount. The transaction amount can be amount due, payment amount, minimum amount, repayment, etc.
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.
memo  bank
creditCard
investment
insurance
loan
string Additional notes provided by the user for a particular  transaction through application or API services. 
postDate  bank
creditCard
insurance
loan
date The date on which the transaction is posted to the account.
price  investment money The price of the security for which the transaction is placed.
Note: The price field is only applicable to the trade related transactions.
principal  loan money The portion of the principal in the transaction amount. The transaction amount can be amount due, payment amount, minimum amount, repayment, etc.
quantity  investment decimal The quantity associated with the transaction.
Note: The quantity field is only applicable to the trade related transactions.
settleDate  investment date It is the date on which the transaction is finalized, i.e., the ownership of the security is transferred to the buyer. Settlement date is usually few days after the transaction date.
status  bank
creditCard
investment
insurance
loan
string The status of the transaction i.e. pending, posted.
Note: Most of the FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.
symbol  investment string The symbol of the security that is being traded.
Note: The settle date field is only applicable to the trade related transactions.
transactionDate  bank
creditCard
investment
insurance
loan
date The date on which the transaction is done on the account. 
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, and India based provider sites.
description bank
creditCard
investment
insurance
loan
entity Details of various descriptions.
runningBalance  bank
creditCard
investment
money The running balance in an account indicates the balance of the account after every transaction.
parentCategoryId  bank
creditCard
investment
insurance
loan
long The parentCategoryId of the category that is assigned to the transaction.
Note: This field will be provided in the response, only if the transaction is assigned to a user created category.
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 done using a debit or credit card.
Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.
merchant bank
creditCard
investment
insurance
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, and India.
categoryType  bank
creditCard
investment
insurance
loan
string The categoryType of the category the transaction is assigned to. This is the type field of the transaction category resource. The supported values are provided by GET transactions/categories.
categoryId bank
creditCard
investment
insurance
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 GET transactions/categories.
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 GET transactions/categories.
highLevelCategoryId bank
creditCard
investment
insurance
loan
Long The high level category that is assigned to the transaction. The supported values are provided by GET transactions/categories.
checkNumber bank string The checkNumber of the transaction.
commission investment money A commission or brokerage associated with a transaction.
createdDate bank
creditCard
investment
insurance
loan
dateTime The date on which the transaction is created in the Yodlee system.
lastUpdated bank
creditCard
investment
insurance
loan
dateTime The date when the information was last updated in the system.
sourceType bank
creditCard
investment
insurance
loan
string The mode through which the transactions are created in the system.


Entity: description

Attribute Name Container Type Description
original bank
creditCard
investment
insurance
loan
string Original transaction description as it appears at the FI site.
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.
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, and India.


Entity: merchant

Attribute Name Container Type Description
id  bank
creditCard
investment
insurance
loan
string Identifier of the merchant.
source  bank
creditCard
investment
insurance
loan
string The source through which the merchant information is retrieved.
name  bank
creditCard
investment
insurance
loan
string The name of the merchant.
categoryLabel  bank
creditCard
string[] The business categories of the merchant.
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 to get the merchant address (that includes city, state, and ZIP of the merchant). The merchant address field is available only for merchants in the United States.
coordinates bank
creditCard
coordinates The longitude and latitude information of the merchant address.


Enums: Transaction Base Type

Base Type Description
CREDIT Denotes that the transactions are getting 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 which provided the merchant information is Yodlee.
FACTUAL The source which provided the merchant information is FACTUAL.


Enums: Transaction Sub Type

Container Sub Type
bank, creditCard ACCOUNT_TO_ACCOUNT_TRANSFER 
ACCOUNT_VERIFICATION 
ACH_DEBIT 
ADJUSTMENT 
ANNUAL_FEE 
ATM_CASH_WITHDRAWAL 
ATM_TELLER_DEPOSIT 
AUTH_COMPLETE 
AUTH_HOLD 
AUTH_PROCESSING 
AUTH_RELEASE 
AUTH_REQUEST 
AUTH_VOID 
AUTO_LOAN 
BALANCE_ENQUIRY 
BALANCE_TRANSFER 
BANK_ADJUSTMENT 
BANK_DIRECT_DEPOSIT 
BANK_TO_BANK_TRANSACTION 
BANK_TO_NON_BANK_ACCOUNT_TRANSFER 
BILL_PAY_CHARGE 
CAPITAL_GAINS_DISTIBUTION 
CASH_ADVANCE 
CASH_WITHDRAWAL_AT_FI 
CG_LONG_TERM_DEPOSIT 
CHARGE_A_REPEAT_CUSTOMER 
CHARGES_FEES 
CHECK_DEPOSIT 
CHECK_IMAGE_SERVICE_CHARGE 
CHECKS_ORDERING_CHARGE 
CHILD_SUPPORT 
CONTACT_LESS_DEBIT 
CONVENIENCE_FEE 
CREDIT 
CREDIT_ADJUSTMENT 
CREDIT_CARD_CREDIT 
CREDIT_CARD_PAYMENT 
DEBIT 
DEBIT_CARD_FEE 
DEBIT_CARD_WITHDRAWAL_AT_STORE
DEFERRED_BILL_PAY 
DEFERRED_DEPOSIT 
DEPOSIT 
DEPOSITS_CREDITS 
DIRECT_DEPOSIT_SALARY 
DIVIDEND_DEPOSIT 
DOWN_PAYMENT_OR_ANNUITY_PAYMENT_OR_DIRECT_PAYMENT 
ELECTRONIC_PAYMENT 
FEE_PAYMENT 
FEE_REFUND 
FEE_VOID 
FINANCE_CHARGE 
FINANCE_CHARGE_REFUND 
HOLD_CHECK_PAYMENT 
HOME_LOAN_MORTGAGE 
INSTALLMENT_PAYMENT 
INSURANCE_PAYMENT 
INTEREST 
INTEREST_ADJUSTMENT 
INTEREST_CHECK 
INTEREST_SAVINGS 
INVESTMENT_INCOME_CASH 
LOAN 
MOBILE_REMOTE_DEPOSIT 
MONTHLY_MAINTENANCE_CHARGE 
NSF_FEES 
ONLINE_PURCHASE 
OPEN_SALE_DEPOSIT 
OTHER_CHARGES_FEES 
OTHER_DEPOSITS 
OTHER_WITHDRAWALS 
OVERDRAFT_CHARGE 
OVERDRAFT_PROTECTION 
OVERDRAFT_PROTECTION_CHARGE 
PAYMENT 
PAYMENT_BY_CHECK 
PAYMENT_PLAN 
PERSONAL_LOAN 
PERSONAL_LOAN_CREDIT 
PIN_DEBIT 
POS_DEBIT 
PRE_AUTH 
PRE_AUTH_COMPLETION 
PURCHASE 
PURCHASE_VOID 
PURCHASE_WITH_CREDIT_CARD 
PURCHASE_WITH_DEBIT_CARD 
PURCHASED_WITH_CHECK 
RECURRING_BILLING 
RECURRING_SUBSCRIPTION_PAYMENT 
REFUND 
REIMBURSEMENT 
RETURNED_CHECK_CHARGE 
RETURNED_CHECK_REIMBURSEMENT 
REWARDS 
SALES_TAX 
SERVICE_CHARGE 
SERVICE_CHARGE_FEE_REFUND 
SHORT_TERM_CREDIT 
SIGNATURE_DEBIT 
SSA 
STOP_PAYMENT_CHARGE 
STUDENT_LOAN 
TAX_PAYMENT 
TAX_REFUND 
TELLER_DEPOSIT 
TRANSACTION_VOID 
TRANSFER 
UTILITIES_PAYMENT 
WIRE_TRANSFER 
WIRE_TRANSFER_CHARGE 
WITHDRAWAL


Enums: Transaction Type

Container Description
bank , creditCard AUTHORIZATION
BANK_ADJUSTMENT
CASH_ADVANCE
CHARGES_FEES
CREDIT
DEBIT
DEFERRED
DEPOSIT
DEPOSITS_CREDITS
INTEREST
OTHER_DEPOSITS
OTHER_WITHDRAWALS
PAYMENT
POS_DEBIT
PURCHASE
REFUND
TRANSFER
VOID
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 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.


Enums: Transaction Source

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


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