Skip to content

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.

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 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_cards(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get cards for account — response body

Referenced models: Get cards for account — response body

Get cards for account — response body
FieldTypePresenceDescription and constraints
$objectRoot
cardsarrayRequired within parent
cards[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootDeprecated account card representation, used by the @/v1/account\/:id\/cards@ endpoint.
cardIdstringRequired within parent
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
lastFourDigitsstringRequired within parent
nameOnCardstringRequired within parent
networkJSONRequired within parent
network (allOf 1)stringAll variants applyKnown values: visa, mastercard
physicalCardStatusJSONOptional
physicalCardStatus (anyOf 1)JSONAlternative
physicalCardStatus (anyOf 1) (allOf 1)stringAll variants applyKnown values: inactive, active, locked
physicalCardStatus (anyOf 2)nullAlternative
spendLimitJSONRequired within parent
spendLimit (allOf 1)ModelAll variants applyExpand Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, frozen, cancelled, inactive, expired, suspended, singleUseConsumed
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: virtual, physical
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
userIdstringRequired 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
FieldTypePresenceDescription and constraints
$objectRootSpending controls applied to a card
amountCentsJSONRequired within parent
amountCents (anyOf 1)integerAlternativeMaximum total spend allowed per interval, in cents.
Minimum: 0
amountCents (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
atmAmountCentsJSONOptional
atmAmountCents (anyOf 1)JSONAlternative
atmAmountCents (anyOf 1) (anyOf 1)integerAlternativeMaximum ATM withdrawal allowed per interval, in cents. Null for virtual
cards and credit cards.
Minimum: 0
atmAmountCents (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
atmAmountCents (anyOf 2)nullAlternative
intervalJSONRequired within parent
interval (allOf 1)stringAll variants applyKnown values: daily, weekly, monthly, yearly
interval (allOf 2)JSONAll variants applyRolling window the limit applies to.

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.

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.