Skip to content

Mercury: Cards schemas

12 Mercury schemas with complete fields and constraints.

← Cards operations · All schemas

Create a card — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
accountIdJSONOptional
accountId (anyOf 1)JSONAlternative
accountId (anyOf 1) (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
accountId (anyOf 1) (allOf 2)JSONAll variants applyThe account the new card will draw funds from. Required when @kind@ is
@debit@; list available account IDs via @GET https:\/\/api.mercury.com\/api\/v1\/accounts@
(for debit card creation, the accountId must be associated with a checking account).
Optional when @kind@ is @credit@; omit to use your organization's Mercury
credit account, or pass the credit accountId from @GET https:\/\/api.mercury.com\/api\/v1\/credit@.
accountId (anyOf 2)nullAlternative
cardConfigurationJSONOptional
cardConfiguration (anyOf 1)JSONAlternative
cardConfiguration (anyOf 1) (allOf 1)ModelAll variants applyExpand Create a card — request body — body card Configuration single Use single Use
cardConfiguration (anyOf 1) (allOf 2)JSONAll variants applyOptional card configuration (single-use, agent, etc.)
cardConfiguration (anyOf 2)nullAlternative
kindJSONRequired within parent
kind (allOf 1)stringAll variants applyOne of: debit, credit
kind (allOf 2)JSONAll variants applyWhether to issue a debit or credit card.
nicknameJSONOptional
nickname (anyOf 1)stringAlternativeOptional user-assigned label for the card.
nickname (anyOf 2)nullAlternative
spendLimitJSONOptional
spendLimit (anyOf 1)JSONAlternative
spendLimit (anyOf 1) (allOf 1)ModelAll variants applyExpand Create a card — request body — body spend Limit Spending controls to apply at issuance amount Cents, interval
spendLimit (anyOf 1) (allOf 2)JSONAll variants applySpending controls to apply at issuance.
spendLimit (anyOf 2)nullAlternative
typeJSONRequired within parent
type (allOf 1)stringAll variants applyOne of: virtual
type (allOf 2)JSONAll variants applyThe type of card to issue.
userIdJSONRequired within parent
userId (allOf 1)stringAll variants applyID for the user
Format: uuid
userId (allOf 2)JSONAll variants applyThe user to assign as the cardholder.

Referenced models: Create a card — request body — body card Configuration single Use single Use, Create a card — request body — body spend Limit Spending controls to apply at issuance amount Cents, interval

Create a card — request body — body card Configuration single Use single Use

FieldTypePresenceDescription and constraints
$objectRootThe configuration of a card. Used both as the read-side response
alongside @cardConfiguration@ and as an alternative input at issuance
time.
Additional keys: not allowed
singleUsebooleanRequired within parentWhether this card auto-cancels itself on the first approved non-zero
authorization. Must be 'False' for physical cards.

Create a card — request body — body spend Limit Spending controls to apply at issuance amount Cents, interval

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountCentsintegerRequired within parentMaximum total spend allowed per interval, in cents.
Minimum: 0
intervalJSONRequired within parent
interval (allOf 1)stringAll variants applyOne of: daily, weekly, monthly, yearly
interval (allOf 2)JSONAll variants applyRolling window the limit applies to.

Get a card — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringRequired within parentThe Mercury account this card is associated with.
budgetsarrayRequired within parentOne entry per active budget linked to this card and cardholder.
Empty under cardLimit, or when this response has no active budget for the cardholder.
budgets[]ModelEach itemExpand Get a card — response body — budgets item
categoryLocksarrayRequired within parentMercury spend-category locks applied to this card, in no particular order. Empty when the card has no category restrictions.
categoryLocks[]ModelEach itemExpand Get a card — response body — category Locks item
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
createdAt (allOf 2)JSONAll variants applyTimestamp when the card was issued.
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.
idstringRequired within parentUnique identifier for the card.
Format: uuid
isAgentCardbooleanRequired within parentWhether the card is managed by the agentic spend-management agent. Only agent
cards can have their full details revealed.
isSingleUsebooleanRequired within parentWhether the card closes automatically after its first approved purchase. A used
single-use card reports a @singleUseConsumed@ status.
kindJSONRequired within parent
kind (allOf 1)stringAll variants applyKnown values: debit, credit
kind (allOf 2)JSONAll variants applyWhether the card is a debit or credit card.
lastFourstringRequired within parentLast four digits of the card's primary account number (PAN).
merchantLockJSONOptional
merchantLock (anyOf 1)JSONAlternative
merchantLock (anyOf 1) (allOf 1)ModelAll variants applyExpand List merchants — response body — data item
merchantLock (anyOf 1) (allOf 2)JSONAll variants applyMerchant lock applied to this card. Present only when the card is locked to a single merchant; otherwise omitted.
merchantLock (anyOf 2)nullAlternative
nameOnCardstringRequired within parentCardholder name printed on the card.
nicknameJSONOptional
nickname (anyOf 1)stringAlternativeOptional user-assigned label for the card.
nickname (anyOf 2)nullAlternative
physicalCardStatusJSONOptional
physicalCardStatus (anyOf 1)JSONAlternative
physicalCardStatus (anyOf 1) (allOf 1)stringAll variants applyKnown values: inactive, active, locked
physicalCardStatus (anyOf 1) (allOf 2)JSONAll variants applyActivation state of a physical card. Null for virtual cards.
physicalCardStatus (anyOf 2)nullAlternative
spendLimitJSONOptional
spendLimit (anyOf 1)JSONAlternative
spendLimit (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card
spendLimit (anyOf 1) (allOf 2)JSONAll variants applyCard-level spending controls. This is null when card-level limits are
unavailable, including for credit cards governed by budgets. For debit
cards, this includes the underlying card limits even when budgets govern
purchase spending. In budget mode, the transaction limit does not gate
purchases, but the ATM or cash limit can still apply to cash withdrawals.
spendLimit (anyOf 2)nullAlternative
spendLimitTypeJSONRequired within parent
spendLimitType (allOf 1)stringAll variants applyKnown values: cardLimit, budgets
spendLimitType (allOf 2)JSONAll variants applyWhether card-level limits or budgets govern purchase spending.
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, frozen, cancelled, inactive, expired, suspended, singleUseConsumed
status (allOf 2)JSONAll variants applyCurrent lifecycle state of the card.
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: virtual, physical
type (allOf 2)JSONAll variants applyWhether the card is virtual (digital-only) or physical (printed, supports ATM).
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
updatedAt (allOf 2)JSONAll variants applyTimestamp of the last modification to the card or its settings.
userIdstringRequired within parentMercury User who owns the card.

Referenced models: Get a card — response body — budgets item, Get a card — response body — expiration Month and year the card expires, List merchants — response body — data item, Get a card — response body — category Locks item, Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card

Get a card — response body — budgets item

FieldTypePresenceDescription and constraints
$objectRootCurrent-cycle limits for one budget linked to this card and cardholder.
amountCentsJSONRequired within parent
amountCents (anyOf 1)integerAlternativeThe cardholder's spend limit for the current budget cycle, in cents.
Minimum: 0
amountCents (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentUnique identifier for a budget
Format: uuid
namestringRequired within parentDisplay name of the budget.
remainingAmountCentsJSONRequired within parent
remainingAmountCents (anyOf 1)integerAlternativeCurrent-cycle limit minus recorded spend, clamped at zero, in cents.
Authorization also uses cached allocations and in-flight holds, so its available amount may differ.
Minimum: 0
remainingAmountCents (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a card — response body — category Locks item

FieldTypePresenceDescription and constraints
$stringRootKnown values: Other, Advertising, Airlines, AlcoholAndBars, BooksAndNewspaper, CarRental, Charity, Clothing, Conferences, Education, Electronics, Entertainment, FacilitiesExpenses, Fees, FoodDelivery, FuelAndGas, Gambling, GovernmentServices, Grocery, GroundTransportation, Insurance, InternetAndTelephone, Legal, Lodging, Medical, Memberships, OfficeSupplies, OtherTravel, Parking, Political, ProfessionalServices, Restaurants, Retail, RideshareAndTaxis, Shipping, Software, Taxes, Utilities, VehicleExpenses

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]+)?$

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.

List cards — response body

FieldTypePresenceDescription and constraints
$objectRoot
cardsarrayRequired within parentList of cards in the current page.
cards[]ModelEach itemExpand Get a card — response body
pageobjectRequired within parentPagination cursors for navigating to next/previous pages.
page.nextPagestringOptionalUnique identifier for a card
Format: uuid
page.previousPagestringOptionalUnique identifier for a card
Format: uuid

Referenced models: Get a card — response body

Update a card — request body — body

FieldTypePresenceDescription and constraints
$objectRootAt least one updateable field must be provided;
requests where every field is the same are rejected.
Additional keys: not allowed
nicknameJSONOptional
nickname (allOf 1)ModelAll variants applyExpand Update a card — request body — body nickname value
nickname (allOf 2)JSONAll variants applyUpdated card nickname. Omit to keep current, send null/empty to clear, send a string to set.
spendLimitJSONOptional
spendLimit (anyOf 1)JSONAlternative
spendLimit (anyOf 1) (allOf 1)ModelAll variants applyExpand Update a card — request body — body spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card
spendLimit (anyOf 1) (allOf 2)JSONAll variants applyUpdated spending controls for the card. Omit to leave unchanged.
spendLimit (anyOf 2)nullAlternative

Referenced models: Update a card — request body — body nickname value, Update a card — request body — body spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card

Update a card — request body — body nickname value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeNickname update action. Omit the field to keep the current nickname, send null or an empty/whitespace-only string to clear it, or send a string to set it.
$ (anyOf 2)nullAlternative

Update a card — request body — body spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card

FieldTypePresenceDescription and constraints
$objectRootSpending controls applied to a card
Additional keys: not allowed
amountCentsintegerRequired within parentMaximum total spend allowed per interval, in cents.
Minimum: 0
atmAmountCentsJSONOptional
atmAmountCents (anyOf 1)integerAlternativeMaximum ATM withdrawal allowed per interval, in cents. Null for virtual
cards and credit cards.
Minimum: 0
atmAmountCents (anyOf 2)nullAlternative
intervalJSONRequired within parent
interval (allOf 1)stringAll variants applyOne of: daily, weekly, monthly, yearly
interval (allOf 2)JSONAll variants applyRolling window the limit applies to.

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.