View as Markdown
Plaid icon

Plaid ACTION

Get Real-Time Balance

Get the real-time balance for each of an Item's accounts. 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 Real-Time Balance 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-real-time-balance",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plaid: { authProvisionId: "apn_xxxxxxx" },
    accessToken: "Access Token",
    accountIds: ["Account IDs"],
  },
})

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 Real-Time Balance inputs
Property Type Description
accessToken Access Token string
The access token associated with the Item data is being requested for.
Required
accountIds Account IDs string[]
The specific account IDs to filter by. If not provided, all accounts will be returned.
Optional Dynamic

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-real-time-balance
Version
0.0.2
App
Plaid
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes