Skip to content

Mercury: Reveal card details

Mercury vault.revealCardPan: arguments, response, policy and SDK examples.

← Vault operations · Get started

Operation mercury.revealcardpan

Provider route: GET /cards/{cardId}/reveal. 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["vault"]["revealCardPan"]>[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.vault.revealCardPan(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.vault.reveal_card_pan(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.cardIdstringRequired within parentUnique identifier for a card
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 Reveal card details — response body

Referenced models: Reveal card details — response body

Reveal card details — response body
FieldTypePresenceDescription and constraints
$objectRootSensitive card details returned by the card reveal endpoint: the card's
full number, expiration, and CVC.
cardNumberstringRequired within parentThe card's full primary account number (PAN).
cvcstringRequired within parentThe card's card verification code (CVC).
expirationJSONRequired within parent
expiration (allOf 1)ModelAll variants applyExpand Get a card — response body — expiration Month and year the card expires
expiration (allOf 2)JSONAll variants applyMonth and year the card expires.

Referenced models: Get a card — response body — expiration Month and year the card expires

Get a card — response body — expiration Month and year the card expires
FieldTypePresenceDescription and constraints
$objectRootMonth and year the card expires.
monthJSONRequired within parent
month (anyOf 1)integerAlternativeCalendar month.
Maximum: 12
Minimum: 1
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
yearJSONRequired within parent
year (anyOf 1)integerAlternativeFour-digit calendar year.
Maximum: 2999
Minimum: 2000
year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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