4.4 KiB
4.4 KiB
name, description
| name | description |
|---|---|
| financial-connections-routes | Handle 11 OpenAPI operation(s) under /v1/financial_connections for the financial connections route group. |
financial connections API Routes
Handle 11 OpenAPI operation(s) under /v1/financial_connections for the financial connections route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
get_financial_connections_accounts
- Operation ID:
get_financial_connections_accounts - Route:
GET /v1/financial_connections/accounts - Mode: READ
- Summary: List Accounts
- Parameters:
account_holderinqueryending_beforeinqueryexpandinquerylimitinquerysessioninquerystarting_afterinquery
- Body: JSON request body accepted.
get_financial_connections_accounts_account
- Operation ID:
get_financial_connections_accounts_account - Route:
GET /v1/financial_connections/accounts/{account} - Mode: READ
- Summary: Retrieve an Account
- Parameters:
accountinpathrequiredexpandinquery
- Body: JSON request body accepted.
post_financial_connections_accounts_account_disconnect
- Operation ID:
post_financial_connections_accounts_account_disconnect - Route:
POST /v1/financial_connections/accounts/{account}/disconnect - Mode: WRITE
- Summary: Disconnect an Account
- Parameters:
accountinpathrequired
- Body: JSON request body accepted.
get_financial_connections_accounts_account_owners
- Operation ID:
get_financial_connections_accounts_account_owners - Route:
GET /v1/financial_connections/accounts/{account}/owners - Mode: READ
- Summary: List Account Owners
- Parameters:
accountinpathrequiredending_beforeinqueryexpandinquerylimitinqueryownershipinqueryrequiredstarting_afterinquery
- Body: JSON request body accepted.
post_financial_connections_accounts_account_refresh
- Operation ID:
post_financial_connections_accounts_account_refresh - Route:
POST /v1/financial_connections/accounts/{account}/refresh - Mode: WRITE
- Summary: Refresh Account data
- Parameters:
accountinpathrequired
- Body: JSON request body accepted.
post_financial_connections_accounts_account_subscribe
- Operation ID:
post_financial_connections_accounts_account_subscribe - Route:
POST /v1/financial_connections/accounts/{account}/subscribe - Mode: WRITE
- Summary: Subscribe to data refreshes for an Account
- Parameters:
accountinpathrequired
- Body: JSON request body accepted.
post_financial_connections_accounts_account_unsubscribe
- Operation ID:
post_financial_connections_accounts_account_unsubscribe - Route:
POST /v1/financial_connections/accounts/{account}/unsubscribe - Mode: WRITE
- Summary: Unsubscribe from data refreshes for an Account
- Parameters:
accountinpathrequired
- Body: JSON request body accepted.
post_financial_connections_sessions
- Operation ID:
post_financial_connections_sessions - Route:
POST /v1/financial_connections/sessions - Mode: WRITE
- Summary: Create a Session
- Body: JSON request body accepted.
get_financial_connections_sessions_session
- Operation ID:
get_financial_connections_sessions_session - Route:
GET /v1/financial_connections/sessions/{session} - Mode: READ
- Summary: Retrieve a Session
- Parameters:
expandinquerysessioninpathrequired
- Body: JSON request body accepted.
get_financial_connections_transactions
- Operation ID:
get_financial_connections_transactions - Route:
GET /v1/financial_connections/transactions - Mode: READ
- Summary: List Transactions
- Parameters:
accountinqueryrequiredending_beforeinqueryexpandinquerylimitinquerystarting_afterinquerytransacted_atinquerytransaction_refreshinquery
- Body: JSON request body accepted.
get_financial_connections_transactions_transaction
- Operation ID:
get_financial_connections_transactions_transaction - Route:
GET /v1/financial_connections/transactions/{transaction} - Mode: READ
- Summary: Retrieve a Transaction
- Parameters:
expandinquerytransactioninpathrequired
- Body: JSON request body accepted.