Mercury: Request to transfer money
Mercury transferMoneyRequests.requestTransferMoney: arguments, response, policy and SDK examples.
← Transfer money requests operations · Get started
Operation mercury.requesttransfermoney
Provider route: POST /request-transfer. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["transferMoneyRequests"]["requestTransferMoney"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.transferMoneyRequests.requestTransferMoney(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.transfer_money_requests.request_transfer_money(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Request to transfer money — request body — body |
Referenced models: Request to transfer money — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Request to transfer money — response body |
Referenced models: Request to transfer money — response body
Schemas
Section titled “Schemas”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
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 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.requesttransfermoney. Catalog operation: mercury:requestTransferMoney. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.