Plaid
Plaid connector for linked financial accounts — read balances, transactions, account and routing numbers, identity, investments, and liabilities, plus institution and category reference data, and write operations for account linking, Item management, asset reports, ACH transfers, and payment initiation.
Categories: Accounting, Banking
What you can ask
- List the accounts linked to item
item_a3f9b2with their current balances - Fetch the last 30 days of transactions and group them by category
- Check the identity details on file for the primary checking account
Set up
Plaid connects with credentials from your Plaid account. Have these values ready:
- Environment
- Client ID
- Secret
- Access token (optional)
- Go to Organization > Connectors and find Plaid.
- Click Enable and choose which tools to allow.
- Each member enters their own values the first time they use it.
To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.
Tools
Plaid offers 34 tools. Admins choose which ones agents can use. See Tool permission groups.
Read (22)
View and search information without changing it.
| Tool | What it does |
|---|---|
get_accounts | List all accounts on the linked Item with names, types, and balances. |
get_asset_report | Retrieve a generated Asset Report by its token. |
get_auth | Get account and ACH routing/account numbers for the linked Item (for setting up transfers). |
get_balances | Get real-time balances for accounts on the linked Item (forces a fresh balance fetch from the institution). |
get_categories | Get Plaid's legacy transaction category taxonomy (category_id, group, hierarchy) for interpreting the legacy category_id. |
get_identity | Get account-owner identity data (names, emails, phone numbers, addresses) for the linked Item. |
get_institution | Get a single institution by ID, including supported products and routing numbers. |
get_investment_holdings | Get investment holdings (positions) and their securities for the linked Item. |
get_investment_transactions | Get investment transactions (buys, sells, dividends, fees) for the linked Item within a date range, with their securities. |
get_item | Get metadata and per-product update status for the linked Item (institution, enabled products, last error). |
get_liabilities | Get liability details (credit cards, student loans, mortgages) for the linked Item: balances, APRs, due dates, payoff amounts. |
get_payment | Retrieve a Payment Initiation payment by ID, including its current status. |
get_payment_recipient | Retrieve a payment recipient by ID (name, IBAN/bacs, address). |
get_transactions | Get transactions for the linked Item within a date range, with optional account filter and pagination. |
get_transfer | Retrieve a transfer by ID, including its current status and whether it is still cancellable. |
list_institutions | List Plaid-supported financial institutions with pagination. |
list_payment_recipients | List payment recipients under these credentials with cursor pagination. |
list_payments | List Payment Initiation payments created under these credentials, with cursor pagination. |
list_transfers | List all transfers made with these Plaid API credentials, across every linked Item (not only the Item whose access token is stored), newest first, with pagination and optional RFC 3339 date and funding-account filters. |
search_institutions | Search Plaid-supported institutions by name, optionally filtered by supported products. |
sync_transactions | Get incremental transaction changes (added/modified/removed) since a cursor. |
validate_credential | Check whether the stored Plaid client ID, secret, and environment are valid with a read-only institutions call, and, when an access token is stored, that it is still valid via /item/get. |
Write (8)
Create or send data.
| Tool | What it does |
|---|---|
create_asset_report | Create an Asset Report for your linked Item (a point-in-time snapshot of balances and transaction history for income/asset verification) using the access token stored in your credentials. |
create_link_token | Create a short-lived Link token to start account linking or re-authenticate your linked Item in Plaid Link. |
create_payment | Create a Payment Initiation payment (UK/EU) to a recipient. |
create_payment_recipient | Create a payment recipient for Payment Initiation (UK/EU). |
create_transfer | Targets your linked Item to create (initiate) an ACH transfer from an approved authorization. |
create_transfer_authorization | Targets your linked Item to authorize a transfer before creating it (Plaid's required risk/balance check). |
refresh_asset_report | Generate a new Asset Report from the same Items as an existing report, with up-to-date data. |
refresh_transactions | Request an on-demand refresh of the linked Item's transactions from the institution. |
Delete or overwrite (4)
Remove or replace existing data.
| Tool | What it does |
|---|---|
cancel_transfer | Cancel a transfer that has not yet progressed too far. |
remove_asset_report | Permanently remove an Asset Report so its token can no longer retrieve it. |
remove_item | Targets your linked Item for permanent removal, invalidating its access token and stopping all data access for it. |
update_item_webhook | Targets your linked Item to update the webhook URL Plaid notifies for its events (new transactions, errors). |