Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parentID for a Mercury account.
Format: uuid
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘desc’
Default: desc
One of: asc, desc
query.start_afterstringOptionalThe 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_beforestringOptionalThe 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.startstringOptionalFilter statements where the period start date is on or after this date. Format: YYYY-MM-DD
query.endstringOptionalFilter 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get account statements — response body

Referenced models: Get account statements — response body

Get account statements — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response for depository account statements (v1 API)
pageobjectRequired within parent
page.nextPagestringOptionalID for the account statement
Format: uuid
page.previousPagestringOptionalID for the account statement
Format: uuid
statementsarrayRequired within parent
statements[]ModelEach itemExpand Get account statements — response body — statements item

Referenced models: Get account statements — response body — statements item

Get account statements — response body — statements item
FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
companyLegalAddressJSONRequired within parent
companyLegalAddress (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region
companyLegalNamestringRequired within parent
downloadUrlstringRequired within parent
einJSONOptional
ein (anyOf 1)stringAlternative
ein (anyOf 2)nullAlternative
endDateJSONRequired within parent
endDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
endingBalanceJSONRequired within parent
endingBalance (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the account statement
Format: uuid
routingNumberstringRequired within parent
startDateJSONRequired within parent
startDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
transactionsarrayRequired within parent
transactions[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA dollar amount
Format: double
$ (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parentMaximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentMaximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
namestringRequired within parent
postalCodestringRequired within parentMaximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
Get account statements — response body — statements item transactions item
FieldTypePresenceDescription and constraints
$objectRoot
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for this transaction
Format: uuid
postedAtJSONOptional
postedAt (anyOf 1)JSONAlternative
postedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
postedAt (anyOf 2)nullAlternative

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.