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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of transfer approval requests. |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the transfer money approval request Format: uuid |
page.previousPage | string | Optional | ID for the transfer money approval request Format: uuid |
requests | array | Required within parent | |
requests[] | Model | Each item | Expand Request to transfer money — response body |
Referenced models: Request to transfer money — response body
Request to transfer money — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters for requesting a transfer between two accounts. 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 |
Request to transfer money — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An approval request for a transfer between accounts. |
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 | When the request was created. |
destinationAccountId | JSON | Required within parent | |
destinationAccountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
destinationAccountId (allOf 2) | JSON | All variants apply | The account the money is sent to. |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo that appears on the resulting transaction. |
memo (anyOf 2) | null | Alternative | |
note | JSON | Optional | |
note (anyOf 1) | string | Alternative | Internal note recorded on the request. Not shown to any counterparty. |
note (anyOf 2) | null | Alternative | |
numberOfApproversRequired | JSON | Optional | |
numberOfApproversRequired (anyOf 1) | JSON | Alternative | |
numberOfApproversRequired (anyOf 1) (anyOf 1) | integer | Alternative | Number of approvals required before the transfer is sent. Maximum: 9223372036854776000 Minimum: -9223372036854776000 |
numberOfApproversRequired (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numberOfApproversRequired (anyOf 2) | null | Alternative | |
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 requested the transfer. |
requesterMayApprove | JSON | Optional | |
requesterMayApprove (anyOf 1) | boolean | Alternative | Whether the requester may approve this request. Omitted whenever numberOfApproversRequired is omitted. |
requesterMayApprove (anyOf 2) | null | Alternative | |
reviews | array | Required within parent | Approval decisions recorded on this request, oldest first. |
reviews[] | Model | Each item | Expand Request to send money — response body — reviews item |
sourceAccountId | JSON | Required within parent | |
sourceAccountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
sourceAccountId (allOf 2) | JSON | All variants apply | The account the money is sent from. |
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