Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Request to transfer money — request body — body

Referenced models: Request to transfer money — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Request to transfer money — response body

Referenced models: Request to transfer money — response body

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

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 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

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.

Official provider source

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.