Transactions Resource
This page refers to Yodlee API v1.0. The latest API version's data model documentation is available here.
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.
Valid Values: Transaction Base Type
|
| 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.
Valid Values: Container
|
| 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. Valid Values: Transaction Status
|
| 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. Valid Values: Transaction Type
|
| 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. Valid Values: Transaction Sub Type
|
| 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.
Valid Values: Transaction Category Source
|
| 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.
Valid Values: Transaction Source Type
|
Entity: description
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.
Valid Values: Transaction Merchant Source
|
| 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
Enums: Transaction Type
Enums: Transaction Status
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 |