POST /processor/transactions/get

The /processor/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). 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 /processor/transactions/get. For more details, see Pending and posted transactions.

Due to the potentially large number of transactions associated with a processor token, 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 /processor/transactions/get will be the data available for the processor token 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. To force Plaid to check for new transactions, you can use the /processor/transactions/refresh endpoint.

Note that data may not be immediately available to /processor/transactions/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with transactions, or upon the first call to /processor/transactions/get, if it wasn't. If no transaction history is ready when /processor/transactions/get is called, it will return a PRODUCT_NOT_READY error.

To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update endpoint.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`start_date`	String	Yes	The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.
`client_id`	String	No	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	No	An optional object to be used with the request. If specified, `options` must not be `null`.
`options.include_personal_finance_category`	Boolean	No	Personal finance categories are now returned by default. Default value: false
`options.count`	Integer	No	The number of transactions to fetch. Default value: 100
`options.include_original_description`	Boolean	No	Include the raw unparsed transaction description from the financial institution. Default value: false
`options.include_logo_and_counterparty_beta`	Boolean	No	Counterparties and extra merchant fields are now returned by default. Default value: false
`options.include_personal_finance_category_beta`	Boolean	No	Personal finance categories are now returned by default. Default value: false
`options.offset`	Integer	No	The number of transactions to skip. The default value is 0. Default value: 0
`end_date`	String	Yes	The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.
`processor_token`	String	Yes	The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.