Get Transactions

v1.0.0

The Transaction service is used to get a list of transactions for a user.
By default, this service returns the last 30 days of transactions from today's date.
The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.
Values for categoryId parameter can be fetched from get transaction category list service.
The categoryId is used to filter transactions based on system-defined category as well as user-defined category.
User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002
The skip and top parameters are used for pagination. In the skip and top parameters pass the number of records to be skipped and retrieved, respectively. The response header provides the links to retrieve the next and previous set of transactions.
Double quotes in the merchant name will be prefixed by backslashes (\) in the response, e.g. Toys "R" Us.
sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.

Note

is made available for bank and card accounts and for the US market only.The address field in the response is available only when the TDE key is turned on.

The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 transactions.

This service supports the localization feature and accepts locale as a header parameter.

Input

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string"
    },
    "baseType": {
      "type": "string"
    },
    "categoryId": {
      "type": "string"
    },
    "categoryType": {
      "type": "string"
    },
    "container": {
      "type": "string"
    },
    "detailCategoryId": {
      "type": "string"
    },
    "fromDate": {
      "type": "string"
    },
    "highLevelCategoryId": {
      "type": "string"
    },
    "keyword": {
      "type": "string"
    },
    "skip": {
      "type": "integer",
      "format": "int32"
    },
    "toDate": {
      "type": "string"
    },
    "top": {
      "type": "integer",
      "format": "int32"
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}