Skip to content

Mercury: Get all accounts

Mercury accounts.getAccounts: arguments, response, policy and SDK examples.

← Accounts operations · Get started

Operation mercury.getaccounts

Provider route: GET /accounts. 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"]["getAccounts"]>[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.getAccounts(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_accounts(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryModelOptionalExpand Get all accounts — request body — query

Referenced models: Get all accounts — request body — query

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get all accounts — response body

Referenced models: Get all accounts — response body

Get all accounts — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of accounts.
| Use the page cursor information to fetch additional pages of accounts.
accountsarrayRequired within parentList of accounts in the current page
accounts[]ModelEach itemExpand Get all accounts — response body — accounts item
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for a Mercury account.
Format: uuid
page.previousPagestringOptionalID for a Mercury account.
Format: uuid

Referenced models: Get all accounts — response body — accounts item

Get all accounts — request body — query
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
orderstringOptionalSort order. Can be 'asc' or 'desc'. Defaults to 'asc'
Default: asc
One of: asc, desc
start_afterstringOptionalThe ID of the account to start the page after (exclusive). When provided, results will begin with the account 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
end_beforestringOptionalThe ID of the account 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
Get all accounts — response body — accounts item
FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
availableBalanceJSONRequired within parent
availableBalance (anyOf 1)numberAlternativeMultiple of: 0.01
availableBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canReceiveTransactionsJSONOptional
canReceiveTransactions (anyOf 1)booleanAlternative
canReceiveTransactions (anyOf 2)nullAlternative
canSendRealTimePaymentsbooleanRequired within parentWhether this account's partner bank supports sending real-time payments.
Sending one also requires the recipient's routing number to be RTP-eligible.
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
currentBalanceJSONRequired within parent
currentBalance (anyOf 1)numberAlternativeMultiple of: 0.01
currentBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dashboardLinkstringRequired within parent
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
kindstringRequired within parent
legalBusinessNamestringRequired within parent
namestringRequired within parent
nicknameJSONOptional
nickname (anyOf 1)stringAlternative
nickname (anyOf 2)nullAlternative
routingNumberstringRequired within parent
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, deleted, pending, archived
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: mercury, external, recipient

SDK function policy ID: mercury.getaccounts. Catalog operation: mercury:getAccounts. 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.

Required provider scopes: ["read"]

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.