plaid

Gets transaction data in `cashflow_report`

Changed on

The /cashflow_report/transactions/get endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. 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 /cashflow_report/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 cursor parameters in conjunction with the has_more response body field to fetch all available transactions. Note that data isn't likely to be immediately available to /cashflow_report/transactions/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn't, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the CASHFLOW_REPORT_READY webhook.

post/cashflow_report/transactions/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cashflow_report/transactions/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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_tokenstring required

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

secretstring

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.

countinteger

Number of transactions to fetch per call

cursorstring

The cursor value represents the last update requested. Pass in the empty string "" in the first call.

Response

OK

total_transactionsinteger required

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 using the cursor parameter.

next_cursorstring required

Cursor used for fetching any future updates after the latest update provided in this response.

has_moreboolean required

Represents if more than requested count of transactions exists to be fetched

request_idstring required

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

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the // response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the // response property for the response status

    • info

      added the optional property /// to the response with the status

  • e07a869352e8Revision changes
    • breaking

      the response property //////// became nullable for the status

    • info

      added the optional property / to the response with the status

    • info

      removed the charge card enum value from the /// response property for the response status

    • info

      removed the installment enum value from the /// response property for the response status