Mercury: Treasury schemas
11 Mercury schemas with complete fields and constraints.
← Treasury operations · All schemas
Get all treasury accounts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response type for treasury accounts API endpoint |
accounts | array | Required within parent | List of treasury accounts in the current page |
accounts[] | Model | Each item | Expand Get all treasury accounts — response body — accounts item |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for a Mercury account. Format: uuid |
page.previousPage | string | Optional | ID for a Mercury account. Format: uuid |
Referenced models: Get all treasury accounts — response body — accounts item
Get all treasury accounts — response body — accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
availableBalance | JSON | Required within parent | |
availableBalance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
availableBalance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
currentBalance | JSON | Required within parent | |
currentBalance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
currentBalance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
netReturns | array | Required within parent | Monthly net return breakdown with dividend and fee details |
netReturns[] | Model | Each item | Expand Get all treasury accounts — response body — accounts item net Returns item |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Monthly net return breakdown for a treasury account |
dividends | array | Required within parent | List of dividends received by security |
dividends[] | Model | Each item | Expand Get all treasury accounts — response body — accounts item net Returns item dividends item |
month | JSON | Required within parent | |
month (allOf 1) | string | All variants apply | Format: date |
month (allOf 2) | JSON | All variants apply | First day of the month for this net return |
netAmount | JSON | Required within parent | |
netAmount (anyOf 1) | number | Alternative | Net return amount (dividends minus fees) Multiple of: 0.01 |
netAmount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: processing, pending, charged, error |
status (allOf 2) | JSON | All variants apply | Status of this net return calculation |
treasuryFee | JSON | Required within parent | |
treasuryFee (anyOf 1) | number | Alternative | Treasury fee charged for this period (positive value) Multiple of: 0.01 |
treasuryFee (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Dividend information for a specific treasury security |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Dividend amount for this security Multiple of: 0.01 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Security identifier (e.g., "617455696") |
securityName | string | Required within parent | Human-readable security name (e.g., "Morgan Stanley Ultra-Short Income Portfolio Class IR") |
type | JSON | Required within parent | |
type (allOf 1) | string | All variants apply | Known values: cusip |
type (allOf 2) | JSON | All variants apply | Security identifier type |
Get treasury account statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response for treasury account statements |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the account statement Format: uuid |
page.previousPage | string | Optional | ID for the account statement Format: uuid |
statements | array | Required within parent | |
statements[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Individual treasury statement in the response |
accountId | JSON | Required within parent | |
accountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
accountId (allOf 2) | JSON | All variants apply | External treasury account ID this statement belongs to |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
createdAt (allOf 2) | JSON | All variants apply | Timestamp when the record was created |
creationDate | JSON | Required within parent | |
creationDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
creationDate (allOf 2) | JSON | All variants apply | Date the statement was created by the custodian |
description | string | Required within parent | Human-readable description of the statement |
documentType | JSON | Required within parent | |
documentType (allOf 1) | string | All variants apply | Known values: MonthlyStatement, TradeConfirmation, 1099, 1099R, 1042S, 5498, 5498ESA, 1099Q, FMV, SDIRA |
documentType (allOf 2) | JSON | All variants apply | Type of document (e.g. monthly statement, trade confirmation, tax form) |
downloadUrl | string | Required within parent | URL to download the statement PDF |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the account statement Format: uuid |
id (allOf 2) | JSON | All variants apply | Unique identifier for the statement |
periodEnd | JSON | Required within parent | |
periodEnd (allOf 1) | string | All variants apply | Format: date |
periodEnd (allOf 2) | JSON | All variants apply | End of the period covered by the statement |
periodStart | JSON | Required within parent | |
periodStart (allOf 1) | string | All variants apply | Format: date |
periodStart (allOf 2) | JSON | All variants apply | Start of the period covered by the statement |
updatedAt | JSON | Required within parent | |
updatedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
updatedAt (allOf 2) | JSON | All variants apply | Timestamp when the record was last updated |
Get treasury transactions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response type for treasury transactions API endpoint |
cursor | JSON | Optional | |
cursor (anyOf 1) | JSON | Alternative | |
cursor (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get treasury transactions — response body — cursor value value |
cursor (anyOf 1) (allOf 2) | JSON | All variants apply | Pagination cursor for retrieving next batch of transactions |
cursor (anyOf 2) | null | Alternative | |
transactions | array | Required within parent | List of treasury transactions in the response |
transactions[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | integer | Alternative | Pagination cursor for retrieving next batch of transactions Minimum: 0 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get treasury transactions — response body — transactions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Treasury transaction data for external API consumption |
accountId | JSON | Required within parent | |
accountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
additionalDetails | JSON | Optional | |
additionalDetails (anyOf 1) | string | Alternative | |
additionalDetails (anyOf 2) | null | Alternative | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Multiple of: 0.01 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance | JSON | Required within parent | |
balance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
balance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canonicalDay | JSON | Required within parent | |
canonicalDay (allOf 1) | string | All variants apply | Format: date |
description | string | Required within parent | |
details | JSON | Optional | |
details (anyOf 1) | JSON | Alternative | |
details (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for this treasury transaction Format: uuid |
security | JSON | Optional | |
security (anyOf 1) | string | Alternative | |
security (anyOf 2) | null | Alternative | |
type | JSON | Required within parent | |
type (allOf 1) | Model | All variants apply | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
creditDescription | JSON | Optional | |
creditDescription (anyOf 1) | string | Alternative | |
creditDescription (anyOf 2) | null | Alternative | |
depositCounterpartyId | JSON | Optional | |
depositCounterpartyId (anyOf 1) | JSON | Alternative | |
depositCounterpartyId (anyOf 1) (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
depositCounterpartyId (anyOf 2) | null | Alternative | |
feeDescription | JSON | Optional | |
feeDescription (anyOf 1) | string | Alternative | |
feeDescription (anyOf 2) | null | Alternative | |
manualAmendmentDescription | JSON | Optional | |
manualAmendmentDescription (anyOf 1) | string | Alternative | |
manualAmendmentDescription (anyOf 2) | null | Alternative | |
security | JSON | Optional | |
security (anyOf 1) | string | Alternative | |
security (anyOf 2) | null | Alternative | |
sweepDirection | JSON | Optional | |
sweepDirection (anyOf 1) | string | Alternative | |
sweepDirection (anyOf 2) | null | Alternative | |
tradeAction | JSON | Optional | |
tradeAction (anyOf 1) | string | Alternative | |
tradeAction (anyOf 2) | null | Alternative | |
withdrawalCounterpartyId | JSON | Optional | |
withdrawalCounterpartyId (anyOf 1) | JSON | Alternative | |
withdrawalCounterpartyId (anyOf 1) (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
withdrawalCounterpartyId (anyOf 2) | null | Alternative |
Get treasury transactions — response body — transactions item type string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known 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 |