Skip to main content

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_a3f9b2 with 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)
  1. Go to Organization > Connectors and find Plaid.
  2. Click Enable and choose which tools to allow.
  3. 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.

ToolWhat it does
get_accountsList all accounts on the linked Item with names, types, and balances.
get_asset_reportRetrieve a generated Asset Report by its token.
get_authGet account and ACH routing/account numbers for the linked Item (for setting up transfers).
get_balancesGet real-time balances for accounts on the linked Item (forces a fresh balance fetch from the institution).
get_categoriesGet Plaid's legacy transaction category taxonomy (category_id, group, hierarchy) for interpreting the legacy category_id.
get_identityGet account-owner identity data (names, emails, phone numbers, addresses) for the linked Item.
get_institutionGet a single institution by ID, including supported products and routing numbers.
get_investment_holdingsGet investment holdings (positions) and their securities for the linked Item.
get_investment_transactionsGet investment transactions (buys, sells, dividends, fees) for the linked Item within a date range, with their securities.
get_itemGet metadata and per-product update status for the linked Item (institution, enabled products, last error).
get_liabilitiesGet liability details (credit cards, student loans, mortgages) for the linked Item: balances, APRs, due dates, payoff amounts.
get_paymentRetrieve a Payment Initiation payment by ID, including its current status.
get_payment_recipientRetrieve a payment recipient by ID (name, IBAN/bacs, address).
get_transactionsGet transactions for the linked Item within a date range, with optional account filter and pagination.
get_transferRetrieve a transfer by ID, including its current status and whether it is still cancellable.
list_institutionsList Plaid-supported financial institutions with pagination.
list_payment_recipientsList payment recipients under these credentials with cursor pagination.
list_paymentsList Payment Initiation payments created under these credentials, with cursor pagination.
list_transfersList 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_institutionsSearch Plaid-supported institutions by name, optionally filtered by supported products.
sync_transactionsGet incremental transaction changes (added/modified/removed) since a cursor.
validate_credentialCheck 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.

ToolWhat it does
create_asset_reportCreate 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_tokenCreate a short-lived Link token to start account linking or re-authenticate your linked Item in Plaid Link.
create_paymentCreate a Payment Initiation payment (UK/EU) to a recipient.
create_payment_recipientCreate a payment recipient for Payment Initiation (UK/EU).
create_transferTargets your linked Item to create (initiate) an ACH transfer from an approved authorization.
create_transfer_authorizationTargets your linked Item to authorize a transfer before creating it (Plaid's required risk/balance check).
refresh_asset_reportGenerate a new Asset Report from the same Items as an existing report, with up-to-date data.
refresh_transactionsRequest an on-demand refresh of the linked Item's transactions from the institution.

Delete or overwrite (4)​

Remove or replace existing data.

ToolWhat it does
cancel_transferCancel a transfer that has not yet progressed too far.
remove_asset_reportPermanently remove an Asset Report so its token can no longer retrieve it.
remove_itemTargets your linked Item for permanent removal, invalidating its access token and stopping all data access for it.
update_item_webhookTargets your linked Item to update the webhook URL Plaid notifies for its events (new transactions, errors).
⌘J