Skip to content

Mercury: Request to send money

Mercury accounts.requestSendMoney: arguments, response, policy and SDK examples.

← Accounts operations · Get started

Operation mercury.requestsendmoney

Provider route: POST /account/{accountId}/request-send-money. 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["accounts"]["requestSendMoney"]>[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.accounts.requestSendMoney(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.accounts.request_send_money(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parentID for a Mercury account.
Format: uuid
bodyModelOptionalExpand Request to send money — request body — body

Referenced models: Request to send 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 send money — response body

Referenced models: Request to send money — response body

Request to send money — response body
FieldTypePresenceDescription and constraints
$objectRootA pending or completed approval request for a Mercury payment.
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
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 applyTime at which the payment request was created.
memoJSONOptional
memo (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
memo (anyOf 2)nullAlternative
numberOfApproversRequiredJSONOptional
numberOfApproversRequired (anyOf 1)JSONAlternative
numberOfApproversRequired (anyOf 1) (anyOf 1)integerAlternativeTotal 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numberOfApproversRequired (anyOf 2)nullAlternative
paymentMethodJSONRequired within parent
paymentMethod (allOf 1)stringAll variants applyKnown values: ach, check, domesticWire, internationalWire, realTimePayment
recipientIdJSONRequired within parent
recipientId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
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 created the payment request.
requesterMayApproveJSONOptional
requesterMayApprove (anyOf 1)booleanAlternativeTrue 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)nullAlternative
reviewsarrayRequired within parentApproval decisions recorded against this request, ordered from
oldest to most recent.
reviews[]ModelEach itemExpand Request to send money — response body — reviews item
scheduledSendDateJSONOptional
scheduledSendDate (anyOf 1)JSONAlternative
scheduledSendDate (anyOf 1) (allOf 1)stringAll variants applyFormat: date
scheduledSendDate (anyOf 1) (allOf 2)JSONAll variants applyDate 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)nullAlternative
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 send money — request body — body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountJSONRequired within parentAmount of USD you want to send, must be a positive number.
amount (allOf 1)numberAll variants applyA positive dollar amount with at least 1 cent.
Format: double
Minimum: 0.01
chargeTypestringOptionalWho 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
duplicateCheckOverridebooleanOptionalSet 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.
externalMemostringOptionalOptional external memo
Maximum length: 299
idempotencyKeystringRequired within parentUnique string identifying the transaction
notestringOptionalOptional note
paymentMethodJSONRequired within parentPayment method to use. If domesticWire or internationalWire is used, then the purpose field is required.
paymentMethod (allOf 1)stringAll variants applyOne of: ach, check, domesticWire, internationalWire, realTimePayment
purposeJSONOptionalPurpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire' or 'internationalWire'.
purpose (allOf 1)ModelAll variants applyExpand Request to send money — request body — body purpose External API representation of Send Money Purpose
recipientIdJSONRequired within parentRecipient ID from the /recipients endpoint.
recipientId (allOf 1)stringAll variants applyID 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 — 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
Request to send money — request body — body purpose External API representation of Send Money Purpose
FieldTypePresenceDescription and constraints
$objectRootExternal API representation of SendMoneyPurpose.
Only exposes the 'simple' field to decouple internal implementation from external API.
Additional keys: not allowed
simpleJSONOptional
simple (anyOf 1)JSONAlternative
simple (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
additionalInfostringOptionalAdditional information. Required for: Vendor (vendor name), Contractor (contractor name), Other (payment description). Optional for Subsidiary (subsidiary name). Not accepted for any other categories.
categorystringRequired within parentPayment category.
One of: employee, landlord, vendor, contractor, subsidiary, transferToMyExternalAccount, familyMemberOrFriend, forGoodsOrServices, angelInvestment, savingsOrInvestments, expenses, travel, other

SDK function policy ID: mercury.requestsendmoney. Catalog operation: mercury:requestSendMoney. 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.