Plaid
Access financial account data, balances, and transactions via Plaid
Integrates Plaid into your workflow. Retrieve bank accounts, check balances, fetch transactions with date range filters, and get item details. Supports sandbox, development, and production environments.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | Plaid client ID from developer dashboard |
secret | string | Yes | Plaid secret key from developer dashboard |
environment | string | No | Plaid environment: sandbox or production (default: production) |
| Parameter | Type | Description |
|---|
accounts | array | List of linked bank accounts |
↳ account_id | string | Account ID |
↳ name | string | Account name |
↳ type | string | Account type (depository, credit, loan, etc.) |
↳ balances | json | Account balance information |
item | json | Plaid item (linked institution) information |
↳ item_id | string | Item ID |
↳ institution_id | string | Institution ID |
metadata | json | Query metadata |
↳ count | number | Number of accounts |
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | Plaid client ID |
secret | string | Yes | Plaid secret key |
accountIds | string | No | Comma-separated account IDs to filter (optional, returns all if omitted) |
environment | string | No | Plaid environment: sandbox or production |
| Parameter | Type | Description |
|---|
accounts | array | Account balances (real-time) |
↳ account_id | string | Account ID |
↳ name | string | Account name |
↳ balances | json | Real-time balance data |
item | json | Item information |
metadata | json | Query metadata |
↳ count | number | Number of accounts |
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | Plaid client ID |
secret | string | Yes | Plaid secret key |
startDate | string | Yes | Start date for transaction range (YYYY-MM-DD) |
endDate | string | Yes | End date for transaction range (YYYY-MM-DD) |
accountIds | string | No | Comma-separated account IDs to filter transactions |
count | number | No | Number of transactions to return (default 100, max 500) |
offset | number | No | Offset for pagination |
environment | string | No | Plaid environment: sandbox or production |
| Parameter | Type | Description |
|---|
transactions | array | List of bank transactions |
↳ transaction_id | string | Transaction ID |
↳ amount | number | Transaction amount (positive = debit) |
↳ date | string | Transaction date |
↳ name | string | Transaction name/description |
↳ pending | boolean | Whether transaction is pending |
accounts | array | Account information for the transactions |
metadata | json | Query metadata |
↳ totalTransactions | number | Total transactions available |
↳ requestId | string | Plaid request ID |
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | Plaid client ID |
secret | string | Yes | Plaid secret key |
environment | string | No | Plaid environment: sandbox or production |
| Parameter | Type | Description |
|---|
item | json | Plaid item metadata |
↳ item_id | string | Item ID |
↳ institution_id | string | Institution ID |
↳ available_products | array | Available Plaid products |
↳ billed_products | array | Currently billed Plaid products |
status | json | Item status information |
