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.
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"]["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 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_accounts(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | Model | Optional | Expand Get all accounts — request body — query |
Referenced models: Get all accounts — request body — query
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 all accounts — response body |
Referenced models: Get all accounts — response body
Schemas
Section titled “Schemas”Get all accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response containing a list of accounts. | Use the page cursor information to fetch additional pages of accounts. |
accounts | array | Required within parent | List of accounts in the current page |
accounts[] | Model | Each item | Expand Get all accounts — response body — accounts item |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for a Mercury account. Format: uuid |
page.previousPage | string | Optional | ID for a Mercury account. Format: uuid |
Referenced models: Get all accounts — response body — accounts item
Get all accounts — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 |
order | string | Optional | Sort order. Can be 'asc' or 'desc'. Defaults to 'asc' Default: asc One of: asc, desc |
start_after | string | Optional | The 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_before | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
availableBalance | JSON | Required within parent | |
availableBalance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
availableBalance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canReceiveTransactions | JSON | Optional | |
canReceiveTransactions (anyOf 1) | boolean | Alternative | |
canReceiveTransactions (anyOf 2) | null | Alternative | |
canSendRealTimePayments | boolean | Required within parent | Whether this account's partner bank supports sending real-time payments. Sending one also requires the recipient's routing number to be RTP-eligible. |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
currentBalance | JSON | Required within parent | |
currentBalance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
currentBalance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dashboardLink | string | Required within parent | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
kind | string | Required within parent | |
legalBusinessName | string | Required within parent | |
name | string | Required within parent | |
nickname | JSON | Optional | |
nickname (anyOf 1) | string | Alternative | |
nickname (anyOf 2) | null | Alternative | |
routingNumber | string | Required within parent | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, deleted, pending, archived |
type | JSON | Required within parent | |
type (allOf 1) | string | All variants apply | Known values: mercury, external, recipient |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]