Mercury: Get cards for account
Mercury accounts.getAccountCards: arguments, response, policy and SDK examples.
← Accounts operations · Get started
Operation mercury.getaccountcards
Provider route: GET /account/{accountId}/cards. 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"]["getAccountCards"]>[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.getAccountCards(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_cards(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 |
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 cards for account — response body |
Referenced models: Get cards for account — response body
Schemas
Section titled “Schemas”Get cards for account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cards | array | Required within parent | |
cards[] | Model | Each item | Expand Get cards for account — response body — cards item |
Referenced models: Get cards for account — response body — cards item
Get cards for account — response body — cards item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated account card representation, used by the @/v1/account\/:id\/cards@ endpoint. |
cardId | string | Required within parent | |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
lastFourDigits | string | Required within parent | |
nameOnCard | string | Required within parent | |
network | JSON | Required within parent | |
network (allOf 1) | string | All variants apply | Known values: visa, mastercard |
physicalCardStatus | JSON | Optional | |
physicalCardStatus (anyOf 1) | JSON | Alternative | |
physicalCardStatus (anyOf 1) (allOf 1) | string | All variants apply | Known values: inactive, active, locked |
physicalCardStatus (anyOf 2) | null | Alternative | |
spendLimit | JSON | Required within parent | |
spendLimit (allOf 1) | Model | All variants apply | Expand Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, frozen, cancelled, inactive, expired, suspended, singleUseConsumed |
type | JSON | Required within parent | |
type (allOf 1) | string | All variants apply | Known values: virtual, physical |
updatedAt | JSON | Required within parent | |
updatedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
userId | string | Required within parent |
Referenced models: Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card
Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Spending controls applied to a card |
amountCents | JSON | Required within parent | |
amountCents (anyOf 1) | integer | Alternative | Maximum total spend allowed per interval, in cents. Minimum: 0 |
amountCents (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
atmAmountCents | JSON | Optional | |
atmAmountCents (anyOf 1) | JSON | Alternative | |
atmAmountCents (anyOf 1) (anyOf 1) | integer | Alternative | Maximum ATM withdrawal allowed per interval, in cents. Null for virtual cards and credit cards. Minimum: 0 |
atmAmountCents (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
atmAmountCents (anyOf 2) | null | Alternative | |
interval | JSON | Required within parent | |
interval (allOf 1) | string | All variants apply | Known values: daily, weekly, monthly, yearly |
interval (allOf 2) | JSON | All variants apply | Rolling window the limit applies to. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.getaccountcards. Catalog operation: mercury:getAccountCards. 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.