Transactions

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The access token associated with the Item data is being requested for.

include_original_description

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

cursor

string

The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update. If omitted, the entire history of updates will be returned, starting with the first-added transactions on the Item. The cursor also accepts the special value of "now", which can be used to fast-forward the cursor as part of migrating an existing Item from /transactions/get to /transactions/sync. For more information, see the Transactions sync migration guide. Note that using the "now" value is not supported for any use case other than migrating existing Items from /transactions/get.
The upper-bound length of this cursor is 256 characters of base64.

count

integer

The number of transaction updates to fetch.

Default: 100

Minimum: 1

Maximum: 500

Exclusive min: false

options

object

An optional object to be used with the request. If specified, options must not be null.

boolean

Include the raw unparsed transaction description from the financial institution.

Default: false

days_requested

integer

This option only applies to calls for Items that were not initialized with Transactions during Link and are now adding the Transactions product to the Item for the first time. In these cases, this option controls the maximum number of days of transaction history that Plaid will request from the financial institution. For developer accounts created after December 3, 2023, if no value is specified, this will default to 90 days. For developer accounts created on December 3, 2023 or earlier, if no value is specified, this will default to 730 days until June 24, 2024, at which point it will default to 90 days.
If Transactions has already been added to the Item prior to this call, this field will have no effect.
We strongly recommend that customers utilizing Recurring Transactions request at least 180 days of history for optimal results.

Minimum: 1

Maximum: 730

Default: 90

/transactions/sync
Select Language
1// Provide a cursor from your database if you've previously
2// received one for the Item. Leave null if this is your
3// first sync call for this Item. The first request will
4// return a cursor.
5let cursor = database.getLatestCursorOrNull(itemId);
6
7// New transaction updates since "cursor"
8let added: Array<Transaction> = [];
9let modified: Array<Transaction> = [];
10// Removed transaction ids
11let removed: Array<RemovedTransaction> = [];
12let hasMore = true;
13
14// Iterate through each page of new transaction updates for item
15while (hasMore) {
16  const request: TransactionsSyncRequest = {
17    access_token: accessToken,
18    cursor: cursor,
19  };
20  const response = await client.transactionsSync(request);
21  const data = response.data;
22
23  // Add this page of results
24  added = added.concat(data.added);
25  modified = modified.concat(data.modified);
26  removed = removed.concat(data.removed);
27
28  hasMore = data.has_more;
29
30  // Update cursor to the next cursor
31  cursor = data.next_cursor;
32}
33
34// Persist cursor and updated data
35database.applyUpdates(itemId, added, modified, removed, cursor);

transactions/sync

Response fields and example

added

[object]

Transactions that have been added to the Item since cursor ordered by ascending last modified time.

string

The ID of the account in which this transaction occurred.

number

The settled value of the transaction, denominated in the transactions's currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.

Format: double

nullablestring

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the transaction. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported iso_currency_codes.

deprecatednullable[string]

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

deprecatednullablestring

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
All Transactions implementations are recommended to use the new personal_finance_category instead of category, as it provides greater accuracy and more meaningful categorization.
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

check_number

nullablestring

The check number of the transaction. This field is only populated for check transactions.

date

string

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ). To receive information about the date that a posted transaction was initiated, see the authorized_date field.

Format: date

location

object

A representation of where a transaction took place

address

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

region

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

postal_code

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

country

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

name

string

The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, this field will always appear. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

nullablestring

The merchant name, as enriched by Plaid from the name field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null.

original_description

nullablestring

The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/sync or /transactions/get, this field will be omitted unless the client has set options.include_original_description to true.

payment_meta

object

Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

reference_number

nullablestring

The transaction reference number supplied by the financial institution.

ppd_id

nullablestring

The ACH PPD ID for the payer.

payee

nullablestring

For transfers, the party that is receiving the transaction.

by_order_of

nullablestring

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

payer

nullablestring

For transfers, the party that is paying the transaction.

payment_method

nullablestring

The type of transfer, e.g. 'ACH'

payment_processor

nullablestring

The name of the payment processor

reason

nullablestring

The payer-supplied description of the transfer.

pending

boolean

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

pending_transaction_id

nullablestring

The ID of a posted transaction's associated pending transaction, where applicable.

account_owner

nullablestring

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

string

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

transaction_type

deprecatedstring

Please use the payment_channel field, transaction_type will be deprecated in the future.
digital: transactions that took place online.
place: transactions that were made at a physical location.
special: transactions that relate to banks, e.g. fees or deposits.
unresolved: transactions that do not fit into the other three types.

Possible values: digital, place, special, unresolved

nullablestring

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

The website associated with this transaction, if available.

authorized_date

nullablestring

The date that the transaction was authorized. For posted transactions, the date field will indicate the posted date, but authorized_date will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_date, when available, is generally preferable to use over the date field for posted transactions, as it will generally represent the date the user actually made the transaction. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ).

Format: date

authorized_datetime

nullablestring

Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For posted transactions, the datetime field will indicate the posted date, but authorized_datetime will indicate the day the transaction was authorized by the financial institution. If presenting transactions to the user in a UI, the authorized_datetime, when available, is generally preferable to use over the datetime field for posted transactions, as it will generally represent the date the user actually made the transaction.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

datetime

nullablestring

Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ). For the date that the transaction was initiated, rather than posted, see the authorized_datetime field.
This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.

Format: date-time

payment_channel

string

The channel used to make a payment. online: transactions that took place online.
in store: transactions that were made at a physical location.
other: transactions that relate to banks, e.g. fees or deposits.
This field replaces the transaction_type field.

Possible values: online, in store, other

nullableobject

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

personal_finance_category_icon_url

nullablestring

A description of how confident we are that the provided categories accurately describe the transaction intent.
VERY_HIGH: We are more than 98% confident that this category reflects the intent of the transaction. HIGH: We are more than 90% confident that this category reflects the intent of the transaction. MEDIUM: We are moderately confident that this category reflects the intent of the transaction. LOW: This category may reflect the intent, but there may be other categories that are more accurate. UNKNOWN: We don’t know the confidence level for this category.

transaction_code

nullablestring

An identifier classifying the transaction type.
This field is only populated for European institutions. For institutions in the US and Canada, this field is set to null.
adjustment: Bank adjustment
atm: Cash deposit or withdrawal via an automated teller machine
bank charge: Charge or fee levied by the institution
bill payment: Payment of a bill
cash: Cash deposit or withdrawal
cashback: Cash withdrawal while making a debit card purchase
cheque: Document ordering the payment of money to another person or organization
direct debit: Automatic withdrawal of funds initiated by a third party at a regular interval
interest: Interest earned or incurred
purchase: Purchase made with a debit or credit card
standing order: Payment instructed by the account holder to a third party at a regular interval
transfer: Transfer of money between accounts

Possible values: adjustment, atm, bank charge, bill payment, cash, cashback, cheque, direct debit, interest, purchase, standing order, transfer, null

string

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

counterparties

[object]

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

name

string

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the counterparty.

type

string

The counterparty type.
merchant: a provider of goods or services for purchase financial_institution: a financial entity (bank, credit union, BNPL, fintech) payment_app: a transfer or P2P app (e.g. Zelle) marketplace: a marketplace (e.g DoorDash, Google Play Store) payment_terminal: a point-of-sale payment terminal (e.g Square, Toast) income_source: the payer in an income transaction (e.g., an employer, client, or government agency)

Possible values: merchant, financial_institution, payment_app, marketplace, payment_terminal, income_source

nullablestring

The website associated with the counterparty.

nullablestring

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

A description of how confident we are that the provided counterparty is involved in the transaction.
VERY_HIGH: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. HIGH: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. MEDIUM: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. LOW: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. UNKNOWN: We don’t know the confidence level for this counterparty.

merchant_entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the merchant. In the case of a merchant with multiple retail locations, this field will map to the broader merchant, not a specific location or store.

modified

[object]

Transactions that have been modified on the Item since cursor ordered by ascending last modified time.

string

The ID of the account in which this transaction occurred.

number

Format: double

nullablestring

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

nullablestring

deprecatednullable[string]

deprecatednullablestring

check_number

nullablestring

The check number of the transaction. This field is only populated for check transactions.

date

string

Format: date

location

object

A representation of where a transaction took place

address

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

region

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

postal_code

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

country

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

name

string

nullablestring

original_description

nullablestring

payment_meta

object

reference_number

nullablestring

The transaction reference number supplied by the financial institution.

ppd_id

nullablestring

The ACH PPD ID for the payer.

payee

nullablestring

For transfers, the party that is receiving the transaction.

by_order_of

nullablestring

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

payer

nullablestring

For transfers, the party that is paying the transaction.

payment_method

nullablestring

The type of transfer, e.g. 'ACH'

payment_processor

nullablestring

The name of the payment processor

reason

nullablestring

The payer-supplied description of the transfer.

pending

boolean

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

pending_transaction_id

nullablestring

The ID of a posted transaction's associated pending transaction, where applicable.

account_owner

nullablestring

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

string

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

transaction_type

deprecatedstring

Possible values: digital, place, special, unresolved

nullablestring

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

The website associated with this transaction, if available.

authorized_date

nullablestring

Format: date

authorized_datetime

nullablestring

Format: date-time

datetime

nullablestring

Format: date-time

payment_channel

string

Possible values: online, in store, other

nullableobject

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

personal_finance_category_icon_url

nullablestring

transaction_code

nullablestring

Possible values: adjustment, atm, bank charge, bill payment, cash, cashback, cheque, direct debit, interest, purchase, standing order, transfer, null

string

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

counterparties

[object]

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

name

string

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the counterparty.

type

string

Possible values: merchant, financial_institution, payment_app, marketplace, payment_terminal, income_source

nullablestring

The website associated with the counterparty.

nullablestring

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

merchant_entity_id

nullablestring

removed

[object]

Transactions that have been removed from the Item since cursor ordered by ascending last modified time.

string

The ID of the removed transaction.

next_cursor

string

Cursor used for fetching any future updates after the latest update provided in this response. The cursor obtained after all pages have been pulled (indicated by has_more being false) will be valid for at least 1 year. This cursor should be persisted for later calls. If transactions are not yet available, this will be an empty string.

has_more

boolean

Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with cursor set to next_cursor. If has_more is true, it’s important to pull all available pages, to make it less likely for underlying data changes to conflict with pagination.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"added": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 72.1,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Shops",
      "Supermarkets and Groceries"
    ],
    "category_id": "19046000",
    "check_number": null,
    "counterparties": [
      {
        "name": "Walmart",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
        "website": "walmart.com",
        "entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-24",
    "datetime": "2023-09-24T11:01:01Z",
    "authorized_date": "2023-09-22",
    "authorized_datetime": "2023-09-22T10:34:50Z",
    "location": {
      "address": "13425 Community Rd",
      "city": "Poway",
      "region": "CA",
      "postal_code": "92064",
      "country": "US",
      "lat": 32.959068,
      "lon": -117.037666,
      "store_number": "1700"
    },
    "name": "PURCHASE WM SUPERCENTER #1700",
    "merchant_name": "Walmart",
    "merchant_entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
    "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
    "website": "walmart.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "in store",
    "pending": false,
    "pending_transaction_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
    "personal_finance_category": {
      "primary": "GENERAL_MERCHANDISE",
      "detailed": "GENERAL_MERCHANDISE_SUPERSTORES",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_GENERAL_MERCHANDISE.png",
    "transaction_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
    "transaction_code": null,
    "transaction_type": "place"
  }
],
"modified": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 28.34,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Food and Drink",
      "Restaurants",
      "Fast Food"
    ],
    "category_id": "13005032",
    "check_number": null,
    "counterparties": [
      {
        "name": "DoorDash",
        "type": "marketplace",
        "logo_url": "https://plaid-counterparty-logos.plaid.com/doordash_1.png",
        "website": "doordash.com",
        "entity_id": "YNRJg5o2djJLv52nBA1Yn1KpL858egYVo4dpm",
        "confidence_level": "HIGH"
      },
      {
        "name": "Burger King",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
        "website": "burgerking.com",
        "entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-28",
    "datetime": "2023-09-28T15:10:09Z",
    "authorized_date": "2023-09-27",
    "authorized_datetime": "2023-09-27T08:01:58Z",
    "location": {
      "address": null,
      "city": null,
      "region": null,
      "postal_code": null,
      "country": null,
      "lat": null,
      "lon": null,
      "store_number": null
    },
    "name": "Dd Doordash Burgerkin",
    "merchant_name": "Burger King",
    "merchant_entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
    "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
    "website": "burgerking.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "online",
    "pending": true,
    "pending_transaction_id": null,
    "personal_finance_category": {
      "primary": "FOOD_AND_DRINK",
      "detailed": "FOOD_AND_DRINK_FAST_FOOD",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_FOOD_AND_DRINK.png",
    "transaction_id": "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
    "transaction_code": null,
    "transaction_type": "digital"
  }
],
"removed": [
  {
    "transaction_id": "CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l"
  }
],
"next_cursor": "tVUUL15lYQN5rBnfDIc1I8xudpGdIlw9nsgeXWvhOfkECvUeR663i3Dt1uf/94S8ASkitgLcIiOSqNwzzp+bh89kirazha5vuZHBb2ZA5NtCDkkV",
"has_more": false,
"request_id": "Wvhy9PZHQLV8njG"
151}

Was this helpful?

`/transactions/get`

Get transaction data

Note: All new implementations are encouraged to use /transactions/sync rather than /transactions/get. /transactions/sync provides the same functionality as /transactions/get and improves developer ease-of-use for handling transactions updates.
The /transactions/get endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). For transaction history from investments accounts, use the Investments endpoint instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in /transactions/get. For more details, see Pending and posted transactions.
Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_transactions response body field to fetch all available transactions.
Data returned by /transactions/get will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's status.transactions.last_successful_update field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the /transactions/refresh endpoint.
Note that data may not be immediately available to /transactions/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with transactions, or upon the first call to /transactions/get, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the INITIAL_UPDATE and HISTORICAL_UPDATE webhooks. If no transaction history is ready when /transactions/get is called, it will return a PRODUCT_NOT_READY error.

transactions/get

Request fields and example

include_original_description

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

options

object

An optional object to be used with the request. If specified, options must not be null.

account_ids

[string]

A list of account_ids to retrieve for the Item
Note: An error will be returned if a provided account_id is not associated with the Item.

count

integer

The number of transactions to fetch.

Default: 100

Minimum: 1

Maximum: 500

Exclusive min: false

offset

integer

The number of transactions to skip. The default value is 0.

Default: 0

Minimum: 0

boolean

Include the raw unparsed transaction description from the financial institution.

Default: false

days_requested

integer

Minimum: 1

Maximum: 730

Default: 90

requiredstring

The access token associated with the Item data is being requested for.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

start_date

requiredstring

The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

Format: date

end_date

requiredstring

The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

Format: date

Select group for content switcher

/transactions/get
Select Language
1const request: TransactionsGetRequest = {
access_token: accessToken,
start_date: '2018-01-01',
end_date: '2020-02-01'
5};
6try {
const response = await client.transactionsGet(request);
let transactions = response.data.transactions;
const total_transactions = response.data.total_transactions;
// Manipulate the offset parameter to paginate
// transactions and retrieve all available data
while (transactions.length < total_transactions) {
  const paginatedRequest: TransactionsGetRequest = {
    access_token: accessToken,
    start_date: '2018-01-01',
    end_date: '2020-02-01',
    options: {
      offset: transactions.length
    },
  };
  const paginatedResponse = await client.transactionsGet(paginatedRequest);
  transactions = transactions.concat(
    paginatedResponse.data.transactions,
  );
}
26} catch((err) => {
// handle error
28}

transactions/get

Response fields and example

accounts

[object]

An array containing the accounts associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the account_id field.

string

Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the account_id is case sensitive.

balances

object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

available

nullablenumber

The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
If current is null this field is guaranteed not to be null.

Format: double

current

nullablenumber

The total amount of funds in or owed by the account.
For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

Format: double

limit

nullablenumber

For credit-type accounts, this represents the credit limit.
For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for credit-type accounts.

Format: double

nullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

nullablestring

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_codes.

last_updated_datetime

nullablestring

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.
This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.
If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

Format: date-time

mask

nullablestring

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

name

string

The name of the account, either assigned by the user or by the financial institution itself

official_name

nullablestring

The official name of the account as given by the financial institution

type

string

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other

subtype

nullablestring

See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

verification_status

string

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
automatically_verified: The Item has successfully been automatically verified
manually_verified: The Item has successfully been manually verified
verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.
database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.
database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail

persistent_account_id

string

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently only supported for Chase Items. Because Chase accounts have a different account number each time they are linked, this field may be instead of the account number to uniquely identify a Chase account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud.

transactions

[object]

An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the count parameter.

string

The ID of the account in which this transaction occurred.

number

Format: double

nullablestring

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

nullablestring

deprecatednullable[string]

deprecatednullablestring

check_number

nullablestring

The check number of the transaction. This field is only populated for check transactions.

date

string

Format: date

location

object

A representation of where a transaction took place

address

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

region

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

postal_code

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

country

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

name

string

nullablestring

original_description

nullablestring

payment_meta

object

reference_number

nullablestring

The transaction reference number supplied by the financial institution.

ppd_id

nullablestring

The ACH PPD ID for the payer.

payee

nullablestring

For transfers, the party that is receiving the transaction.

by_order_of

nullablestring

The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.

payer

nullablestring

For transfers, the party that is paying the transaction.

payment_method

nullablestring

The type of transfer, e.g. 'ACH'

payment_processor

nullablestring

The name of the payment processor

reason

nullablestring

The payer-supplied description of the transfer.

pending

boolean

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

pending_transaction_id

nullablestring

The ID of a posted transaction's associated pending transaction, where applicable.

account_owner

nullablestring

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

string

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

transaction_type

deprecatedstring

Possible values: digital, place, special, unresolved

nullablestring

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

The website associated with this transaction, if available.

authorized_date

nullablestring

Format: date

authorized_datetime

nullablestring

Format: date-time

datetime

nullablestring

Format: date-time

payment_channel

string

Possible values: online, in store, other

nullableobject

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

personal_finance_category_icon_url

nullablestring

transaction_code

nullablestring

Possible values: adjustment, atm, bank charge, bill payment, cash, cashback, cheque, direct debit, interest, purchase, standing order, transfer, null

string

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

counterparties

[object]

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

name

string

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

entity_id

nullablestring

A unique, stable, Plaid-generated ID that maps to the counterparty.

type

string

Possible values: merchant, financial_institution, payment_app, marketplace, payment_terminal, income_source

nullablestring

The website associated with the counterparty.

nullablestring

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.

nullablestring

merchant_entity_id

nullablestring

total_transactions

integer

The total number of transactions available within the date range specified. If total_transactions is larger than the size of the transactions array, more transactions are available and can be fetched via manipulating the offset parameter.

item

object

Metadata about the Item.

string

The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.

institution_id

nullablestring

The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.

webhook

nullablestring

The URL registered to receive webhooks for the Item.

nullableobject

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

string

A broad categorization of the error. Safe for programmatic use.

Possible values: INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR

string

The particular error code. Safe for programmatic use.

string

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

nullablestring

A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.

string

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

array

In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.
causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.

nullableinteger

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

string

The URL of a Plaid documentation page with more information about the error

consent_expiration_time

nullablestring

Suggested steps for resolving the error

available_products

[string]

A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with billed_products.

Possible values: assets, auth, balance, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity

billed_products

[string]

A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.

products

[string]

A list of products added to the Item. In almost all cases, this will be the same as the billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products.

consented_products

[string]

A list of products that have gone through consent collection for the Item. Only present for those enabled in the Data Transparency beta. If you are not enrolled in Data Transparency, this field is not used.

nullablestring

The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the ITEM_LOGIN_REQUIRED error state. To circumvent the ITEM_LOGIN_REQUIRED error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.
Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.

Format: date-time

update_type

string

Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
background - Item can be updated in the background
user_present_required - Item requires user interaction to be updated

Possible values: background, user_present_required

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"accounts": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "balances": {
      "available": 110.94,
      "current": 110.94,
      "iso_currency_code": "USD",
      "limit": null,
      "unofficial_currency_code": null
    },
    "mask": "0000",
    "name": "Plaid Checking",
    "official_name": "Plaid Gold Standard 0% Interest Checking",
    "subtype": "checking",
    "type": "depository"
  }
],
"transactions": [
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 28.34,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Food and Drink",
      "Restaurants",
      "Fast Food"
    ],
    "category_id": "13005032",
    "check_number": null,
    "counterparties": [
      {
        "name": "DoorDash",
        "type": "marketplace",
        "logo_url": "https://plaid-counterparty-logos.plaid.com/doordash_1.png",
        "website": "doordash.com",
        "entity_id": "YNRJg5o2djJLv52nBA1Yn1KpL858egYVo4dpm",
        "confidence_level": "HIGH"
      },
      {
        "name": "Burger King",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
        "website": "burgerking.com",
        "entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-28",
    "datetime": "2023-09-28T15:10:09Z",
    "authorized_date": "2023-09-27",
    "authorized_datetime": "2023-09-27T08:01:58Z",
    "location": {
      "address": null,
      "city": null,
      "region": null,
      "postal_code": null,
      "country": null,
      "lat": null,
      "lon": null,
      "store_number": null
    },
    "name": "Dd Doordash Burgerkin",
    "merchant_name": "Burger King",
    "merchant_entity_id": "mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1",
    "logo_url": "https://plaid-merchant-logos.plaid.com/burger_king_155.png",
    "website": "burgerking.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "online",
    "pending": true,
    "pending_transaction_id": null,
    "personal_finance_category": {
      "primary": "FOOD_AND_DRINK",
      "detailed": "FOOD_AND_DRINK_FAST_FOOD",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_FOOD_AND_DRINK.png",
    "transaction_id": "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
    "transaction_code": null,
    "transaction_type": "digital"
  },
  {
    "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
    "account_owner": null,
    "amount": 72.1,
    "iso_currency_code": "USD",
    "unofficial_currency_code": null,
    "category": [
      "Shops",
      "Supermarkets and Groceries"
    ],
    "category_id": "19046000",
    "check_number": null,
    "counterparties": [
      {
        "name": "Walmart",
        "type": "merchant",
        "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
        "website": "walmart.com",
        "entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
        "confidence_level": "VERY_HIGH"
      }
    ],
    "date": "2023-09-24",
    "datetime": "2023-09-24T11:01:01Z",
    "authorized_date": "2023-09-22",
    "authorized_datetime": "2023-09-22T10:34:50Z",
    "location": {
      "address": "13425 Community Rd",
      "city": "Poway",
      "region": "CA",
      "postal_code": "92064",
      "country": "US",
      "lat": 32.959068,
      "lon": -117.037666,
      "store_number": "1700"
    },
    "name": "PURCHASE WM SUPERCENTER #1700",
    "merchant_name": "Walmart",
    "merchant_entity_id": "O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM",
    "logo_url": "https://plaid-merchant-logos.plaid.com/walmart_1100.png",
    "website": "walmart.com",
    "payment_meta": {
      "by_order_of": null,
      "payee": null,
      "payer": null,
      "payment_method": null,
      "payment_processor": null,
      "ppd_id": null,
      "reason": null,
      "reference_number": null
    },
    "payment_channel": "in store",
    "pending": false,
    "pending_transaction_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
    "personal_finance_category": {
      "primary": "GENERAL_MERCHANDISE",
      "detailed": "GENERAL_MERCHANDISE_SUPERSTORES",
      "confidence_level": "VERY_HIGH"
    },
    "personal_finance_category_icon_url": "https://plaid-category-icons.plaid.com/PFC_GENERAL_MERCHANDISE.png",
    "transaction_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
    "transaction_code": null,
    "transaction_type": "place"
  }
],
"item": {
  "available_products": [
    "balance",
    "identity",
    "investments"
  ],
  "billed_products": [
    "assets",
    "auth",
    "liabilities",
    "transactions"
  ],
  "consent_expiration_time": null,
  "error": null,
  "institution_id": "ins_3",
  "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",
  "update_type": "background",
  "webhook": "https://www.genericwebhookurl.com/webhook"
},
"total_transactions": 1,
"request_id": "45QSn"
179}

Was this helpful?

`/transactions/recurring/get`

Fetch recurring transaction streams

The /transactions/recurring/get endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.
This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create; or after Link, by calling /transactions/get or /transactions/sync). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the days_requested option). Once all historical transactions have been fetched, call /transactions/recurring/get to receive the Recurring Transactions streams and subscribe to the RECURRING_TRANSACTIONS_UPDATE webhook. To know when historical transactions have been fetched, if you are using /transactions/sync listen for the SYNC_UPDATES_AVAILABLE webhook and check that the historical_update_complete field in the payload is true. If using /transactions/get, listen for the HISTORICAL_UPDATE webhook.
After the initial call, you can call /transactions/recurring/get endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the RECURRING_TRANSACTIONS_UPDATE webhook to be notified when new updates are available.

transactions/recurring/get

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The access token associated with the Item data is being requested for.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

account_ids

[string]

An optional list of account_ids to retrieve for the Item. Retrieves all active accounts on item if no account_ids are provided.
Note: An error will be returned if a provided account_id is not associated with the Item.

/transactions/recurring/get
Select Language
1const request: TransactionsGetRequest = {
2  access_token: accessToken,
3  account_ids : accountIds
4};
5try {
6  const response = await client.transactionsRecurringGet(request);
7  let inflowStreams = response.data.inflowStreams;
8  let outflowStreams = response.data.outflowStreams;
9  }
10} catch((err) => {
11  // handle error
12}

transactions/recurring/get

Response fields and example

inflow_streams

[object]

An array of depository transaction streams.

string

The ID of the account to which the stream belongs

stream_id

string

A unique id for the stream

deprecated[string]

A hierarchical array of the categories to which this transaction belongs. See Categories.
All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

deprecatedstring

The ID of the category to which this transaction belongs. See Categories.
All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

description

string

A description of the transaction stream.

nullablestring

The merchant associated with the transaction stream.

first_date

string

The posted date of the earliest transaction in the stream.

Format: date

last_date

string

The posted date of the latest transaction in the stream.

Format: date

frequency

string

Describes the frequency of the transaction stream.
WEEKLY: Assigned to a transaction stream that occurs approximately every week.
BIWEEKLY: Assigned to a transaction stream that occurs approximately every 2 weeks.
SEMI_MONTHLY: Assigned to a transaction stream that occurs approximately twice per month. This frequency is typically seen for inflow transaction streams.
MONTHLY: Assigned to a transaction stream that occurs approximately every month.
ANNUALLY: Assigned to a transaction stream that occurs approximately every year.
UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

Possible values: UNKNOWN, WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY, ANNUALLY

transaction_ids

[string]

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

average_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

The unofficial currency code of the amount. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

last_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

is_active

boolean

Indicates whether the transaction stream is still live.

string

The current status of the transaction stream.
MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence (For Annual recurring stream, we will mark it MATURE after 2 instances).
EARLY_DETECTION: When a recurring transaction first appears in the transaction history and before it fulfills the requirement of a mature stream, the status will be EARLY_DETECTION.
TOMBSTONED: A stream that was previously in the EARLY_DETECTION status will move to the TOMBSTONED status when no further transactions were found at the next expected date.
UNKNOWN: A stream is assigned an UNKNOWN status when none of the other statuses are applicable.

Possible values: UNKNOWN, MATURE, EARLY_DETECTION, TOMBSTONED

nullableobject

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

last_user_modified_datetime

nullablestring

is_user_modified

boolean

This will be set to true if the stream has been modified by request to a /transactions/recurring/streams endpoint. It will be false for all other streams.

string

The date and time of the most recent user modification. This will only be set if is_user_modified is true.

Format: date-time

outflow_streams

[object]

An array of expense transaction streams.

string

The ID of the account to which the stream belongs

stream_id

string

A unique id for the stream

deprecated[string]

deprecatedstring

description

string

A description of the transaction stream.

nullablestring

The merchant associated with the transaction stream.

first_date

string

The posted date of the earliest transaction in the stream.

Format: date

last_date

string

The posted date of the latest transaction in the stream.

Format: date

frequency

string

Possible values: UNKNOWN, WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY, ANNUALLY

transaction_ids

[string]

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

average_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

last_amount

object

Object with data pertaining to an amount on the transaction stream.

number

Represents the numerical value of an amount.

Format: double

nullablestring

The ISO-4217 currency code of the amount. Always null if unofficial_currency_code is non-null.
See the currency code schema for a full listing of supported iso_currency_codes.

nullablestring

is_active

boolean

Indicates whether the transaction stream is still live.

string

Possible values: UNKNOWN, MATURE, EARLY_DETECTION, TOMBSTONED

nullableobject

string

A high level category that communicates the broad category of the transaction.

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

last_user_modified_datetime

nullablestring

is_user_modified

boolean

This will be set to true if the stream has been modified by request to a /transactions/recurring/streams endpoint. It will be false for all other streams.

string

The date and time of the most recent user modification. This will only be set if is_user_modified is true.

Format: date-time

updated_datetime

string

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time transaction streams for the given account were updated on

Format: date-time

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"updated_datetime": "2022-05-01T00:00:00Z",
"inflow_streams": [
  {
    "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
    "stream_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
    "category": [
      "Transfer",
      "Payroll"
    ],
    "category_id": "21009000",
    "description": "Platypus Payroll",
    "merchant_name": null,
    "personal_finance_category": {
      "primary": "INCOME",
      "detailed": "INCOME_WAGES",
      "confidence_level": "UNKNOWN"
    },
    "first_date": "2022-02-28",
    "last_date": "2022-04-30",
    "frequency": "SEMI_MONTHLY",
    "transaction_ids": [
      "nkeaNrDGrhdo6c4qZWDA8ekuIPuJ4Avg5nKfw",
      "EfC5ekksdy30KuNzad2tQupW8WIPwvjXGbGHL",
      "ozfvj3FFgp6frbXKJGitsDzck5eWQH7zOJBYd",
      "QvdDE8AqVWo3bkBZ7WvCd7LskxVix8Q74iMoK",
      "uQozFPfMzibBouS9h9tz4CsyvFll17jKLdPAF"
    ],
    "average_amount": {
      "amount": -800,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "last_amount": {
      "amount": -1000,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "is_active": true,
    "status": "MATURE",
    "is_user_modified": true,
    "last_user_modified_datetime": "2023-01-19T10:34:50Z"
  }
],
"outflow_streams": [
  {
    "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDff",
    "stream_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nd",
    "category": [
      "Service",
      "Utilities",
      "Electric"
    ],
    "category_id": "18068005",
    "description": "ConEd Bill Payment",
    "merchant_name": "ConEd",
    "personal_finance_category": {
      "primary": "RENT_AND_UTILITIES",
      "detailed": "RENT_AND_UTILITIES_GAS_AND_ELECTRICITY",
      "confidence_level": "UNKNOWN"
    },
    "first_date": "2022-02-04",
    "last_date": "2022-05-02",
    "frequency": "MONTHLY",
    "transaction_ids": [
      "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
      "HPDnUVgI5Pa0YQSl0rxwYRwVXeLyJXTWDAvpR",
      "jEPoSfF8xzMClE9Ohj1he91QnvYoSdwg7IT8L",
      "CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l"
    ],
    "average_amount": {
      "amount": 85,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "last_amount": {
      "amount": 100,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "is_active": true,
    "status": "MATURE",
    "is_user_modified": false
  },
  {
    "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDff",
    "stream_id": "SrBNJZDuUMweodmPmSOeOImwsWt53ZXfJQAfC",
    "category": [
      "Shops",
      "Warehouses and Wholesale Stores"
    ],
    "category_id": "19051000",
    "description": "Costco Annual Membership",
    "merchant_name": "Costco",
    "personal_finance_category": {
      "primary": "GENERAL_MERCHANDISE",
      "detailed": "GENERAL_MERCHANDISE_SUPERSTORES",
      "confidence_level": "UNKNOWN"
    },
    "first_date": "2022-01-23",
    "last_date": "2023-01-22",
    "frequency": "ANNUALLY",
    "transaction_ids": [
      "yqEBJ72cS4jFwcpxJcDuQr94oAQ1R1lMC33D4",
      "Kz5Hm3cZCgpn4tMEKUGAGD6kAcxMBsEZDSwJJ"
    ],
    "average_amount": {
      "amount": 120,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "last_amount": {
      "amount": 120,
      "iso_currency_code": "USD",
      "unofficial_currency_code": null
    },
    "is_active": true,
    "status": "MATURE",
    "is_user_modified": true,
    "last_user_modified_datetime": "2023-01-19T10:34:50Z"
  }
],
"request_id": "tbFyCEqkU775ZGG"
124}

Was this helpful?

`/transactions/refresh`

Refresh transaction data

/transactions/refresh is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call /transactions/refresh.
If changes to transactions are discovered after calling /transactions/refresh, Plaid will fire a webhook: for /transactions/sync users, SYNC_UPDATES_AVAILABLE will be fired if there are any transactions updated, added, or removed. For users of both /transactions/sync and /transactions/get, TRANSACTIONS_REMOVED will be fired if any removed transactions are detected, and DEFAULT_UPDATE will be fired if any new transactions are detected. New transactions can be fetched by calling /transactions/get or /transactions/sync.
Note that the /transactions/refresh endpoint is not supported for Capital One (ins_128026) and will result in a PRODUCTS_NOT_SUPPORTED error if called on an Item from that institution.
As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
/transactions/refresh is offered as an optional add-on to Transactions and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.

transactions/refresh

Request fields and example

string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

requiredstring

The access token associated with the Item data is being requested for.

string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Select group for content switcher

/transactions/refresh
Select Language
1const request: TransactionsRefreshRequest = {
2  access_token: accessToken,
3};
4try {
5  await plaidClient.transactionsRefresh(request);
6} catch (error) {
7  // handle error
8}

transactions/refresh

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "1vwmF5TBQwiqfwP"
3}

Was this helpful?

`/categories/get`

Get categories

Send a request to the /categories/get endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
All implementations are recommended to use the newer personal_finance_category taxonomy instead of the older category taxonomy supported by this endpoint. The personal_finance_category taxonomy CSV file is available for download and is not accessible via API.

categories/get

Request fields and example

This endpoint takes an empty request body.

Select group for content switcher

/categories/get
Select Language
1try {
2  const response = await plaidClient.categoriesGet({});
3  const categories = response.data.categories;
4} catch (error) {
5  // handle error
6}

categories/get

Response fields and example

categories

[object]

An array of all of the transaction categories used by Plaid.

string

An identifying number for the category. category_id is a Plaid-specific identifier and does not necessarily correspond to merchant category codes.

group

string

place for physical transactions or special for other transactions such as bank charges.

hierarchy

[string]

A hierarchical array of the categories to which this category_id belongs.

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
"categories": [
  {
    "category_id": "10000000",
    "group": "special",
    "hierarchy": [
      "Bank Fees"
    ]
  },
  {
    "category_id": "10001000",
    "group": "special",
    "hierarchy": [
      "Bank Fees",
      "Overdraft"
    ]
  },
  {
    "category_id": "12001000",
    "group": "place",
    "hierarchy": [
      "Community",
      "Animal Shelter"
    ]
  }
],
"request_id": "ixTBLZGvhD4NnmB"
28}

Was this helpful?

Webhooks

You can receive notifications via a webhook whenever there are new transactions associated with an Item, including when Plaid’s initial and historical transaction pull are completed. All webhooks related to transactions have a webhook_type of TRANSACTIONS.

transactions/refresh

Response fields and example

string

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

API Object
1{
2  "request_id": "1vwmF5TBQwiqfwP"
3}

Was this helpful?

`SYNC_UPDATES_AVAILABLE`

Fired when an Item's transactions change. This can be due to any event resulting in new changes, such as an initial 30-day transactions fetch upon the initialization of an Item with transactions, the backfill of historical transactions that occurs shortly after, or when changes are populated from a regularly-scheduled transactions update job. It is recommended to listen for the SYNC_UPDATES_AVAILABLE webhook when using the /transactions/sync endpoint. Note that when using /transactions/sync the older webhooks INITIAL_UPDATE, HISTORICAL_UPDATE, DEFAULT_UPDATE, and TRANSACTIONS_REMOVED, which are intended for use with /transactions/get, will also continue to be sent in order to maintain backwards compatibility. It is not necessary to listen for and respond to those webhooks when using /transactions/sync.
After receipt of this webhook, the new changes can be fetched for the Item from /transactions/sync.
Note that to receive this webhook for an Item, /transactions/sync must have been called at least once on that Item. This means that, unlike the INITIAL_UPDATE and HISTORICAL_UPDATE webhooks, it will not fire immediately upon Item creation. If /transactions/sync is called on an Item that was not initialized with Transactions, the webhook will fire twice: once the first 30 days of transactions data has been fetched, and a second time when all available historical transactions data has been fetched.
This webhook will fire in the Sandbox environment as it would in Production. It can also be manually triggered in Sandbox by calling /sandbox/item/fire_webhook.

string

TRANSACTIONS

string

SYNC_UPDATES_AVAILABLE

initial_update_complete

string

The item_id of the Item associated with this webhook, warning, or error

boolean

Indicates if initial pull information (most recent 30 days of transaction history) is available.

historical_update_complete

boolean

Indicates if historical pull information (maximum transaction history requested, up to 2 years) is available.

string

The Plaid environment the webhook was sent from

Possible values: development, sandbox, production

API Object
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "SYNC_UPDATES_AVAILABLE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "initial_update_complete": true,
6  "historical_update_complete": false,
7  "environment": "production"
8}

Was this helpful?

`RECURRING_TRANSACTIONS_UPDATE`

Fired when recurring transactions data is updated. This includes when a new recurring stream is detected or when a new transaction is added to an existing recurring stream. The RECURRING_TRANSACTIONS_UPDATE webhook will also fire when one or more attributes of the recurring stream changes, which is usually a result of the addition, update, or removal of transactions to the stream.
After receipt of this webhook, the updated data can be fetched from /transactions/recurring/get.

string

TRANSACTIONS

string

RECURRING_TRANSACTIONS_UPDATE

string

The item_id of the Item associated with this webhook, warning, or error

account_ids

[string]

A list of account_ids for accounts that have new or updated recurring transactions data.

string

The Plaid environment the webhook was sent from

Possible values: development, sandbox, production

API Object
1{
"webhook_type": "TRANSACTIONS",
"webhook_code": "RECURRING_TRANSACTIONS_UPDATE",
"item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
"account_ids": [
  "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
  "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDff"
],
"environment": "production"
10}

Was this helpful?

`INITIAL_UPDATE`

Fired when an Item's initial transaction pull is completed. Once this webhook has been fired, transaction data for the most recent 30 days can be fetched for the Item. If Account Select v2 is enabled, this webhook will also be fired if account selections for the Item are updated, with new_transactions set to the number of net new transactions pulled after the account selection update.
This webhook is intended for use with /transactions/get; if you are using the newer /transactions/sync endpoint, this webhook will still be fired to maintain backwards compatibility, but it is recommended to listen for and respond to the SYNC_UPDATES_AVAILABLE webhook instead.

string

TRANSACTIONS

string

INITIAL_UPDATE

string

The error code associated with the webhook.

new_transactions

number

The number of new, unfetched transactions available.

string

The item_id of the Item associated with this webhook, warning, or error

string

The Plaid environment the webhook was sent from

Possible values: development, sandbox, production

API Object
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "INITIAL_UPDATE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "error": null,
6  "new_transactions": 19,
7  "environment": "production"
8}

Was this helpful?

`HISTORICAL_UPDATE`

Fired when an Item's historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item. Once this webhook has been fired, transaction data beyond the most recent 30 days can be fetched for the Item. If Account Select v2 is enabled, this webhook will also be fired if account selections for the Item are updated, with new_transactions set to the number of net new transactions pulled after the account selection update.
This webhook is intended for use with /transactions/get; if you are using the newer /transactions/sync endpoint, this webhook will still be fired to maintain backwards compatibility, but it is recommended to listen for and respond to the SYNC_UPDATES_AVAILABLE webhook instead.

string

TRANSACTIONS

string

HISTORICAL_UPDATE

object

string

A broad categorization of the error. Safe for programmatic use.

string

The particular error code. Safe for programmatic use.

string

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

string

A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.

string

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

array

integer

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

string

The URL of a Plaid documentation page with more information about the error

string

Suggested steps for resolving the error

new_transactions

number

The number of new, unfetched transactions available

string

The item_id of the Item associated with this webhook, warning, or error

string

The Plaid environment the webhook was sent from

Possible values: development, sandbox, production

API Object
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "HISTORICAL_UPDATE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "error": null,
6  "new_transactions": 231,
7  "environment": "production"
8}

Was this helpful?

`DEFAULT_UPDATE`

Fired when new transaction data is available for an Item. Plaid will typically check for new transaction data several times a day.
This webhook is intended for use with /transactions/get; if you are using the newer /transactions/sync endpoint, this webhook will still be fired to maintain backwards compatibility, but it is recommended to listen for and respond to the SYNC_UPDATES_AVAILABLE webhook instead.

string

TRANSACTIONS

string

DEFAULT_UPDATE

object

string

A broad categorization of the error. Safe for programmatic use.

string

The particular error code. Safe for programmatic use.

string

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

string

A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.

string

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

array

integer

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

string

The URL of a Plaid documentation page with more information about the error

string

Suggested steps for resolving the error

new_transactions

number

The number of new transactions detected since the last time this webhook was fired.

string

The item_id of the Item the webhook relates to.

string

The Plaid environment the webhook was sent from

Possible values: development, sandbox, production

API Object
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "DEFAULT_UPDATE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "error": null,
6  "new_transactions": 3,
7  "environment": "production"
8}

Was this helpful?

`TRANSACTIONS_REMOVED`

Fired when transaction(s) for an Item are deleted. The deleted transaction IDs are included in the webhook payload. Plaid will typically check for deleted transaction data several times a day.
This webhook is intended for use with /transactions/get; if you are using the newer /transactions/sync endpoint, this webhook will still be fired to maintain backwards compatibility, but it is recommended to listen for and respond to the SYNC_UPDATES_AVAILABLE webhook instead.

string

TRANSACTIONS

string

TRANSACTIONS_REMOVED

object

string

A broad categorization of the error. Safe for programmatic use.

string

The particular error code. Safe for programmatic use.

string

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

string

A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.

string

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

array

integer

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

string

The URL of a Plaid documentation page with more information about the error

string

Suggested steps for resolving the error

removed_transactions

[string]

An array of transaction_ids corresponding to the removed transactions

string

The item_id of the Item associated with this webhook, warning, or error