Mercury: Accounts schemas
31 Mercury schemas with complete fields and constraints.
← Accounts operations · All schemas
Create an internal transfer — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request 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 |
amount | JSON | Required within parent | |
amount (allOf 1) | number | All variants apply | A positive dollar amount with at least 1 cent. Format: double Minimum: 0.01 |
destinationAccountId | JSON | Required within parent | |
destinationAccountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
idempotencyKey | string | Required within parent | |
note | JSON | Optional | |
note (anyOf 1) | string | Alternative | |
note (anyOf 2) | null | Alternative | |
sourceAccountId | JSON | Required within parent | |
sourceAccountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
Create an internal transfer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for POST /api/v1/transfer endpoint. Returns both the credit and debit transactions for the transfer (depository, treasury, or investment). |
creditTransaction | JSON | Required within parent | |
creditTransaction (allOf 1) | Model | All variants apply | Expand Get transaction by ID — response body |
debitTransaction | JSON | Required within parent | |
debitTransaction (allOf 1) | Model | All variants apply | Expand Get transaction by ID — response body |
Referenced models: Get transaction by ID — response body
Get account statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response for depository account statements (v1 API) |
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 account statements — response body — statements item |
Referenced models: Get account statements — response body — statements item
Get account statements — response body — statements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
companyLegalAddress | JSON | Required within parent | |
companyLegalAddress (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region |
companyLegalName | string | Required within parent | |
downloadUrl | string | Required within parent | |
ein | JSON | Optional | |
ein (anyOf 1) | string | Alternative | |
ein (anyOf 2) | null | Alternative | |
endDate | JSON | Required within parent | |
endDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
endingBalance | JSON | Required within parent | |
endingBalance (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the account statement Format: uuid |
routingNumber | string | Required within parent | |
startDate | JSON | Required within parent | |
startDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
transactions | array | Required within parent | |
transactions[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
postedAt | JSON | Optional | |
postedAt (anyOf 1) | JSON | Alternative | |
postedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
postedAt (anyOf 2) | null | Alternative |
Get all accounts — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
order | string | Optional | Sort order. Can be 'asc' or 'desc'. Defaults to 'asc' Default: asc One of: asc, desc |
start_after | string | Optional | The 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_before | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response containing a list of accounts. | Use the page cursor information to fetch additional pages of accounts. |
accounts | array | Required within parent | List of accounts in the current page |
accounts[] | Model | Each item | Expand Get all 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 accounts — response body — accounts item
Get all accounts — response body — accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
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]+)?$ |
canReceiveTransactions | JSON | Optional | |
canReceiveTransactions (anyOf 1) | boolean | Alternative | |
canReceiveTransactions (anyOf 2) | null | Alternative | |
canSendRealTimePayments | boolean | Required within parent | Whether this account's partner bank supports sending real-time payments. Sending one also requires the recipient's routing number to be RTP-eligible. |
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]+)?$ |
dashboardLink | string | Required within parent | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
kind | string | Required within parent | |
legalBusinessName | string | Required within parent | |
name | string | Required within parent | |
nickname | JSON | Optional | |
nickname (anyOf 1) | string | Alternative | |
nickname (anyOf 2) | null | Alternative | |
routingNumber | string | Required within parent | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, deleted, pending, archived |
type | JSON | Required within parent | |
type (allOf 1) | string | All variants apply | Known values: mercury, external, recipient |
Get cards for account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cards | array | Required within parent | |
cards[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deprecated account card representation, used by the @/v1/account\/:id\/cards@ endpoint. |
cardId | string | Required within parent | |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
lastFourDigits | string | Required within parent | |
nameOnCard | string | Required within parent | |
network | JSON | Required within parent | |
network (allOf 1) | string | All variants apply | Known values: visa, mastercard |
physicalCardStatus | JSON | Optional | |
physicalCardStatus (anyOf 1) | JSON | Alternative | |
physicalCardStatus (anyOf 1) (allOf 1) | string | All variants apply | Known values: inactive, active, locked |
physicalCardStatus (anyOf 2) | null | Alternative | |
spendLimit | JSON | Required within parent | |
spendLimit (allOf 1) | Model | All variants apply | Expand Get a card — response body — spend Limit amount Cents, atm Amount Cents, interval Spending controls applied to a card |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, frozen, cancelled, inactive, expired, suspended, singleUseConsumed |
type | JSON | Required within parent | |
type (allOf 1) | string | All variants apply | Known values: virtual, physical |
updatedAt | JSON | Required within parent | |
updatedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
userId | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 | The external-facing account identifier for the Mercury account that owns this transaction |
accountingStatus | JSON | Optional | |
accountingStatus (anyOf 1) | JSON | Alternative | |
accountingStatus (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | JSON | All variants apply | Review 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) | 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]+)?$ |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Get transaction by ID — response body — attachments item |
bankDescription | JSON | Optional | |
bankDescription (anyOf 1) | string | Alternative | |
bankDescription (anyOf 2) | null | Alternative | |
cardId | JSON | Optional | |
cardId (anyOf 1) | string | Alternative | Id 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) | null | Alternative | |
categoryData | JSON | Optional | |
categoryData (anyOf 1) | JSON | Alternative | |
categoryData (anyOf 1) (allOf 1) | Model | All variants apply | Expand Edit a category — response body |
categoryData (anyOf 2) | null | Alternative | |
checkNumber | JSON | Optional | |
checkNumber (anyOf 1) | string | Alternative | Present for check deposits and mailed checks; Nothing otherwise. |
checkNumber (anyOf 2) | null | Alternative | |
compliantWithReceiptPolicy | boolean | Required within parent | |
counterpartyId | JSON | Required within parent | |
counterpartyId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
counterpartyName | string | Required within parent | |
counterpartyNickname | JSON | Optional | |
counterpartyNickname (anyOf 1) | string | Alternative | |
counterpartyNickname (anyOf 2) | null | Alternative | |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
creditAccountPeriodId | JSON | Optional | |
creditAccountPeriodId (anyOf 1) | JSON | Alternative | |
creditAccountPeriodId (anyOf 1) (allOf 1) | string | All variants apply | ID for the credit statement period Format: uuid |
creditAccountPeriodId (anyOf 2) | null | Alternative | |
currencyExchangeInfo | JSON | Optional | |
currencyExchangeInfo (anyOf 1) | JSON | Alternative | |
currencyExchangeInfo (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
dashboardLink | string | Required within parent | |
details | JSON | Optional | |
details (anyOf 1) | JSON | Alternative | |
details (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative | |
estimatedDeliveryDate | JSON | Required within parent | |
estimatedDeliveryDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
externalMemo | JSON | Optional | |
externalMemo (anyOf 1) | string | Alternative | |
externalMemo (anyOf 2) | null | Alternative | |
failedAt | JSON | Optional | |
failedAt (anyOf 1) | JSON | Alternative | |
failedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
failedAt (anyOf 2) | null | Alternative | |
feeId | JSON | Optional | |
feeId (anyOf 1) | JSON | Alternative | |
feeId (anyOf 1) (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
feeId (anyOf 2) | null | Alternative | |
generalLedgerCodeName | JSON | Optional | |
generalLedgerCodeName (anyOf 1) | string | Alternative | Deprecated: use transactionGlAllocations instead. This field does not reflect GL codes assigned via Mercury auto-categorization rules. Preserved for backwards compatibility. |
generalLedgerCodeName (anyOf 2) | null | Alternative | |
glAllocations | array | Required within parent | GL 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[] | Model | Each item | Expand Get transaction by ID — response body — gl Allocations item |
hasGeneratedReceipt | boolean | Required within parent | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
kind | JSON | Required within parent | |
kind (allOf 1) | Model | All variants apply | Expand Get transaction by ID — response body — kind string |
merchant | JSON | Optional | |
merchant (anyOf 1) | JSON | Alternative | |
merchant (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transaction by ID — response body — merchant amount, category, category Code, currency, id Merchant information for card transactions |
merchant (anyOf 1) (allOf 2) | JSON | All variants apply | Merchant 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) | null | Alternative | |
mercuryCategory | JSON | Optional | |
mercuryCategory (anyOf 1) | JSON | Alternative | |
mercuryCategory (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a card — response body — category Locks item |
mercuryCategory (anyOf 2) | null | Alternative | |
note | JSON | Optional | |
note (anyOf 1) | string | Alternative | |
note (anyOf 2) | null | Alternative | |
postedAt | JSON | Optional | |
postedAt (anyOf 1) | JSON | Alternative | |
postedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
postedAt (anyOf 2) | null | Alternative | |
reasonForFailure | JSON | Optional | |
reasonForFailure (anyOf 1) | string | Alternative | |
reasonForFailure (anyOf 2) | null | Alternative | |
relatedTransactions | array | Required within parent | |
relatedTransactions[] | Model | Each item | Expand Get transaction by ID — response body — related Transactions item |
requestId | JSON | Optional | |
requestId (anyOf 1) | string | Alternative | |
requestId (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: pending, sent, cancelled, failed, reversed, blocked |
trackingNumber | JSON | Optional | |
trackingNumber (anyOf 1) | string | Alternative | Present for transactions that have tracking numbers (e.g., RTP, ACH, wires); Nothing otherwise. |
trackingNumber (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A transaction's accounting review and sync status, for the accounting integration connected to the organization (e.g. QuickBooks, Xero, NetSuite). |
erroredAt | JSON | Optional | |
erroredAt (anyOf 1) | JSON | Alternative | |
erroredAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
erroredAt (anyOf 1) (allOf 2) | JSON | All variants apply | When the sync of the transaction to the accounting integration failed. Null if it has not failed. |
erroredAt (anyOf 2) | null | Alternative | |
excludedAt | JSON | Optional | |
excludedAt (anyOf 1) | JSON | Alternative | |
excludedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
excludedAt (anyOf 1) (allOf 2) | JSON | All variants apply | When the transaction was excluded from accounting sync. Null if it is not excluded. |
excludedAt (anyOf 2) | null | Alternative | |
reviewedAt | JSON | Optional | |
reviewedAt (anyOf 1) | JSON | Alternative | |
reviewedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
reviewedAt (anyOf 1) (allOf 2) | JSON | All variants apply | When the transaction was last marked as reviewed. Null if it has not been reviewed. |
reviewedAt (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: pending, reviewed, syncing, synced, errored, excluded |
status (allOf 2) | JSON | All variants apply | Current 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. |
syncStartedAt | JSON | Optional | |
syncStartedAt (anyOf 1) | JSON | Alternative | |
syncStartedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
syncStartedAt (anyOf 1) (allOf 2) | JSON | All variants apply | When 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) | null | Alternative | |
syncedAt | JSON | Optional | |
syncedAt (anyOf 1) | JSON | Alternative | |
syncedAt (anyOf 1) (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
syncedAt (anyOf 1) (allOf 2) | JSON | All variants apply | When the transaction finished syncing to the accounting integration successfully. Null if it has not finished syncing. |
syncedAt (anyOf 2) | null | Alternative |
Get transaction by ID — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachmentType | JSON | Required within parent | |
attachmentType (allOf 1) | string | All variants apply | Known values: checkImage, receipt, other |
fileName | string | Required within parent | |
url | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
convertedFromAmount | JSON | Required within parent | |
convertedFromAmount (anyOf 1) | number | Alternative | Multiple of: 0.01 |
convertedFromAmount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
convertedFromCurrency | JSON | Required within parent | |
convertedFromCurrency (allOf 1) | string | All variants apply | |
convertedToAmount | JSON | Required within parent | |
convertedToAmount (anyOf 1) | number | Alternative | Multiple of: 0.01 |
convertedToAmount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
convertedToCurrency | JSON | Required within parent | |
convertedToCurrency (allOf 1) | string | All variants apply | |
exchangeRate | JSON | Required within parent | |
exchangeRate (anyOf 1) | number | Alternative | Exchange rate goes from "from currency" to "to currency" (ie from currency * exchange rate = to currency) Multiple of: 0.0001 |
exchangeRate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
feeAmount | JSON | Required within parent | |
feeAmount (anyOf 1) | number | Alternative | Multiple of: 0.01 |
feeAmount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
feePercentage | JSON | Required within parent | |
feePercentage (anyOf 1) | number | Alternative | Multiple of: 0.0001 |
feePercentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
feeTransactionId | JSON | Optional | |
feeTransactionId (anyOf 1) | JSON | Alternative | |
feeTransactionId (anyOf 1) (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
feeTransactionId (anyOf 2) | null | Alternative |
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
postalCode | string | Required within parent | |
state | JSON | Optional | |
state (anyOf 1) | JSON | Alternative | |
state (anyOf 1) (allOf 1) | string | All variants apply | Known 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | Format: uuid |
id (allOf 2) | JSON | All variants apply | Superseded 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. |
paymentMethod | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | Format: uuid |
id (allOf 2) | JSON | All variants apply | Superseded 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | The amount allocated to this GL code Multiple of: 0.01 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
className | JSON | Optional | |
className (anyOf 1) | string | Alternative | The name of the class from the connected accounting integration, if assigned |
className (anyOf 2) | null | Alternative | |
departmentName | JSON | Optional | |
departmentName (anyOf 1) | string | Alternative | The name of the department from the connected accounting integration, if assigned |
departmentName (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional user-provided description for this allocation |
description (anyOf 2) | null | Alternative | |
glCodeName | string | Required within parent | The name of the GL code from the connected accounting integration |
Get transaction by ID — response body — kind string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Merchant information for card transactions |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
category | JSON | Optional | |
category (anyOf 1) | JSON | Alternative | |
category (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a card — response body — category Locks item |
category (anyOf 1) (allOf 2) | JSON | All variants apply | Mercury category for the merchant (e.g., "Restaurants", "Software") |
category (anyOf 2) | null | Alternative | |
categoryCode | JSON | Optional | |
categoryCode (anyOf 1) | string | Alternative | 4-digit merchant category code (MCC) for card transactions |
categoryCode (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | JSON | Alternative | |
currency (anyOf 1) (allOf 1) | string | All variants apply | |
currency (anyOf 1) (allOf 2) | JSON | All variants apply | ISO 4217 currency code of the merchant's currency (e.g., "EUR", "GBP", "JPY"). Nothing if not available. |
currency (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Merchant ID for card transactions |
id (anyOf 2) | null | Alternative |
Referenced models: Get a card — response body — category Locks item
Get transaction by ID — response body — related Transactions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Public API version of RelatedTransactionData. |
accountId | JSON | Required within parent | |
accountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
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]+)?$ |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for this transaction Format: uuid |
relationKind | JSON | Required within parent | |
relationKind (allOf 1) | Model | All variants apply | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Maximum: 9223372036854776000 Minimum: -9223372036854776000 |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
transactions | array | Required within parent | |
transactions[] | Model | Each item | Expand Get transaction by ID — response body |
Referenced models: Get transaction by ID — response body
Request to send money — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amount | JSON | Required within parent | Amount of USD you want to send, must be a positive number. |
amount (allOf 1) | number | All variants apply | A positive dollar amount with at least 1 cent. Format: double Minimum: 0.01 |
chargeType | string | Optional | Who 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 |
duplicateCheckOverride | boolean | Optional | Set 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. |
externalMemo | string | Optional | Optional external memo Maximum length: 299 |
idempotencyKey | string | Required within parent | Unique string identifying the transaction |
note | string | Optional | Optional note |
paymentMethod | JSON | Required within parent | Payment method to use. If domesticWire or internationalWire is used, then the purpose field is required. |
paymentMethod (allOf 1) | string | All variants apply | One of: ach, check, domesticWire, internationalWire, realTimePayment |
purpose | JSON | Optional | Purpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire' or 'internationalWire'. |
purpose (allOf 1) | Model | All variants apply | Expand Request to send money — request body — body purpose External API representation of Send Money Purpose |
recipientId | JSON | Required within parent | Recipient ID from the /recipients endpoint. |
recipientId (allOf 1) | string | All variants apply | ID 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | External API representation of SendMoneyPurpose. Only exposes the 'simple' field to decouple internal implementation from external API. Additional keys: not allowed |
simple | JSON | Optional | |
simple (anyOf 1) | JSON | Alternative | |
simple (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
additionalInfo | string | Optional | Additional information. Required for: Vendor (vendor name), Contractor (contractor name), Other (payment description). Optional for Subsidiary (subsidiary name). Not accepted for any other categories. |
category | string | Required within parent | Payment category. One of: employee, landlord, vendor, contractor, subsidiary, transferToMyExternalAccount, familyMemberOrFriend, forGoodsOrServices, angelInvestment, savingsOrInvestments, expenses, travel, other |
Request to send money — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A pending or completed approval request for a Mercury payment. |
accountId | JSON | Required within parent | |
accountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
amount | JSON | Required within parent | |
amount (allOf 1) | Model | All variants apply | Expand Request to send money — response body — amount value |
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 | Time at which the payment request was created. |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
memo (anyOf 2) | null | Alternative | |
numberOfApproversRequired | JSON | Optional | |
numberOfApproversRequired (anyOf 1) | JSON | Alternative | |
numberOfApproversRequired (anyOf 1) (anyOf 1) | integer | Alternative | Total 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numberOfApproversRequired (anyOf 2) | null | Alternative | |
paymentMethod | JSON | Required within parent | |
paymentMethod (allOf 1) | string | All variants apply | Known values: ach, check, domesticWire, internationalWire, realTimePayment |
recipientId | JSON | Required within parent | |
recipientId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
requestId | string | Required within parent | |
requestedByUserId | JSON | Required within parent | |
requestedByUserId (allOf 1) | string | All variants apply | ID for the user Format: uuid |
requestedByUserId (allOf 2) | JSON | All variants apply | The user who created the payment request. |
requesterMayApprove | JSON | Optional | |
requesterMayApprove (anyOf 1) | boolean | Alternative | True 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) | null | Alternative | |
reviews | array | Required within parent | Approval decisions recorded against this request, ordered from oldest to most recent. |
reviews[] | Model | Each item | Expand Request to send money — response body — reviews item |
scheduledSendDate | JSON | Optional | |
scheduledSendDate (anyOf 1) | JSON | Alternative | |
scheduledSendDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
scheduledSendDate (anyOf 1) (allOf 2) | JSON | All variants apply | Date 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) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | number | Alternative | A positive dollar amount with at least 1 cent. Format: double Minimum: 0.01 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Request to send money — response body — reviews item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reviewedAt | JSON | Required within parent | |
reviewedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
reviewerUserId | JSON | Required within parent | |
reviewerUserId (allOf 1) | string | All variants apply | ID for the user Format: uuid |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: approved, rejected |
Send money to a recipient — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amount | JSON | Required within parent | Amount of USD you want to send, must be a positive number. |
amount (allOf 1) | number | All variants apply | A positive dollar amount with at least 1 cent. Format: double Minimum: 0.01 |
duplicateCheckOverride | boolean | Optional | Set 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. |
externalMemo | string | Optional | Optional external memo Maximum length: 299 |
idempotencyKey | string | Required within parent | Unique string identifying the transaction |
note | string | Optional | Optional note |
paymentMethod | JSON | Required within parent | If domesticWire is used, then the purpose field is required. |
paymentMethod (allOf 1) | string | All variants apply | One of: ach, check, domesticWire, realTimePayment |
purpose | JSON | Optional | Purpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire'. |
purpose (allOf 1) | Model | All variants apply | Expand Request to send money — request body — body purpose External API representation of Send Money Purpose |
recipientId | JSON | Required within parent | Recipient ID from the /recipients endpoint. |
recipientId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
Referenced models: Request to send money — request body — body purpose External API representation of Send Money Purpose