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 |
| date | bank creditCard investment insurance loan | date | The value provided will be either postDate or transactionDate. postDate takes higher priority than the transaction date, except for the investment container, as only transaction data is available. The availability of postDate or transactionDate depends on the provider site. | GET transactions GET dataExtracts/userData |
| postDateTime | bank creditCard insurance loan | string | The timestamp on which the transaction is posted to the account. | GET transactions GET dataExtracts/userData |
| holdingDescription | investment | string | Captures the securities description for transactions involving securities. | 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 is 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 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 a few days after the transaction date. Note: The settled 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, the 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 |
| transactionDateTime | bank creditCard investment insurance loan | string | The timestamp when 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, New Zealand, and India-based provider sites. Valid Values: Transaction Type | 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 online or physical. | 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 parent category ID 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, New Zealand, 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, subscriber, or BNPL merchant. 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 GET dataExtracts/userData |
| categoryType | bank creditCard investment loan | string | The category type 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 |
| businessCategory | bank creditCard investment insurance loan | entity | The name of the business cateogry. Note: Transaction categorization is one of the core features offered by Yodlee and the categories are assigned to the transactions by the system. Transactions can be clubbed together by the category that is assigned to them. Valid Values: Business Transaction Categories. | 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 | The provider site assigned a unique ID to the transaction. The source is only available for the pre-populated accounts. | GET transactions GET dataExtracts/userData |
| isDeleted | All containers | boolean | Indicates if the transaction is deleted from the system. | GET dataExtracts/userData |
| sourceMerchantCategoryCode | bank creditCard | string | The merchant category code for an outgoing payment to a merchant. | GET transactions GET dataExtracts/userData |
| typeAtSource | bank creditCard | string | The type of transaction. | GET transactions GET dataExtracts/userData |
| sourceBillerCode | bank creditCard | string | The BPAY Biller Code for the transaction, if available. | GET transactions GET dataExtracts/userData |
| sourceBillerName | bank creditCard | string | The name of the BPAY biller for the transaction, if available. | GET transactions GET dataExtracts/userData |
| sourceApcaNumber | bank creditCard | string | The 6 digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros, if applicable. | GET transactions GET dataExtracts/userData |
Entity: description
Entity: merchant
| Attribute Name | Container | Type | Description | Endpoints |
|---|---|---|---|---|
| id | bank creditCard investment loan | string | Identifier of the merchant record. Note: The identifier will be present irrespective of the merchant name's availability. | 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 investment loan | 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 the city, state, and ZIP of the merchant). | 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 |
| logoURLs | bank creditCard investment loan | logoURLs | The merchant logo url and the type of the logo URL, i.e., SVG or PNG. | GET transactions GET dataExtracts/userData |
| contact | bank creditCard investment loan | contact | The phone and email of the merchant. | GET transactions GET dataExtracts/userData |
Entity: businessCategory
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
Enums: Transaction Type
Enums: Transaction Subtype
Enums: Transaction Status
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
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. |
| BNPL | Merchants that are identified as BNPL (Buy Now Pay Later) in the Yodlee merchant database. |
| OTHERS | No merchant is identified, or the merchant is not a biller or a subscriber. |