Mercury: Get account statements
Mercury accounts.getAccountStatements: arguments, response, policy and SDK examples.
← Accounts operations · Get started
Operation mercury.getaccountstatements
Provider route: GET /account/{accountId}/statements. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["accounts"]["getAccountStatements"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.accounts.getAccountStatements(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.accounts.get_account_statements(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | ID for a Mercury account. Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
query.order | string | Optional | Sort order. Can be ‘asc’ or ‘desc’. Defaults to ‘desc’ Default: desc One of: asc, desc |
query.start_after | string | Optional | The ID of the statement to start the page after (exclusive). When provided, results will begin with the statement immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before. Format: uuid |
query.end_before | string | Optional | The ID of the statement to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after. Format: uuid |
query.start | string | Optional | Filter statements where the period start date is on or after this date. Format: YYYY-MM-DD |
query.end | string | Optional | Filter statements where the period start date is on or before this date. If the date is in the future, defaults to the current date. Format: YYYY-MM-DD |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get account statements — response body |
Referenced models: Get account statements — response body
Schemas
Section titled “Schemas”Get account statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response for depository account statements (v1 API) |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the account statement Format: uuid |
page.previousPage | string | Optional | ID for the account statement Format: uuid |
statements | array | Required within parent | |
statements[] | Model | Each item | Expand Get account statements — response body — statements item |
Referenced models: Get account statements — response body — statements item
Get account statements — response body — statements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
companyLegalAddress | JSON | Required within parent | |
companyLegalAddress (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region |
companyLegalName | string | Required within parent | |
downloadUrl | string | Required within parent | |
ein | JSON | Optional | |
ein (anyOf 1) | string | Alternative | |
ein (anyOf 2) | null | Alternative | |
endDate | JSON | Required within parent | |
endDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
endingBalance | JSON | Required within parent | |
endingBalance (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the account statement Format: uuid |
routingNumber | string | Required within parent | |
startDate | JSON | Required within parent | |
startDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
transactions | array | Required within parent | |
transactions[] | Model | Each item | Expand Get account statements — response body — statements item transactions item |
Referenced models: Create a product — response body — unit Price value, Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region, Get account statements — response body — statements item transactions item
Create a product — response body — unit Price value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | number | Alternative | A dollar amount Format: double |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | Maximum length: 299 Minimum length: 1 |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | Maximum length: 299 Minimum length: 1 |
country | JSON | Required within parent | |
country (allOf 1) | string | All variants apply | |
name | string | Required within parent | |
postalCode | string | Required within parent | Maximum length: 299 Minimum length: 1 |
region | JSON | Required within parent | |
region (allOf 1) | string | All variants apply |
Get account statements — response body — statements item transactions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
postedAt | JSON | Optional | |
postedAt (anyOf 1) | JSON | Alternative | |
postedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
postedAt (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.getaccountstatements. Catalog operation: mercury:getAccountStatements. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.