93 lines
2.6 KiB
Markdown
93 lines
2.6 KiB
Markdown
---
|
|
name: sources-routes
|
|
description: Handle 7 OpenAPI operation(s) under /v1/sources for the sources route group.
|
|
---
|
|
|
|
# sources API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /v1/sources for the sources 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
|
|
|
|
### post_sources
|
|
|
|
- Operation ID: `post_sources`
|
|
- Route: `POST /v1/sources`
|
|
- Mode: WRITE
|
|
- Summary: Shares a source
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_sources_source
|
|
|
|
- Operation ID: `get_sources_source`
|
|
- Route: `GET /v1/sources/{source}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a source
|
|
- Parameters:
|
|
- `client_secret` in `query`
|
|
- `expand` in `query`
|
|
- `source` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_sources_source
|
|
|
|
- Operation ID: `post_sources_source`
|
|
- Route: `POST /v1/sources/{source}`
|
|
- Mode: WRITE
|
|
- Summary: Update a source
|
|
- Parameters:
|
|
- `source` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_sources_source_mandate_notifications_mandate_notification
|
|
|
|
- Operation ID: `get_sources_source_mandate_notifications_mandate_notification`
|
|
- Route: `GET /v1/sources/{source}/mandate_notifications/{mandate_notification}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Source MandateNotification
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `mandate_notification` in `path` required
|
|
- `source` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_sources_source_source_transactions
|
|
|
|
- Operation ID: `get_sources_source_source_transactions`
|
|
- Route: `GET /v1/sources/{source}/source_transactions`
|
|
- Mode: READ
|
|
- Summary: <p>List source transactions for a given source.</p>
|
|
- Parameters:
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `source` in `path` required
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_sources_source_source_transactions_source_transaction
|
|
|
|
- Operation ID: `get_sources_source_source_transactions_source_transaction`
|
|
- Route: `GET /v1/sources/{source}/source_transactions/{source_transaction}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a source transaction
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `source` in `path` required
|
|
- `source_transaction` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_sources_source_verify
|
|
|
|
- Operation ID: `post_sources_source_verify`
|
|
- Route: `POST /v1/sources/{source}/verify`
|
|
- Mode: WRITE
|
|
- Summary: <p>Verify a given source.</p>
|
|
- Parameters:
|
|
- `source` in `path` required
|
|
- Body: JSON request body accepted.
|