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.
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["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 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.vault.reveal_card_pan(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.cardId | string | Required within parent | Unique identifier for a card 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 Reveal card details — response body |
Referenced models: Reveal card details — response body
Schemas
Section titled “Schemas”Reveal card details — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sensitive card details returned by the card reveal endpoint: the card's full number, expiration, and CVC. |
cardNumber | string | Required within parent | The card's full primary account number (PAN). |
cvc | string | Required within parent | The card's card verification code (CVC). |
expiration | JSON | Required within parent | |
expiration (allOf 1) | Model | All variants apply | Expand Get a card — response body — expiration Month and year the card expires |
expiration (allOf 2) | JSON | All variants apply | Month 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Month and year the card expires. |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | Calendar month. Maximum: 12 Minimum: 1 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
year | JSON | Required within parent | |
year (anyOf 1) | integer | Alternative | Four-digit calendar year. Maximum: 2999 Minimum: 2000 |
year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.