`get_balance`

Pack: plaid · Endpoint: https://gateway.pipeworx.io/plaid/mcp

Get real-time account balances for linked accounts. Returns current, available, and limit balances. Example: get_balance({ access_token: “access-sandbox-xxx”, _apiKey: “client_id:secret” })

Parameters

Name	Type	Required	Description
`access_token`	string	yes	Plaid access token for the linked institution
`_apiKey`	string	yes	Plaid credentials as “client_id:secret”

Example call

Arguments

{
  "access_token": "access-sandbox-abc123def456",
  "_apiKey": "your-plaid-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/plaid/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_balance","arguments":{"access_token":"access-sandbox-abc123def456","_apiKey":"your-plaid-api-key"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('get_balance', {
  "access_token": "access-sandbox-abc123def456",
  "_apiKey": "your-plaid-api-key"
});

Response shape

Field	Type	Description
`accounts`	array	List of accounts with current balance information
`item`	object	Item metadata
`request_id`	string	Unique request identifier

Full JSON Schema

{
  "type": "object",
  "description": "Response from Plaid balance endpoint with real-time account balances",
  "properties": {
    "accounts": {
      "type": "array",
      "description": "List of accounts with current balance information",
      "items": {
        "type": "object",
        "properties": {
          "account_id": {
            "type": "string",
            "description": "Unique account identifier"
          },
          "name": {
            "type": "string",
            "description": "Account name"
          },
          "type": {
            "type": "string",
            "description": "Account type"
          },
          "mask": {
            "type": "string",
            "description": "Last digits of account number"
          },
          "balances": {
            "type": "object",
            "description": "Real-time balance information",
            "properties": {
              "available": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Available balance"
              },
              "current": {
                "type": "number",
                "description": "Current balance"
              },
              "limit": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Credit limit if applicable"
              }
            }
          }
        }
      }
    },
    "item": {
      "type": "object",
      "description": "Item metadata"
    },
    "request_id": {
      "type": "string",
      "description": "Unique request identifier"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "plaid": {
      "url": "https://gateway.pipeworx.io/plaid/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

get_balance