View as Markdown
Plaid icon

Plaid ACTION

Get Transactions

Retrieves user-authorized transaction data for a specified date range. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Plaid account once, then configure and run Get Transactions from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "plaid-get-transactions",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plaid: { authProvisionId: "apn_xxxxxxx" },
    accessToken: "Access Token",
    startDate: "Start Date",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Transactions inputs
Property Type Description
accessToken Access Token string
The access token associated with the Item data is being requested for.
Required
startDate Start Date string
The earliest date for which to fetch transaction data. Dates should be formatted as YYYY-MM-DD.
Required
endDate End Date string
The latest date for which to fetch transaction data. Dates should be formatted as YYYY-MM-DD.
Required
accountIds 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.
Optional Dynamic
includeOriginalDescription Include Original Description boolean
Include the raw unparsed transaction description from the financial institution.
Optional
daysRequested Days Requested integer
Number of days of transaction history to request from the financial institution. Only applies when Transactions product hasn't been initialized. Min: 1, Max: 730, Default: 90.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
plaid-get-transactions
Version
0.0.3
App
Plaid
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes