Transactions

API reference for Transactions endpoints and webhooks

Retrieve and refresh 24 months of historical transaction data, including geolocation, merchant, and category information.

Endpoints
/transactions/syncGet transaction data or incremental transaction updates
/transactions/getFetch transaction data
/transactions/recurring/getFetch recurring transaction data
/transactions/refreshRefresh transaction data
/categories/getFetch all transaction categories
Webhooks
SYNC_UPDATES_AVAILABLENew updates available
INITIAL_UPDATEInitial transactions ready
HISTORICAL_UPDATEHistorical transactions ready
DEFAULT_UPDATENew transactions available
TRANSACTIONS_REMOVEDDeleted transactions detected

Endpoints

/transactions/sync

Get incremental transaction updates on an Item

This endpoint replaces /transactions/get and its associated webhooks for most common use-cases.
The /transactions/sync endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. /transactions/sync provides the same functionality as /transactions/get and can be used instead of /transactions/get to simplify the process of tracking transactions updates.
This endpoint provides 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 /investments/transactions/get instead.
Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API.
In the first call to /transactions/sync for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as "adds"), which then generates a latest_cursor for that Item. In subsequent calls, send the latest_cursor to receive only the changes that have occurred since the previous call.
Due to the potentially large number of transactions associated with an Item, results are paginated. The has_more field specifies if additional calls are necessary to fetch all available transaction updates.
Whenever new or updated transaction data becomes available, /transactions/sync will provide these updates. 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, use the /transactions/refresh endpoint.
Note that for newly created Items, data may not be immediately available to /transactions/sync. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.
To be alerted when new data is available, listen for the SYNC_UPDATES_AVAILABLE webhook.

transactions/sync

Request fields and example

client_id
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.
access_token
requiredstring
The access token associated with the Item data is being requested for.
secret
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. Note: 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.
include_original_description
boolean
Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.

Default: false
include_personal_finance_category
boolean
Include the personal_finance_category object in the response.
See the taxonomy csv file for a full list of personal finance categories.

Default: false 
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.
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
pending_transaction_id
nullable string
The ID of a posted transaction's associated pending transaction, where applicable.
category_id
nullable string
The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
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.
category
nullable [string]
A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
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.
location
object
A representation of where a transaction took place
address
nullable string
The street address where the transaction occurred.
city
nullable string
The city where the transaction occurred.
region
nullable string
The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.
postal_code
nullable string
The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.
country
nullable string
The ISO 3166-1 alpha-2 country code where the transaction occurred.
lat
nullable number
The latitude where the transaction occurred.

Format: double
lon
nullable number
The longitude where the transaction occurred.

Format: double
store_number
nullable string
The merchant defined store number where the transaction occurred.
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/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
nullable string
The transaction reference number supplied by the financial institution.
ppd_id
nullable string
The ACH PPD ID for the payer.
payee
nullable string
For transfers, the party that is receiving the transaction.
by_order_of
nullable string
The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.
payer
nullable string
For transfers, the party that is paying the transaction.
payment_method
nullable string
The type of transfer, e.g. 'ACH'
payment_processor
nullable string
The name of the payment processor
reason
nullable string
The payer-supplied description of the transfer.
account_owner
nullable string
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
name
string
The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /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.
original_description
nullable string
The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/get, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set options.include_original_description to true.
account_id
string
The ID of the account in which this transaction occurred.
amount
number
The settled value of the transaction, denominated in the account'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
iso_currency_code
nullable string
The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
nullable string
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.
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 ).

Format: date
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.
transaction_id
string
The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.
merchant_name
nullable string
The merchant name, as extracted by Plaid from the name field.
check_number
nullable string
The check number of the transaction. This field is only populated for check transactions.
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
authorized_date
nullable string
The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ). The authorized_date field uses machine learning to determine a transaction date for transactions where the date_transacted is not available. If the date_transacted field is present and not null, the authorized_date field will have the same value as the date_transacted field.

Format: date
authorized_datetime
nullable string
Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ).
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).

Format: date-time
datetime
nullable string
Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ).
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).

Format: date-time
transaction_code
nullable string
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
personal_finance_category
nullable object
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.
primary
string
A high level category that communicates the broad category of the transaction.
detailed
string
A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.
modified
[object]
Transactions that have been modified on the item since cursor ordered by ascending last modified time.
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
pending_transaction_id
nullable string
The ID of a posted transaction's associated pending transaction, where applicable.
category_id
nullable string
The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
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.
category
nullable [string]
A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
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.
location
object
A representation of where a transaction took place
address
nullable string
The street address where the transaction occurred.
city
nullable string
The city where the transaction occurred.
region
nullable string
The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.
postal_code
nullable string
The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.
country
nullable string
The ISO 3166-1 alpha-2 country code where the transaction occurred.
lat
nullable number
The latitude where the transaction occurred.

Format: double
lon
nullable number
The longitude where the transaction occurred.

Format: double
store_number
nullable string
The merchant defined store number where the transaction occurred.
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/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
nullable string
The transaction reference number supplied by the financial institution.
ppd_id
nullable string
The ACH PPD ID for the payer.
payee
nullable string
For transfers, the party that is receiving the transaction.
by_order_of
nullable string
The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.
payer
nullable string
For transfers, the party that is paying the transaction.
payment_method
nullable string
The type of transfer, e.g. 'ACH'
payment_processor
nullable string
The name of the payment processor
reason
nullable string
The payer-supplied description of the transfer.
account_owner
nullable string
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
name
string
The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /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.
original_description
nullable string
The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/get, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set options.include_original_description to true.
account_id
string
The ID of the account in which this transaction occurred.
amount
number
The settled value of the transaction, denominated in the account'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
iso_currency_code
nullable string
The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
nullable string
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.
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 ).

Format: date
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.
transaction_id
string
The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.
merchant_name
nullable string
The merchant name, as extracted by Plaid from the name field.
check_number
nullable string
The check number of the transaction. This field is only populated for check transactions.
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
authorized_date
nullable string
The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ). The authorized_date field uses machine learning to determine a transaction date for transactions where the date_transacted is not available. If the date_transacted field is present and not null, the authorized_date field will have the same value as the date_transacted field.

Format: date
authorized_datetime
nullable string
Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ).
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).

Format: date-time
datetime
nullable string
Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ).
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).

Format: date-time
transaction_code
nullable string
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
personal_finance_category
nullable object
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.
primary
string
A high level category that communicates the broad category of the transaction.
detailed
string
A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.
removed
[object]
Transactions that have been removed from the item since cursor ordered by ascending last modified time.
transaction_id
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.
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.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "added": [
3    {
4      "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
5      "amount": 2307.21,
6      "iso_currency_code": "USD",
7      "unofficial_currency_code": null,
8      "category": [
9        "Shops",
10        "Computers and Electronics"
11      ],
12      "category_id": "19013000",
13      "check_number": null,
14      "date": "2022-02-03",
15      "datetime": "2022-02-03T11:00:00Z",
16      "authorized_date": "2022-02-03",
17      "authorized_datetime": "2022-02-03T10:34:50Z",
18      "location": {
19        "address": "300 Post St",
20        "city": "San Francisco",
21        "region": "CA",
22        "postal_code": "94108",
23        "country": "US",
24        "lat": 40.740352,
25        "lon": -74.001761,
26        "store_number": "1235"
27      },
28      "name": "Apple Store",
29      "merchant_name": "Apple",
30      "payment_meta": {
31        "by_order_of": null,
32        "payee": null,
33        "payer": null,
34        "payment_method": null,
35        "payment_processor": null,
36        "ppd_id": null,
37        "reason": null,
38        "reference_number": null
39      },
40      "payment_channel": "in store",
41      "pending": false,
42      "pending_transaction_id": null,
43      "account_owner": null,
44      "transaction_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
45      "transaction_code": null
46    }
47  ],
48  "modified": [
49    {
50      "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
51      "amount": 98.05,
52      "iso_currency_code": "USD",
53      "unofficial_currency_code": null,
54      "category": [
55        "Service",
56        "Utilities",
57        "Electric"
58      ],
59      "category_id": "18068005",
60      "check_number": null,
61      "date": "2022-02-28",
62      "datetime": "2022-02-28T11:00:00Z",
63      "authorized_date": "2022-02-28",
64      "authorized_datetime": "2022-02-28T10:34:50Z",
65      "location": {
66        "address": null,
67        "city": null,
68        "region": null,
69        "postal_code": null,
70        "country": null,
71        "lat": null,
72        "lon": null,
73        "store_number": null
74      },
75      "name": "ConEd Bill Payment",
76      "merchant_name": "ConEd",
77      "payment_meta": {
78        "by_order_of": null,
79        "payee": null,
80        "payer": null,
81        "payment_method": null,
82        "payment_processor": null,
83        "ppd_id": null,
84        "reason": null,
85        "reference_number": null
86      },
87      "payment_channel": "online",
88      "pending": false,
89      "pending_transaction_id": null,
90      "account_owner": null,
91      "transaction_id": "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
92      "transaction_code": null
93    }
94  ],
95  "removed": [
96    {
97      "transaction_id": "CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l"
98    }
99  ],
100  "next_cursor": "tVUUL15lYQN5rBnfDIc1I8xudpGdIlw9nsgeXWvhOfkECvUeR663i3Dt1uf/94S8ASkitgLcIiOSqNwzzp+bh89kirazha5vuZHBb2ZA5NtCDkkV",
101  "has_more": false,
102  "request_id": "45QSn"
103}

/transactions/get

Get transaction data

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

client_id
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
include_original_description
boolean
Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.

Default: false
include_personal_finance_category_beta
deprecatedboolean
Please use include_personal_finance_category instead.

Default: false
include_personal_finance_category
boolean
Include the personal_finance_category object in the response.
See the taxonomy csv file for a full list of personal finance categories.
We’re introducing Category Rules - a new beta endpoint that will enable you to change the personal_finance_category for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.

Default: false
access_token
requiredstring
The access token associated with the Item data is being requested for.
secret
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
1const request: TransactionsGetRequest = {
2  access_token: accessToken,
3  start_date: '2018-01-01',
4  end_date: '2020-02-01'
5};
6try {
7  const response = await client.transactionsGet(request);
8  let transactions = response.data.transactions;
9  const total_transactions = response.data.total_transactions;
10  // Manipulate the offset parameter to paginate
11  // transactions and retrieve all available data
12  while (transactions.length < total_transactions) {
13    const paginatedRequest: TransactionsGetRequest = {
14      access_token: accessToken,
15      start_date: '2018-01-01',
16      end_date: '2020-02-01',
17      options: {
18        offset: transactions.length,
19      },
20    };
21    const paginatedResponse = await client.transactionsGet(paginatedRequest);
22    transactions = transactions.concat(
23      paginatedResponse.data.transactions,
24    );
25  }
26} catch((err) => {
27  // 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.
account_id
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
nullable number
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
nullable number
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
nullable number
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
iso_currency_code
nullable string
The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
nullable string
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
nullable string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the balance for the given account has been updated
This is currently only provided when the min_last_updated_datetime is passed when calling /accounts/balance/get for ins_128026 (Capital One).

Format: date-time
mask
nullable string
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
nullable string
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
nullable string
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, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, 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 two amounts.
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.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed
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.
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
pending_transaction_id
nullable string
The ID of a posted transaction's associated pending transaction, where applicable.
category_id
nullable string
The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.
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.
category
nullable [string]
A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.
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.
location
object
A representation of where a transaction took place
address
nullable string
The street address where the transaction occurred.
city
nullable string
The city where the transaction occurred.
region
nullable string
The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.
postal_code
nullable string
The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.
country
nullable string
The ISO 3166-1 alpha-2 country code where the transaction occurred.
lat
nullable number
The latitude where the transaction occurred.

Format: double
lon
nullable number
The longitude where the transaction occurred.

Format: double
store_number
nullable string
The merchant defined store number where the transaction occurred.
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/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
nullable string
The transaction reference number supplied by the financial institution.
ppd_id
nullable string
The ACH PPD ID for the payer.
payee
nullable string
For transfers, the party that is receiving the transaction.
by_order_of
nullable string
The party initiating a wire transfer. Will be null if the transaction is not a wire transfer.
payer
nullable string
For transfers, the party that is paying the transaction.
payment_method
nullable string
The type of transfer, e.g. 'ACH'
payment_processor
nullable string
The name of the payment processor
reason
nullable string
The payer-supplied description of the transfer.
account_owner
nullable string
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
name
string
The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /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.
original_description
nullable string
The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/get, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set options.include_original_description to true.
account_id
string
The ID of the account in which this transaction occurred.
amount
number
The settled value of the transaction, denominated in the account'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
iso_currency_code
nullable string
The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
nullable string
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.
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 ).

Format: date
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.
transaction_id
string
The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.
merchant_name
nullable string
The merchant name, as extracted by Plaid from the name field.
check_number
nullable string
The check number of the transaction. This field is only populated for check transactions.
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
authorized_date
nullable string
The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ). The authorized_date field uses machine learning to determine a transaction date for transactions where the date_transacted is not available. If the date_transacted field is present and not null, the authorized_date field will have the same value as the date_transacted field.

Format: date
authorized_datetime
nullable string
Date and time when a transaction was authorized in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ).
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).

Format: date-time
datetime
nullable string
Date and time when a transaction was posted in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ ).
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).

Format: date-time
transaction_code
nullable string
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
personal_finance_category
nullable object
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.
primary
string
A high level category that communicates the broad category of the transaction.
detailed
string
A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.
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.
item_id
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
nullable string
The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.
webhook
nullable string
The URL registered to receive webhooks for the Item.
error
nullable object
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. Error fields will be null if no error has occurred.
error_type
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
error_code
string
The particular error code. Safe for programmatic use.
error_message
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
nullable 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.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
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.
status
nullable number
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.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
nullable string
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, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
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.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
products
[string]
A list of authorized products for the Item.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
consented_products
[string]
Beta: A list of products that have gone through consent collection for the Item. Only present for those enabled in the beta.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
consent_expiration_time
nullable string
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
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "accounts": [
3    {
4      "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
5      "balances": {
6        "available": 110,
7        "current": 110,
8        "iso_currency_code": "USD",
9        "limit": null,
10        "unofficial_currency_code": null
11      },
12      "mask": "0000",
13      "name": "Plaid Checking",
14      "official_name": "Plaid Gold Standard 0% Interest Checking",
15      "subtype": "checking",
16      "type": "depository"
17    }
18  ],
19  "transactions": [
20    {
21      "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
22      "amount": 2307.21,
23      "iso_currency_code": "USD",
24      "unofficial_currency_code": null,
25      "category": [
26        "Shops",
27        "Computers and Electronics"
28      ],
29      "category_id": "19013000",
30      "check_number": null,
31      "date": "2017-01-29",
32      "datetime": "2017-01-27T11:00:00Z",
33      "authorized_date": "2017-01-27",
34      "authorized_datetime": "2017-01-27T10:34:50Z",
35      "location": {
36        "address": "300 Post St",
37        "city": "San Francisco",
38        "region": "CA",
39        "postal_code": "94108",
40        "country": "US",
41        "lat": 40.740352,
42        "lon": -74.001761,
43        "store_number": "1235"
44      },
45      "name": "Apple Store",
46      "merchant_name": "Apple",
47      "payment_meta": {
48        "by_order_of": null,
49        "payee": null,
50        "payer": null,
51        "payment_method": null,
52        "payment_processor": null,
53        "ppd_id": null,
54        "reason": null,
55        "reference_number": null
56      },
57      "payment_channel": "in store",
58      "pending": false,
59      "pending_transaction_id": null,
60      "account_owner": null,
61      "transaction_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
62      "transaction_code": null,
63      "transaction_type": "place"
64    }
65  ],
66  "item": {
67    "available_products": [
68      "balance",
69      "identity",
70      "investments"
71    ],
72    "billed_products": [
73      "assets",
74      "auth",
75      "liabilities",
76      "transactions"
77    ],
78    "consent_expiration_time": null,
79    "error": null,
80    "institution_id": "ins_3",
81    "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",
82    "update_type": "background",
83    "webhook": "https://www.genericwebhookurl.com/webhook"
84  },
85  "total_transactions": 1,
86  "request_id": "45QSn"
87}

/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 not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager.
Note that unlike /transactions/get, /transactions/recurring/get will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in /link/token/create, or after Link, by calling /transactions/get) before calling this endpoint. Data is available to /transactions/recurring/get approximately 5 seconds after the HISTORICAL_UPDATE webhook has fired (about 1-2 minutes after initialization).
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. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.

transactions/recurring/get

Request fields and example

client_id
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.
access_token
requiredstring
The access token associated with the Item data is being requested for.
secret
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.
options
object
An optional object to be used with the request. If specified, options must not be null.
include_personal_finance_category
boolean
Include the personal_finance_category object for each transaction stream in the response.
See the taxonomy csv file for a full list of personal finance categories.

Default: false
account_ids
required[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.
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.
account_id
string
The ID of the account to which the stream belongs
stream_id
string
A unique id for the stream
category_id
string
The ID of the category to which this transaction belongs. See Categories.
category
[string]
A hierarchical array of the categories to which this transaction belongs. See Categories.
description
string
A description of the transaction stream.
merchant_name
nullable string
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.
UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

Possible values: UNKNOWN, WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY
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.
amount
number
Represents the numerical value of an amount.

Format: double
iso_currency_code
nullable string
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.
unofficial_currency_code
nullable string
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.
amount
number
Represents the numerical value of an amount.

Format: double
iso_currency_code
nullable string
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.
unofficial_currency_code
nullable string
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.
is_active
boolean
Indicates whether the transaction stream is still live.
status
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.
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
personal_finance_category
nullable object
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.
primary
string
A high level category that communicates the broad category of the transaction.
detailed
string
A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.
outflow_streams
[object]
An array of expense transaction streams.
account_id
string
The ID of the account to which the stream belongs
stream_id
string
A unique id for the stream
category_id
string
The ID of the category to which this transaction belongs. See Categories.
category
[string]
A hierarchical array of the categories to which this transaction belongs. See Categories.
description
string
A description of the transaction stream.
merchant_name
nullable string
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.
UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

Possible values: UNKNOWN, WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY
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.
amount
number
Represents the numerical value of an amount.

Format: double
iso_currency_code
nullable string
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.
unofficial_currency_code
nullable string
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.
amount
number
Represents the numerical value of an amount.

Format: double
iso_currency_code
nullable string
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.
unofficial_currency_code
nullable string
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.
is_active
boolean
Indicates whether the transaction stream is still live.
status
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.
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
personal_finance_category
nullable object
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.
primary
string
A high level category that communicates the broad category of the transaction.
detailed
string
A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.
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
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "updated_datetime": "2022-05-01T00:00:00Z",
3  "inflow_streams": [
4    {
5      "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
6      "stream_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc",
7      "category": [
8        "Transfer",
9        "Payroll"
10      ],
11      "category_id": "21009000",
12      "description": "Platypus Payroll",
13      "merchant_name": null,
14      "personal_finance_category": {
15        "detailed": "INCOME_WAGES",
16        "primary": "INCOME"
17      },
18      "first_date": "2022-02-28",
19      "last_date": "2022-04-30",
20      "frequency": "SEMI_MONTHLY",
21      "transaction_ids": [
22        "nkeaNrDGrhdo6c4qZWDA8ekuIPuJ4Avg5nKfw",
23        "EfC5ekksdy30KuNzad2tQupW8WIPwvjXGbGHL",
24        "ozfvj3FFgp6frbXKJGitsDzck5eWQH7zOJBYd",
25        "QvdDE8AqVWo3bkBZ7WvCd7LskxVix8Q74iMoK",
26        "uQozFPfMzibBouS9h9tz4CsyvFll17jKLdPAF"
27      ],
28      "average_amount": {
29        "amount": -800,
30        "iso_currency_code": "USD",
31        "unofficial_currency_code": null
32      },
33      "last_amount": {
34        "amount": -1000,
35        "iso_currency_code": "USD",
36        "unofficial_currency_code": null
37      },
38      "is_active": true,
39      "status": "MATURE"
40    }
41  ],
42  "outflow_streams": [
43    {
44      "account_id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDff",
45      "stream_id": "no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nd",
46      "category": [
47        "Service",
48        "Utilities",
49        "Electric"
50      ],
51      "category_id": "18068005",
52      "description": "ConEd Bill Payment",
53      "merchant_name": "ConEd",
54      "personal_finance_category": {
55        "detailed": "RENT_AND_UTILITIES_GAS_AND_ELECTRICITY",
56        "primary": "RENT_AND_UTILITIES"
57      },
58      "first_date": "2022-02-04",
59      "last_date": "2022-05-02",
60      "frequency": "MONTHLY",
61      "transaction_ids": [
62        "yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0",
63        "HPDnUVgI5Pa0YQSl0rxwYRwVXeLyJXTWDAvpR",
64        "jEPoSfF8xzMClE9Ohj1he91QnvYoSdwg7IT8L",
65        "CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l"
66      ],
67      "average_amount": {
68        "amount": 85,
69        "iso_currency_code": "USD",
70        "unofficial_currency_code": null
71      },
72      "last_amount": {
73        "amount": 100,
74        "iso_currency_code": "USD",
75        "unofficial_currency_code": null
76      },
77      "is_active": true,
78      "status": "MATURE"
79    }
80  ],
81  "request_id": "tbFyCEqkU775ZGG"
82}

/transactions/refresh

Refresh transaction data

/transactions/refresh is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling /transactions/refresh, Plaid will fire a webhook: 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.
Access to /transactions/refresh in Production is specific to certain pricing plans. If you cannot access /transactions/refresh in Production, contact Sales for assistance.

transactions/refresh

Request fields and example

client_id
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.
access_token
requiredstring
The access token associated with the Item data is being requested for.
secret
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
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

request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "request_id": "1vwmF5TBQwiqfwP"
3}

/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.

categories/get

Request fields and example

This endpoint takes an empty request body.
Select group for content switcher
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.
category_id
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.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "categories": [
3    {
4      "category_id": "10000000",
5      "group": "special",
6      "hierarchy": [
7        "Bank Fees"
8      ]
9    },
10    {
11      "category_id": "10001000",
12      "group": "special",
13      "hierarchy": [
14        "Bank Fees",
15        "Overdraft"
16      ]
17    },
18    {
19      "category_id": "12001000",
20      "group": "place",
21      "hierarchy": [
22        "Community",
23        "Animal Shelter"
24      ]
25    }
26  ],
27  "request_id": "ixTBLZGvhD4NnmB"
28}

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

request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "request_id": "1vwmF5TBQwiqfwP"
3}

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, historical, or default pull. 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.

webhook_type
string
TRANSACTIONS
webhook_code
string
SYNC_UPDATES_AVAILABLE
item_id
string
The item_id of the Item associated with this webhook, warning, or error
initial_update_complete
boolean
Indicates if initial pull information is available.
historical_update_complete
boolean
Indicates if historical pull information is available.
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}

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.

webhook_type
string
TRANSACTIONS
webhook_code
string
INITIAL_UPDATE
error
string
The error code associated with the webhook.
new_transactions
number
The number of new, unfetched transactions available.
item_id
string
The item_id of the Item associated with this webhook, warning, or error
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "INITIAL_UPDATE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "error": null,
6  "new_transactions": 19
7}

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.

webhook_type
string
TRANSACTIONS
webhook_code
string
HISTORICAL_UPDATE
error
object
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. Error fields will be null if no error has occurred.
error_type
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
error_code
string
The particular error code. Safe for programmatic use.
error_message
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
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.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
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.
status
number
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.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
string
Suggested steps for resolving the error
new_transactions
number
The number of new, unfetched transactions available
item_id
string
The item_id of the Item associated with this webhook, warning, or error
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "HISTORICAL_UPDATE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "error": null,
6  "new_transactions": 231
7}

DEFAULT_UPDATE

Fired when new transaction data is available for an Item. Plaid will typically check for new transaction data several times a day.

webhook_type
string
TRANSACTIONS
webhook_code
string
DEFAULT_UPDATE
error
object
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. Error fields will be null if no error has occurred.
error_type
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
error_code
string
The particular error code. Safe for programmatic use.
error_message
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
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.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
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.
status
number
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.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
string
Suggested steps for resolving the error
new_transactions
number
The number of new transactions detected since the last time this webhook was fired.
item_id
string
The item_id of the Item the webhook relates to.
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "DEFAULT_UPDATE",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "error": null,
6  "new_transactions": 3
7}

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.

webhook_type
string
TRANSACTIONS
webhook_code
string
TRANSACTIONS_REMOVED
error
object
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. Error fields will be null if no error has occurred.
error_type
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
error_code
string
The particular error code. Safe for programmatic use.
error_message
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
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.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
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.
status
number
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.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
string
Suggested steps for resolving the error
removed_transactions
[string]
An array of transaction_ids corresponding to the removed transactions
item_id
string
The item_id of the Item associated with this webhook, warning, or error
1{
2  "webhook_type": "TRANSACTIONS",
3  "webhook_code": "TRANSACTIONS_REMOVED",
4  "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "removed_transactions": [
6    "yBVBEwrPyJs8GvR77N7QTxnGg6wG74H7dEDN6",
7    "kgygNvAVPzSX9KkddNdWHaVGRVex1MHm3k9no"
8  ],
9  "error": null
10}