Authentication: Client ID, secret, and access token. See Magic Link for the runtime auth flow.
Sample use cases
- 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
Available Tools
Cancel a transfer that has not yet progressed too far. The inverse of create_transfer. Only works when the transfer’s…
Create an Asset Report for your linked Item (a point-in-time snapshot of balances and transaction history for income/…
Create a short-lived Link token to start account linking or re-authenticate your linked Item in Plaid Link. In update…
Create a Payment Initiation payment (UK/EU) to a recipient. This initiates a bank payment the payer must then authori…
Create a payment recipient for Payment Initiation (UK/EU). Provide either an IBAN or UK bacs (account + sort code). R…
Targets your linked Item to create (initiate) an ACH transfer from an approved authorization. This MOVES MONEY. Call…
Targets your linked Item to authorize a transfer before creating it (Plaid’s required risk/balance check). Returns an…
List all accounts on the linked Item with names, types, and balances. Returns account_id values needed by balance/tra…
Retrieve a generated Asset Report by its token. Returns the full report (items, accounts, balances, historical balanc…
Get account and ACH routing/account numbers for the linked Item (for setting up transfers). Use get_accounts to see w…
Get real-time balances for accounts on the linked Item (forces a fresh balance fetch from the institution). Use get_a…
Get Plaid’s legacy transaction category taxonomy (category_id, group, hierarchy) for interpreting the legacy category…
Get account-owner identity data (names, emails, phone numbers, addresses) for the linked Item. Requires a linked Item…
Get a single institution by ID, including supported products and routing numbers. Set include_metadata for logo/color…
Get investment holdings (positions) and their securities for the linked Item. Use get_accounts to find account_ids. R…
Get investment transactions (buys, sells, dividends, fees) for the linked Item within a date range, with their securi…
Get metadata and per-product update status for the linked Item (institution, enabled products, last error). Requires…
Get liability details (credit cards, student loans, mortgages) for the linked Item: balances, APRs, due dates, payoff…
Retrieve a Payment Initiation payment by ID, including its current status. Use create_payment or list_payments to fin…
Retrieve a payment recipient by ID (name, IBAN/bacs, address). Use create_payment_recipient or list_payment_recipient…
Get transactions for the linked Item within a date range, with optional account filter and pagination. Use sync_trans…
Retrieve a transfer by ID, including its current status and whether it is still cancellable. Use create_transfer or l…
List Plaid-supported financial institutions with pagination. Use for browsing; use search_institutions when you have…
List payment recipients under these credentials with cursor pagination. Pass a previous page’s next_cursor as cursor…
List Payment Initiation payments created under these credentials, with cursor pagination. Returns payment_ids for get…
List all transfers made with these Plaid API credentials, across every linked Item (not only the Item whose access to…
Generate a new Asset Report from the same Items as an existing report, with up-to-date data. Returns a new asset_repo…
Request an on-demand refresh of the linked Item’s transactions from the institution. New data arrives asynchronously…
Permanently remove an Asset Report so its token can no longer retrieve it. The inverse of create_asset_report. Use cr…
Targets your linked Item for permanent removal, invalidating its access token and stopping all data access for it. Th…
Search Plaid-supported institutions by name, optionally filtered by supported products. Use when you have an institut…
Get incremental transaction changes (added/modified/removed) since a cursor. Pass null cursor to start from the begin…
Targets your linked Item to update the webhook URL Plaid notifies for its events (new transactions, errors). Pass an…