Skip to content

Mercury: Accounts schemas

31 Mercury schemas with complete fields and constraints.

← Accounts operations · All schemas

Create an internal transfer — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for POST /api/v1/transfer endpoint.
Transfers funds between two depository, treasury, or investment accounts belonging to the same organization.
Additional keys: not allowed
amountJSONRequired within parent
amount (allOf 1)numberAll variants applyA positive dollar amount with at least 1 cent.
Format: double
Minimum: 0.01
destinationAccountIdJSONRequired within parent
destinationAccountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
idempotencyKeystringRequired within parent
noteJSONOptional
note (anyOf 1)stringAlternative
note (anyOf 2)nullAlternative
sourceAccountIdJSONRequired within parent
sourceAccountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid

Create an internal transfer — response body

FieldTypePresenceDescription and constraints
$objectRootResponse for POST /api/v1/transfer endpoint.
Returns both the credit and debit transactions for the transfer (depository, treasury, or investment).
creditTransactionJSONRequired within parent
creditTransaction (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body
debitTransactionJSONRequired within parent
debitTransaction (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body

Referenced models: Get transaction by ID — response body

Get account statements — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response for depository account statements (v1 API)
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 account statements — response body — statements item

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

Get account statements — response body — statements item

FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
companyLegalAddressJSONRequired within parent
companyLegalAddress (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region
companyLegalNamestringRequired within parent
downloadUrlstringRequired within parent
einJSONOptional
ein (anyOf 1)stringAlternative
ein (anyOf 2)nullAlternative
endDateJSONRequired within parent
endDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
endingBalanceJSONRequired within parent
endingBalance (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the account statement
Format: uuid
routingNumberstringRequired within parent
startDateJSONRequired within parent
startDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
transactionsarrayRequired within parent
transactions[]ModelEach itemExpand Get account statements — response body — statements item transactions item

Referenced models: Create a product — response body — unit Price value, Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region, Get account statements — response body — statements item transactions item

Get account statements — response body — statements item transactions item

FieldTypePresenceDescription and constraints
$objectRoot
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for this transaction
Format: uuid
postedAtJSONOptional
postedAt (anyOf 1)JSONAlternative
postedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
postedAt (anyOf 2)nullAlternative

Get all accounts — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
orderstringOptionalSort order. Can be 'asc' or 'desc'. Defaults to 'asc'
Default: asc
One of: asc, desc
start_afterstringOptionalThe ID of the account to start the page after (exclusive). When provided, results will begin with the account immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
end_beforestringOptionalThe ID of the account to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid

Get all accounts — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of accounts.
| Use the page cursor information to fetch additional pages of accounts.
accountsarrayRequired within parentList of accounts in the current page
accounts[]ModelEach itemExpand Get all 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 accounts — response body — accounts item

Get all accounts — response body — accounts item

FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
availableBalanceJSONRequired within parent
availableBalance (anyOf 1)numberAlternativeMultiple of: 0.01
availableBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canReceiveTransactionsJSONOptional
canReceiveTransactions (anyOf 1)booleanAlternative
canReceiveTransactions (anyOf 2)nullAlternative
canSendRealTimePaymentsbooleanRequired within parentWhether this account's partner bank supports sending real-time payments.
Sending one also requires the recipient's routing number to be RTP-eligible.
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]+)?$
dashboardLinkstringRequired within parent
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
kindstringRequired within parent
legalBusinessNamestringRequired within parent
namestringRequired within parent
nicknameJSONOptional
nickname (anyOf 1)stringAlternative
nickname (anyOf 2)nullAlternative
routingNumberstringRequired within parent
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, deleted, pending, archived
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: mercury, external, recipient

Get cards for account — response body

FieldTypePresenceDescription and constraints
$objectRoot
cardsarrayRequired within parent
cards[]ModelEach itemExpand Get cards for account — response body — cards item

Referenced models: Get cards for account — response body — cards item

Get cards for account — response body — cards item

FieldTypePresenceDescription and constraints
$objectRootDeprecated account card representation, used by the @/v1/account\/:id\/cards@ endpoint.
cardIdstringRequired within parent
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
lastFourDigitsstringRequired within parent
nameOnCardstringRequired within parent
networkJSONRequired within parent
network (allOf 1)stringAll variants applyKnown values: visa, mastercard
physicalCardStatusJSONOptional
physicalCardStatus (anyOf 1)JSONAlternative
physicalCardStatus (anyOf 1) (allOf 1)stringAll variants applyKnown values: inactive, active, locked
physicalCardStatus (anyOf 2)nullAlternative
spendLimitJSONRequired within parent
spendLimit (allOf 1)ModelAll variants applyExpand Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, frozen, cancelled, inactive, expired, suspended, singleUseConsumed
typeJSONRequired within parent
type (allOf 1)stringAll variants applyKnown values: virtual, physical
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
userIdstringRequired within parent

Referenced models: Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card

Get transaction by ID — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
accountId (allOf 2)JSONAll variants applyThe external-facing account identifier for the Mercury account that owns this transaction
accountingStatusJSONOptional
accountingStatus (anyOf 1)JSONAlternative
accountingStatus (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — accounting Status errored At, excluded At, reviewed At, status, sync Started At, synced At errored At, excluded At, reviewed At, status, sync Started At, synced At
accountingStatus (anyOf 1) (allOf 2)JSONAll variants applyReview and sync status of this transaction for the connected accounting integration (e.g.
QuickBooks, Xero, NetSuite). A transaction with no accounting activity is pending with no
timestamps. Null if the caller is not authorized to read accounting status, if the
organization has no active general ledger (no active Books or third-party ERP ledger), and
on the responses of endpoints that create transactions or transfers.
accountingStatus (anyOf 2)nullAlternative
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeMultiple of: 0.01
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attachmentsarrayRequired within parent
attachments[]ModelEach itemExpand Get transaction by ID — response body — attachments item
bankDescriptionJSONOptional
bankDescription (anyOf 1)stringAlternative
bankDescription (anyOf 2)nullAlternative
cardIdJSONOptional
cardId (anyOf 1)stringAlternativeId of the card behind this transaction, present on card payments and refunds (debit or
credit); null otherwise, including for card-related fee transactions. Fetch the card's details
(kind, cardholder, last four, etc.) via the Cards API (`GET /cards/{cardId}`). Supersedes the
kind-specific `details.creditCardInfo.id` / `details.debitCardInfo.id`.
Format: uuid
cardId (anyOf 2)nullAlternative
categoryDataJSONOptional
categoryData (anyOf 1)JSONAlternative
categoryData (anyOf 1) (allOf 1)ModelAll variants applyExpand Edit a category — response body
categoryData (anyOf 2)nullAlternative
checkNumberJSONOptional
checkNumber (anyOf 1)stringAlternativePresent for check deposits and mailed checks; Nothing otherwise.
checkNumber (anyOf 2)nullAlternative
compliantWithReceiptPolicybooleanRequired within parent
counterpartyIdJSONRequired within parent
counterpartyId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
counterpartyNamestringRequired within parent
counterpartyNicknameJSONOptional
counterpartyNickname (anyOf 1)stringAlternative
counterpartyNickname (anyOf 2)nullAlternative
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
creditAccountPeriodIdJSONOptional
creditAccountPeriodId (anyOf 1)JSONAlternative
creditAccountPeriodId (anyOf 1) (allOf 1)stringAll variants applyID for the credit statement period
Format: uuid
creditAccountPeriodId (anyOf 2)nullAlternative
currencyExchangeInfoJSONOptional
currencyExchangeInfo (anyOf 1)JSONAlternative
currencyExchangeInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — currency Exchange Info converted From Amount, converted From Currency, converted To Amount, converted To Currency, exchange Rate, fee Amount, fee Percentage, fee Transaction Id converted From Amount, converted From Currency, converted To Amount, converted To Currency, exchange Rate, fee Amount, fee Percentage, fee Transaction Id
currencyExchangeInfo (anyOf 2)nullAlternative
dashboardLinkstringRequired within parent
detailsJSONOptional
details (anyOf 1)JSONAlternative
details (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info
details (anyOf 2)nullAlternative
estimatedDeliveryDateJSONRequired within parent
estimatedDeliveryDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
externalMemoJSONOptional
externalMemo (anyOf 1)stringAlternative
externalMemo (anyOf 2)nullAlternative
failedAtJSONOptional
failedAt (anyOf 1)JSONAlternative
failedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
failedAt (anyOf 2)nullAlternative
feeIdJSONOptional
feeId (anyOf 1)JSONAlternative
feeId (anyOf 1) (allOf 1)stringAll variants applyID for this transaction
Format: uuid
feeId (anyOf 2)nullAlternative
generalLedgerCodeNameJSONOptional
generalLedgerCodeName (anyOf 1)stringAlternativeDeprecated: use transactionGlAllocations instead. This field does not reflect GL codes
assigned via Mercury auto-categorization rules. Preserved for backwards compatibility.
generalLedgerCodeName (anyOf 2)nullAlternative
glAllocationsarrayRequired within parentGL code allocations assigned to this transaction via a connected accounting software
integration (e.g. QuickBooks, Xero, NetSuite). Each allocation has a GL code name and
the amount allocated to it; amounts sum to the transaction total when the transaction is
fully categorized. Empty if no GL codes have been assigned. Distinct from Mercury custom
categories (see transactionCategoryData).
glAllocations[]ModelEach itemExpand Get transaction by ID — response body — gl Allocations item
hasGeneratedReceiptbooleanRequired within parent
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for this transaction
Format: uuid
kindJSONRequired within parent
kind (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — kind string
merchantJSONOptional
merchant (anyOf 1)JSONAlternative
merchant (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — merchant amount, category, category Code, currency, id Merchant information for card transactions
merchant (anyOf 1) (allOf 2)JSONAll variants applyMerchant information for card transactions, including the merchant category code (MCC),
merchant ID, Mercury category, and for international transactions, the amount and currency
in the merchant's local currency. Nothing for non-card transactions.
merchant (anyOf 2)nullAlternative
mercuryCategoryJSONOptional
mercuryCategory (anyOf 1)JSONAlternative
mercuryCategory (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a card — response body — category Locks item
mercuryCategory (anyOf 2)nullAlternative
noteJSONOptional
note (anyOf 1)stringAlternative
note (anyOf 2)nullAlternative
postedAtJSONOptional
postedAt (anyOf 1)JSONAlternative
postedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
postedAt (anyOf 2)nullAlternative
reasonForFailureJSONOptional
reasonForFailure (anyOf 1)stringAlternative
reasonForFailure (anyOf 2)nullAlternative
relatedTransactionsarrayRequired within parent
relatedTransactions[]ModelEach itemExpand Get transaction by ID — response body — related Transactions item
requestIdJSONOptional
requestId (anyOf 1)stringAlternative
requestId (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: pending, sent, cancelled, failed, reversed, blocked
trackingNumberJSONOptional
trackingNumber (anyOf 1)stringAlternativePresent for transactions that have tracking numbers (e.g., RTP, ACH, wires); Nothing otherwise.
trackingNumber (anyOf 2)nullAlternative

Referenced models: Get a card — response body — category Locks item, Edit a category — response body, Get transaction by ID — response body — currency Exchange Info converted From Amount, converted From Currency, converted To Amount, converted To Currency, exchange Rate, fee Amount, fee Percentage, fee Transaction Id converted From Amount, converted From Currency, converted To Amount, converted To Currency, exchange Rate, fee Amount, fee Percentage, fee Transaction Id, Get transaction by ID — response body — gl Allocations item, Get transaction by ID — response body — merchant amount, category, category Code, currency, id Merchant information for card transactions, Get transaction by ID — response body — related Transactions item, Get transaction by ID — response body — accounting Status errored At, excluded At, reviewed At, status, sync Started At, synced At errored At, excluded At, reviewed At, status, sync Started At, synced At, Get transaction by ID — response body — attachments item, Get transaction by ID — response body — kind string, Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info

Get transaction by ID — response body — accounting Status errored At, excluded At, reviewed At, status, sync Started At, synced At errored At, excluded At, reviewed At, status, sync Started At, synced At

FieldTypePresenceDescription and constraints
$objectRootA transaction's accounting review and sync status, for the accounting integration connected
to the organization (e.g. QuickBooks, Xero, NetSuite).
erroredAtJSONOptional
erroredAt (anyOf 1)JSONAlternative
erroredAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
erroredAt (anyOf 1) (allOf 2)JSONAll variants applyWhen the sync of the transaction to the accounting integration failed. Null if it has not
failed.
erroredAt (anyOf 2)nullAlternative
excludedAtJSONOptional
excludedAt (anyOf 1)JSONAlternative
excludedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
excludedAt (anyOf 1) (allOf 2)JSONAll variants applyWhen the transaction was excluded from accounting sync. Null if it is not excluded.
excludedAt (anyOf 2)nullAlternative
reviewedAtJSONOptional
reviewedAt (anyOf 1)JSONAlternative
reviewedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
reviewedAt (anyOf 1) (allOf 2)JSONAll variants applyWhen the transaction was last marked as reviewed. Null if it has not been reviewed.
reviewedAt (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: pending, reviewed, syncing, synced, errored, excluded
status (allOf 2)JSONAll variants applyCurrent review and sync status of the transaction. pending: not reviewed or synced yet,
including transactions with no accounting activity. reviewed: marked as reviewed and ready to
sync. syncing: a sync has started but not finished. synced: synced successfully. errored: the
sync failed. excluded: excluded from accounting sync. When more than one applies, the first of
excluded, errored, synced, syncing and reviewed wins.
syncStartedAtJSONOptional
syncStartedAt (anyOf 1)JSONAlternative
syncStartedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
syncStartedAt (anyOf 1) (allOf 2)JSONAll variants applyWhen a sync of the transaction to the accounting integration was started. This is the
start of the sync, not its completion (see syncedAt). Null if no sync has been started.
syncStartedAt (anyOf 2)nullAlternative
syncedAtJSONOptional
syncedAt (anyOf 1)JSONAlternative
syncedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
syncedAt (anyOf 1) (allOf 2)JSONAll variants applyWhen the transaction finished syncing to the accounting integration successfully. Null if
it has not finished syncing.
syncedAt (anyOf 2)nullAlternative

Get transaction by ID — response body — attachments item

FieldTypePresenceDescription and constraints
$objectRoot
attachmentTypeJSONRequired within parent
attachmentType (allOf 1)stringAll variants applyKnown values: checkImage, receipt, other
fileNamestringRequired within parent
urlstringRequired within parent

Get transaction by ID — response body — currency Exchange Info converted From Amount, converted From Currency, converted To Amount, converted To Currency, exchange Rate, fee Amount, fee Percentage, fee Transaction Id converted From Amount, converted From Currency, converted To Amount, converted To Currency, exchange Rate, fee Amount, fee Percentage, fee Transaction Id

FieldTypePresenceDescription and constraints
$objectRoot
convertedFromAmountJSONRequired within parent
convertedFromAmount (anyOf 1)numberAlternativeMultiple of: 0.01
convertedFromAmount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
convertedFromCurrencyJSONRequired within parent
convertedFromCurrency (allOf 1)stringAll variants apply
convertedToAmountJSONRequired within parent
convertedToAmount (anyOf 1)numberAlternativeMultiple of: 0.01
convertedToAmount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
convertedToCurrencyJSONRequired within parent
convertedToCurrency (allOf 1)stringAll variants apply
exchangeRateJSONRequired within parent
exchangeRate (anyOf 1)numberAlternativeExchange rate goes from "from currency" to "to currency"
(ie from currency * exchange rate = to currency)
Multiple of: 0.0001
exchangeRate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
feeAmountJSONRequired within parent
feeAmount (anyOf 1)numberAlternativeMultiple of: 0.01
feeAmount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
feePercentageJSONRequired within parent
feePercentage (anyOf 1)numberAlternativeMultiple of: 0.0001
feePercentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
feeTransactionIdJSONOptional
feeTransactionId (anyOf 1)JSONAlternative
feeTransactionId (anyOf 1) (allOf 1)stringAll variants applyID for this transaction
Format: uuid
feeTransactionId (anyOf 2)nullAlternative

Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address address1, address2, city, postal Code, state address1, address2, city, postal Code, state
address (anyOf 2)nullAlternative
creditCardInfoJSONOptional
creditCardInfo (anyOf 1)JSONAlternative
creditCardInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info credit Card Info email, id, payment Method email, id, payment Method
creditCardInfo (anyOf 2)nullAlternative
debitCardInfoJSONOptional
debitCardInfo (anyOf 1)JSONAlternative
debitCardInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info debit Card Info id id
debitCardInfo (anyOf 2)nullAlternative
domesticWireRoutingInfoJSONOptional
domesticWireRoutingInfo (anyOf 1)JSONAlternative
domesticWireRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number
domesticWireRoutingInfo (anyOf 2)nullAlternative
electronicRoutingInfoJSONOptional
electronicRoutingInfo (anyOf 1)JSONAlternative
electronicRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number
electronicRoutingInfo (anyOf 2)nullAlternative
internationalWireRoutingInfoJSONOptional
internationalWireRoutingInfo (anyOf 1)JSONAlternative
internationalWireRoutingInfo (anyOf 1) (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code
internationalWireRoutingInfo (anyOf 2)nullAlternative

Referenced models: Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address address1, address2, city, postal Code, state address1, address2, city, postal Code, state, Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info credit Card Info email, id, payment Method email, id, payment Method, Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info debit Card Info id id, Add a new recipient — response body — domestic Wire Routing Info account Number, address, bank Name, routing Number account Number, address, bank Name, routing Number, Add a new recipient — response body — electronic Routing Info account Number, address, bank Name, electronic Account Type, routing Number account Number, address, bank Name, electronic Account Type, routing Number, Add a new recipient — response body — international Wire Routing Info address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code address, bank Details, correspondent Info, country Specific, email Address, iban, phone Number, swift Code

Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address address1, address2, city, postal Code, state address1, address2, city, postal Code, state

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
postalCodestringRequired within parent
stateJSONOptional
state (anyOf 1)JSONAlternative
state (anyOf 1) (allOf 1)stringAll variants applyKnown values: AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
state (anyOf 2)nullAlternative

Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info credit Card Info email, id, payment Method email, id, payment Method

FieldTypePresenceDescription and constraints
$objectRoot
emailJSONOptional
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyFormat: uuid
id (allOf 2)JSONAll variants applySuperseded by the flat `transaction.cardId`, which identifies the card on any card payment
or refund without branching on debit vs credit. Retained for backwards compatibility; a formal
(OpenAPI-level) deprecation will follow in a separate change.
paymentMethodstringRequired within parent

Get transaction by ID — response body — details address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info address, credit Card Info, debit Card Info, domestic Wire Routing Info, electronic Routing Info, international Wire Routing Info debit Card Info id id

FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (allOf 1)stringAll variants applyFormat: uuid
id (allOf 2)JSONAll variants applySuperseded by the flat `transaction.cardId`, which identifies the card on any card payment
or refund without branching on debit vs credit. Retained for backwards compatibility; a formal
(OpenAPI-level) deprecation will follow in a separate change.

Get transaction by ID — response body — gl Allocations item

FieldTypePresenceDescription and constraints
$objectRootA GL code allocation on a transaction — a GL code name paired with the amount
allocated to it. When a transaction is fully categorized, the amounts across all
allocations sum to the transaction total.
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeThe amount allocated to this GL code
Multiple of: 0.01
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
classNameJSONOptional
className (anyOf 1)stringAlternativeThe name of the class from the connected accounting integration, if assigned
className (anyOf 2)nullAlternative
departmentNameJSONOptional
departmentName (anyOf 1)stringAlternativeThe name of the department from the connected accounting integration, if assigned
departmentName (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeOptional user-provided description for this allocation
description (anyOf 2)nullAlternative
glCodeNamestringRequired within parentThe name of the GL code from the connected accounting integration

Get transaction by ID — response body — kind string

FieldTypePresenceDescription and constraints
$stringRootKnown values: externalTransfer, internalTransfer, outgoingPayment, creditCardCredit, creditCardTransaction, debitCardCredit, debitCardTransaction, cardInternationalTransactionFee, cardInternationalTransactionFeeRebate, cardInternationalTransactionFeeReversal, cardInternationalTransactionFeeRebateReversal, incomingDomesticWire, checkDeposit, incomingInternationalWire, treasuryTransfer, currencyCloudReturn, wireFee, personalBankingSubscriptionFee, billingEngineSubscriptionFee, expenseReimbursement, exogenousWireDrawdown, interestPayment, other

Get transaction by ID — response body — merchant amount, category, category Code, currency, id Merchant information for card transactions

FieldTypePresenceDescription and constraints
$objectRootMerchant information for card transactions
amountJSONOptional
amount (anyOf 1)JSONAlternative
amount (anyOf 1) (anyOf 1)integerAlternativeThe transaction amount in the smallest unit of the merchant's currency
(e.g., cents for USD/EUR, yen for JPY, fils for BHD).
For debits this is negative, for credits positive.
Use 'merchantCurrency' to determine the appropriate decimal scaling:
most currencies use 2 decimal places (divide by 100), but JPY uses 0
(no division needed) and BHD/KWD/OMR use 3 (divide by 1000).
This is useful for international transactions where the merchant charges in a
currency different from the account currency. Nothing if not available.
Format: int64
Maximum: 9223372036854776000
Minimum: -9223372036854776000
amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)nullAlternative
categoryJSONOptional
category (anyOf 1)JSONAlternative
category (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a card — response body — category Locks item
category (anyOf 1) (allOf 2)JSONAll variants applyMercury category for the merchant (e.g., "Restaurants", "Software")
category (anyOf 2)nullAlternative
categoryCodeJSONOptional
categoryCode (anyOf 1)stringAlternative4-digit merchant category code (MCC) for card transactions
categoryCode (anyOf 2)nullAlternative
currencyJSONOptional
currency (anyOf 1)JSONAlternative
currency (anyOf 1) (allOf 1)stringAll variants apply
currency (anyOf 1) (allOf 2)JSONAll variants applyISO 4217 currency code of the merchant's currency (e.g., "EUR", "GBP", "JPY").
Nothing if not available.
currency (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeMerchant ID for card transactions
id (anyOf 2)nullAlternative

Referenced models: Get a card — response body — category Locks item

Get transaction by ID — response body — related Transactions item

FieldTypePresenceDescription and constraints
$objectRootA Public API version of RelatedTransactionData.
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeMultiple of: 0.01
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for this transaction
Format: uuid
relationKindJSONRequired within parent
relationKind (allOf 1)ModelAll variants applyExpand Get transaction by ID — response body — related Transactions item relation Kind string

Referenced models: Get transaction by ID — response body — related Transactions item relation Kind string

Get transaction by ID — response body — related Transactions item relation Kind string

FieldTypePresenceDescription and constraints
$stringRootKnown values: ProvisionalCreditReversalToMerchantRefund, MerchantRefundToProvisionalCreditReversal, MerchantRefundToFraudulentCharge, FraudulentChargeToMerchantRefund, PaymentRefundToFailedPayment, FailedPaymentToPaymentRefund, GiftCompensationToOriginalTransaction, FeePaymentToOriginalTransaction, OriginalTransactionToFeePayment, FeePaymentToFeeRebate, FeeRebateToFeePayment, FeePaymentToFeeReversal, FeeReversalToFeePayment, FeeRebateToFeeRebateReversal, FeeRebateReversalToFeeRebate, TreasurySplitLiquidation, ProvisionalCreditToOriginalCharge, OriginalChargeToProvisionalCredit, FeeAtmReimbursementToAtmTransaction, AtmTransactionToFeeAtmReimbursement, AtmTransactionToAtmReimbursementReversal, AtmReimbursementReversalToAtmTransaction, ReturnToOriginalTransaction, OriginalTransactionToReturn, ProvisionalCreditToReversal, ReversalToProvisionalCredit, MerchantRefundToOriginalCharge, OriginalChargeToMerchantRefund

List account transactions — response body

FieldTypePresenceDescription and constraints
$objectRoot
totalJSONRequired within parent
total (anyOf 1)integerAlternativeMaximum: 9223372036854776000
Minimum: -9223372036854776000
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
transactionsarrayRequired within parent
transactions[]ModelEach itemExpand Get transaction by ID — response body

Referenced models: Get transaction by ID — response body

Request to send money — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountJSONRequired within parentAmount of USD you want to send, must be a positive number.
amount (allOf 1)numberAll variants applyA positive dollar amount with at least 1 cent.
Format: double
Minimum: 0.01
chargeTypestringOptionalWho pays intermediary bank fees on a USD international wire. Pass 'ours' so the recipient receives the full amount (Mercury charges a $15 fee), or 'shared' to split those fees. If omitted on a USD international wire, this defaults to 'ours'. Do not include this field for other payment methods or accounts that are not charged international-wire fees.
One of: ours, shared
duplicateCheckOverridebooleanOptionalSet to true to skip the duplicate payment check. By default, payments are blocked if the same account sent the same amount to the same recipient with the same payment method in the last 24 hours, even when the idempotency key is different. Use this field only when you intentionally send a repeat payment. The check occurs when you create the request. When an approver approves the request, the check does not occur again.
externalMemostringOptionalOptional external memo
Maximum length: 299
idempotencyKeystringRequired within parentUnique string identifying the transaction
notestringOptionalOptional note
paymentMethodJSONRequired within parentPayment method to use. If domesticWire or internationalWire is used, then the purpose field is required.
paymentMethod (allOf 1)stringAll variants applyOne of: ach, check, domesticWire, internationalWire, realTimePayment
purposeJSONOptionalPurpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire' or 'internationalWire'.
purpose (allOf 1)ModelAll variants applyExpand Request to send money — request body — body purpose External API representation of Send Money Purpose
recipientIdJSONRequired within parentRecipient ID from the /recipients endpoint.
recipientId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid

Referenced models: Request to send money — request body — body purpose External API representation of Send Money Purpose

Request to send money — request body — body purpose External API representation of Send Money Purpose

FieldTypePresenceDescription and constraints
$objectRootExternal API representation of SendMoneyPurpose.
Only exposes the 'simple' field to decouple internal implementation from external API.
Additional keys: not allowed
simpleJSONOptional
simple (anyOf 1)JSONAlternative
simple (anyOf 1) (allOf 1)ModelAll variants applyExpand Request to send money — request body — body purpose External API representation of Send Money Purpose simple additional Info, category additional Info, category
simple (anyOf 2)nullAlternative

Referenced models: Request to send money — request body — body purpose External API representation of Send Money Purpose simple additional Info, category additional Info, category

Request to send money — request body — body purpose External API representation of Send Money Purpose simple additional Info, category additional Info, category

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
additionalInfostringOptionalAdditional information. Required for: Vendor (vendor name), Contractor (contractor name), Other (payment description). Optional for Subsidiary (subsidiary name). Not accepted for any other categories.
categorystringRequired within parentPayment category.
One of: employee, landlord, vendor, contractor, subsidiary, transferToMyExternalAccount, familyMemberOrFriend, forGoodsOrServices, angelInvestment, savingsOrInvestments, expenses, travel, other

Request to send money — response body

FieldTypePresenceDescription and constraints
$objectRootA pending or completed approval request for a Mercury payment.
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
amountJSONRequired within parent
amount (allOf 1)ModelAll variants applyExpand Request to send money — response body — amount value
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
createdAt (allOf 2)JSONAll variants applyTime at which the payment request was created.
memoJSONOptional
memo (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
memo (anyOf 2)nullAlternative
numberOfApproversRequiredJSONOptional
numberOfApproversRequired (anyOf 1)JSONAlternative
numberOfApproversRequired (anyOf 1) (anyOf 1)integerAlternativeTotal number of approvals required for this payment to be sent.
Omitted for older requests where the requirement is not available.
Maximum: 9223372036854776000
Minimum: -9223372036854776000
numberOfApproversRequired (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numberOfApproversRequired (anyOf 2)nullAlternative
paymentMethodJSONRequired within parent
paymentMethod (allOf 1)stringAll variants applyKnown values: ach, check, domesticWire, internationalWire, realTimePayment
recipientIdJSONRequired within parent
recipientId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
requestIdstringRequired within parent
requestedByUserIdJSONRequired within parent
requestedByUserId (allOf 1)stringAll variants applyID for the user
Format: uuid
requestedByUserId (allOf 2)JSONAll variants applyThe user who created the payment request.
requesterMayApproveJSONOptional
requesterMayApprove (anyOf 1)booleanAlternativeTrue when the approval requirement recorded for this payment names the
requester as its approver. Reflects the recorded requirement, not the
requester's current standing, so submitting the approval can still be
refused. The value persists after the request settles and says only whether
the requirement names the requester; whether an approval is still
outstanding is carried by numberOfApproversRequired and status. Omitted for
older requests where the requirement is not available.
requesterMayApprove (anyOf 2)nullAlternative
reviewsarrayRequired within parentApproval decisions recorded against this request, ordered from
oldest to most recent.
reviews[]ModelEach itemExpand Request to send money — response body — reviews item
scheduledSendDateJSONOptional
scheduledSendDate (anyOf 1)JSONAlternative
scheduledSendDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
scheduledSendDate (anyOf 1) (allOf 2)JSONAll variants applyDate on which the payment is scheduled to be sent once fully
approved. Null when the payment will be sent as soon as approvals
are complete.
scheduledSendDate (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: pendingApproval, approved, rejected, cancelled

Referenced models: Request to send money — response body — amount value, Request to send money — response body — reviews item

Request to send money — response body — amount value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA positive dollar amount with at least 1 cent.
Format: double
Minimum: 0.01
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Request to send money — response body — reviews item

FieldTypePresenceDescription and constraints
$objectRoot
reviewedAtJSONRequired within parent
reviewedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
reviewerUserIdJSONRequired within parent
reviewerUserId (allOf 1)stringAll variants applyID for the user
Format: uuid
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: approved, rejected

Send money to a recipient — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountJSONRequired within parentAmount of USD you want to send, must be a positive number.
amount (allOf 1)numberAll variants applyA positive dollar amount with at least 1 cent.
Format: double
Minimum: 0.01
duplicateCheckOverridebooleanOptionalSet to true to skip the duplicate payment check. By default, payments are blocked if the same account sent the same amount to the same recipient with the same payment method in the last 24 hours, even when the idempotency key is different. Use this field only when you intentionally send a repeat payment.
externalMemostringOptionalOptional external memo
Maximum length: 299
idempotencyKeystringRequired within parentUnique string identifying the transaction
notestringOptionalOptional note
paymentMethodJSONRequired within parentIf domesticWire is used, then the purpose field is required.
paymentMethod (allOf 1)stringAll variants applyOne of: ach, check, domesticWire, realTimePayment
purposeJSONOptionalPurpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire'.
purpose (allOf 1)ModelAll variants applyExpand Request to send money — request body — body purpose External API representation of Send Money Purpose
recipientIdJSONRequired within parentRecipient ID from the /recipients endpoint.
recipientId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid

Referenced models: Request to send money — request body — body purpose External API representation of Send Money Purpose

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.