plaid

Gets transaction data in `cashflow_report`

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

Changed in 17 of the 52 revisions of this API.18618

  • e536704a333f91See the full diff
    • added the new charge card enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new commercial line of credit enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new home equity loan enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new installment enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new prediction market enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the optional property accounts/items/allOf[subschema #1: Account]/apy to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new ASSETS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ASSETS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new cash advance enum value to the transactions/items/transaction_code response property for the response status 200

      response-property-enum-value-added

    • added the new late fee enum value to the transactions/items/transaction_code response property for the response status 200

      response-property-enum-value-added

    • added the new membership fee enum value to the transactions/items/transaction_code response property for the response status 200

      response-property-enum-value-added

    • added the new returned item fee enum value to the transactions/items/transaction_code response property for the response status 200

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new IDEMPOTENCY_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

  • fb8c3f188d8b44See the full diff
    • added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new payment enum value to the transactions/items/transaction_code response property for the response status 200

      response-property-enum-value-added

    • added the new refund enum value to the transactions/items/transaction_code response property for the response status 200

      response-property-enum-value-added

    • added the optional property accounts/items/allOf[subschema #2]/mask to the response with the 200 status

      response-optional-property-added

    • added the optional property accounts/items/allOf[subschema #2]/name to the response with the 200 status

      response-optional-property-added

    • added the optional property accounts/items/allOf[subschema #2]/official_name to the response with the 200 status

      response-optional-property-added

    • added the optional property accounts/items/allOf[subschema #2]/verification_name to the response with the 200 status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new limited purpose checking enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new fhsa enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new qshr enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth 403B enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth 457b enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth pension enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth profit sharing plan enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth thrift savings plan enum value to the accounts/items/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new cra_plaid_credit_score enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

  • 465584b48c9924See the full diff
    • added the new v1 enum value to the transactions/items/personal_finance_category/version response property for the response status 200

      response-property-enum-value-added

    • added the new v2 enum value to the transactions/items/personal_finance_category/version response property for the response status 200

      response-property-enum-value-added

    • added the optional property item/error/provided_account_subtypes to the response with the 200 status

      response-optional-property-added

    • added the optional property item/error/required_account_subtypes to the response with the 200 status

      response-optional-property-added

    • added the optional property provided_account_subtypes to the response with the default status

      response-optional-property-added

    • added the optional property required_account_subtypes to the response with the default status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the IDENTITY_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the IDENTITY_ERROR enum value from the item/error/error_type response property for the response status 200

      response-property-enum-value-removed

  • f8b9f1a8576744See the full diff
    • added the new IDENTITY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new IDENTITY_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • removed the cra_plaid_credit_score enum value from the item/available_products/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the item/products/items/ response property for the response status 200

      response-property-enum-value-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog