Skip to content

Mercury: Transfer money requests schemas

3 Mercury schemas with complete fields and constraints.

← Transfer money requests operations · All schemas

List transfer approval requests — response body

FieldTypePresenceDescription and constraints
$objectRootA page of transfer approval requests.
pageobjectRequired within parent
page.nextPagestringOptionalID for the transfer money approval request
Format: uuid
page.previousPagestringOptionalID for the transfer money approval request
Format: uuid
requestsarrayRequired within parent
requests[]ModelEach itemExpand Request to transfer money — response body

Referenced models: Request to transfer money — response body

Request to transfer money — request body — body

FieldTypePresenceDescription and constraints
$objectRootParameters for requesting a transfer between two accounts.
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

Request to transfer money — response body

FieldTypePresenceDescription and constraints
$objectRootAn approval request for a transfer between accounts.
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 applyWhen the request was created.
destinationAccountIdJSONRequired within parent
destinationAccountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
destinationAccountId (allOf 2)JSONAll variants applyThe account the money is sent to.
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo that appears on the resulting transaction.
memo (anyOf 2)nullAlternative
noteJSONOptional
note (anyOf 1)stringAlternativeInternal note recorded on the request. Not shown to any counterparty.
note (anyOf 2)nullAlternative
numberOfApproversRequiredJSONOptional
numberOfApproversRequired (anyOf 1)JSONAlternative
numberOfApproversRequired (anyOf 1) (anyOf 1)integerAlternativeNumber of approvals required before the transfer is sent.
Maximum: 9223372036854776000
Minimum: -9223372036854776000
numberOfApproversRequired (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numberOfApproversRequired (anyOf 2)nullAlternative
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 requested the transfer.
requesterMayApproveJSONOptional
requesterMayApprove (anyOf 1)booleanAlternativeWhether the requester may approve this request. Omitted whenever numberOfApproversRequired is omitted.
requesterMayApprove (anyOf 2)nullAlternative
reviewsarrayRequired within parentApproval decisions recorded on this request, oldest first.
reviews[]ModelEach itemExpand Request to send money — response body — reviews item
sourceAccountIdJSONRequired within parent
sourceAccountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
sourceAccountId (allOf 2)JSONAll variants applyThe account the money is sent from.
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

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.