Skip to content

Mercury: Treasury schemas

11 Mercury schemas with complete fields and constraints.

← Treasury operations · All schemas

Get all treasury accounts — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response type for treasury accounts API endpoint
accountsarrayRequired within parentList of treasury accounts in the current page
accounts[]ModelEach itemExpand Get all treasury accounts — response body — accounts item
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for a Mercury account.
Format: uuid
page.previousPagestringOptionalID for a Mercury account.
Format: uuid

Referenced models: Get all treasury accounts — response body — accounts item

Get all treasury accounts — response body — accounts item

FieldTypePresenceDescription and constraints
$objectRoot
availableBalanceJSONRequired within parent
availableBalance (anyOf 1)numberAlternativeMultiple of: 0.01
availableBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
currentBalanceJSONRequired within parent
currentBalance (anyOf 1)numberAlternativeMultiple of: 0.01
currentBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
netReturnsarrayRequired within parentMonthly net return breakdown with dividend and fee details
netReturns[]ModelEach itemExpand Get all treasury accounts — response body — accounts item net Returns item
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, deleted, pending, archived

Referenced models: Get all treasury accounts — response body — accounts item net Returns item

Get all treasury accounts — response body — accounts item net Returns item

FieldTypePresenceDescription and constraints
$objectRootMonthly net return breakdown for a treasury account
dividendsarrayRequired within parentList of dividends received by security
dividends[]ModelEach itemExpand Get all treasury accounts — response body — accounts item net Returns item dividends item
monthJSONRequired within parent
month (allOf 1)stringAll variants applyFormat: date
month (allOf 2)JSONAll variants applyFirst day of the month for this net return
netAmountJSONRequired within parent
netAmount (anyOf 1)numberAlternativeNet return amount (dividends minus fees)
Multiple of: 0.01
netAmount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: processing, pending, charged, error
status (allOf 2)JSONAll variants applyStatus of this net return calculation
treasuryFeeJSONRequired within parent
treasuryFee (anyOf 1)numberAlternativeTreasury fee charged for this period (positive value)
Multiple of: 0.01
treasuryFee (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get all treasury accounts — response body — accounts item net Returns item dividends item

Get all treasury accounts — response body — accounts item net Returns item dividends item

FieldTypePresenceDescription and constraints
$objectRootDividend information for a specific treasury security
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeDividend amount for this security
Multiple of: 0.01
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentSecurity identifier (e.g., "617455696")
securityNamestringRequired within parentHuman-readable security name (e.g., "Morgan Stanley Ultra-Short Income Portfolio Class IR")
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: cusip
type (allOf 2)JSONAll variants applySecurity identifier type

Get treasury account statements — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response for treasury account statements
pageobjectRequired within parent
page.nextPagestringOptionalID for the account statement
Format: uuid
page.previousPagestringOptionalID for the account statement
Format: uuid
statementsarrayRequired within parent
statements[]ModelEach itemExpand Get treasury account statements — response body — statements item

Referenced models: Get treasury account statements — response body — statements item

Get treasury account statements — response body — statements item

FieldTypePresenceDescription and constraints
$objectRootIndividual treasury statement in the response
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
accountId (allOf 2)JSONAll variants applyExternal treasury account ID this statement belongs to
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
createdAt (allOf 2)JSONAll variants applyTimestamp when the record was created
creationDateJSONRequired within parent
creationDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
creationDate (allOf 2)JSONAll variants applyDate the statement was created by the custodian
descriptionstringRequired within parentHuman-readable description of the statement
documentTypeJSONRequired within parent
documentType (allOf 1)stringAll variants applyKnown values: MonthlyStatement, TradeConfirmation, 1099, 1099R, 1042S, 5498, 5498ESA, 1099Q, FMV, SDIRA
documentType (allOf 2)JSONAll variants applyType of document (e.g. monthly statement, trade confirmation, tax form)
downloadUrlstringRequired within parentURL to download the statement PDF
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the account statement
Format: uuid
id (allOf 2)JSONAll variants applyUnique identifier for the statement
periodEndJSONRequired within parent
periodEnd (allOf 1)stringAll variants applyFormat: date
periodEnd (allOf 2)JSONAll variants applyEnd of the period covered by the statement
periodStartJSONRequired within parent
periodStart (allOf 1)stringAll variants applyFormat: date
periodStart (allOf 2)JSONAll variants applyStart of the period covered by the statement
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
updatedAt (allOf 2)JSONAll variants applyTimestamp when the record was last updated

Get treasury transactions — response body

FieldTypePresenceDescription and constraints
$objectRootResponse type for treasury transactions API endpoint
cursorJSONOptional
cursor (anyOf 1)JSONAlternative
cursor (anyOf 1) (allOf 1)ModelAll variants applyExpand Get treasury transactions — response body — cursor value value
cursor (anyOf 1) (allOf 2)JSONAll variants applyPagination cursor for retrieving next batch of transactions
cursor (anyOf 2)nullAlternative
transactionsarrayRequired within parentList of treasury transactions in the response
transactions[]ModelEach itemExpand Get treasury transactions — response body — transactions item

Referenced models: Get treasury transactions — response body — cursor value value, Get treasury transactions — response body — transactions item

Get treasury transactions — response body — cursor value value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativePagination cursor for retrieving next batch of transactions
Minimum: 0
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get treasury transactions — response body — transactions item

FieldTypePresenceDescription and constraints
$objectRootTreasury transaction data for external API consumption
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
additionalDetailsJSONOptional
additionalDetails (anyOf 1)stringAlternative
additionalDetails (anyOf 2)nullAlternative
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeMultiple of: 0.01
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balanceJSONRequired within parent
balance (anyOf 1)numberAlternativeMultiple of: 0.01
balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canonicalDayJSONRequired within parent
canonicalDay (allOf 1)stringAll variants applyFormat: date
descriptionstringRequired within parent
detailsJSONOptional
details (anyOf 1)JSONAlternative
details (anyOf 1) (allOf 1)ModelAll variants applyExpand Get treasury transactions — response body — transactions item details credit Description, deposit Counterparty Id, fee Description, manual Amendment Description, security, sweep Direction, trade Action, withdrawal Counterparty Id credit Description, deposit Counterparty Id, fee Description, manual Amendment Description, security, sweep Direction, trade Action, withdrawal Counterparty Id
details (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for this treasury transaction
Format: uuid
securityJSONOptional
security (anyOf 1)stringAlternative
security (anyOf 2)nullAlternative
typeJSONRequired within parent
type (allOf 1)ModelAll variants applyExpand Get treasury transactions — response body — transactions item type string

Referenced models: Get treasury transactions — response body — transactions item details credit Description, deposit Counterparty Id, fee Description, manual Amendment Description, security, sweep Direction, trade Action, withdrawal Counterparty Id credit Description, deposit Counterparty Id, fee Description, manual Amendment Description, security, sweep Direction, trade Action, withdrawal Counterparty Id, Get treasury transactions — response body — transactions item type string

Get treasury transactions — response body — transactions item details credit Description, deposit Counterparty Id, fee Description, manual Amendment Description, security, sweep Direction, trade Action, withdrawal Counterparty Id credit Description, deposit Counterparty Id, fee Description, manual Amendment Description, security, sweep Direction, trade Action, withdrawal Counterparty Id

FieldTypePresenceDescription and constraints
$objectRoot
creditDescriptionJSONOptional
creditDescription (anyOf 1)stringAlternative
creditDescription (anyOf 2)nullAlternative
depositCounterpartyIdJSONOptional
depositCounterpartyId (anyOf 1)JSONAlternative
depositCounterpartyId (anyOf 1) (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
depositCounterpartyId (anyOf 2)nullAlternative
feeDescriptionJSONOptional
feeDescription (anyOf 1)stringAlternative
feeDescription (anyOf 2)nullAlternative
manualAmendmentDescriptionJSONOptional
manualAmendmentDescription (anyOf 1)stringAlternative
manualAmendmentDescription (anyOf 2)nullAlternative
securityJSONOptional
security (anyOf 1)stringAlternative
security (anyOf 2)nullAlternative
sweepDirectionJSONOptional
sweepDirection (anyOf 1)stringAlternative
sweepDirection (anyOf 2)nullAlternative
tradeActionJSONOptional
tradeAction (anyOf 1)stringAlternative
tradeAction (anyOf 2)nullAlternative
withdrawalCounterpartyIdJSONOptional
withdrawalCounterpartyId (anyOf 1)JSONAlternative
withdrawalCounterpartyId (anyOf 1) (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
withdrawalCounterpartyId (anyOf 2)nullAlternative

Get treasury transactions — response body — transactions item type string

FieldTypePresenceDescription and constraints
$stringRootKnown values: depositCanceled, depositComplete, depositFailed, depositReturned, mercuryFeePosted, mercuryFeeFailed, mercuryFeeRefunded, mercuryFeeCanceled, withdrawalPosted, withdrawalFailed, withdrawalCanceled, withdrawalReturned, revertTxn, interestPosted, interestCanceled, manualAmendmentPosted, mercuryCreditPosted, mercuryCreditFailed, dividendPosted, dividendCanceled, dividendReinvestmentPosted, mutualFundTradeFailed, mutualFundTradePosted, sweepInPosted, sweepOutPosted, sweepReconcilePosted, valuationChangePosted, oemsMutualFundOrderSettled, oemsMutualFundOrderCanceled, oemsMutualFundOrderRejected, oemsFixedIncomeOrderSettled, oemsFixedIncomeOrderCanceled, oemsFixedIncomeOrderRejected, couponPosted, couponCanceled, maturityPosted, maturityCanceled

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.