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.
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["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 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.accounts.request_send_money(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | ID for a Mercury account. Format: uuid |
body | Model | Optional | Expand Request to send money — request body — body |
Referenced models: Request to send 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 send money — response body |
Referenced models: Request to send money — response body
Schemas
Section titled “Schemas”Request to send money — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A pending or completed approval request for a Mercury payment. |
accountId | JSON | Required within parent | |
accountId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
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 | Time at which the payment request was created. |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Maximum length: 299 Minimum length: 1 |
memo (anyOf 2) | null | Alternative | |
numberOfApproversRequired | JSON | Optional | |
numberOfApproversRequired (anyOf 1) | JSON | Alternative | |
numberOfApproversRequired (anyOf 1) (anyOf 1) | integer | Alternative | Total 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numberOfApproversRequired (anyOf 2) | null | Alternative | |
paymentMethod | JSON | Required within parent | |
paymentMethod (allOf 1) | string | All variants apply | Known values: ach, check, domesticWire, internationalWire, realTimePayment |
recipientId | JSON | Required within parent | |
recipientId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
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 created the payment request. |
requesterMayApprove | JSON | Optional | |
requesterMayApprove (anyOf 1) | boolean | Alternative | True 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) | null | Alternative | |
reviews | array | Required within parent | Approval decisions recorded against this request, ordered from oldest to most recent. |
reviews[] | Model | Each item | Expand Request to send money — response body — reviews item |
scheduledSendDate | JSON | Optional | |
scheduledSendDate (anyOf 1) | JSON | Alternative | |
scheduledSendDate (anyOf 1) (allOf 1) | string | All variants apply | Format: date |
scheduledSendDate (anyOf 1) (allOf 2) | JSON | All variants apply | Date 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) | null | Alternative | |
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 send money — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amount | JSON | Required within parent | Amount of USD you want to send, must be a positive number. |
amount (allOf 1) | number | All variants apply | A positive dollar amount with at least 1 cent. Format: double Minimum: 0.01 |
chargeType | string | Optional | Who 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 |
duplicateCheckOverride | boolean | Optional | Set 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. |
externalMemo | string | Optional | Optional external memo Maximum length: 299 |
idempotencyKey | string | Required within parent | Unique string identifying the transaction |
note | string | Optional | Optional note |
paymentMethod | JSON | Required within parent | Payment method to use. If domesticWire or internationalWire is used, then the purpose field is required. |
paymentMethod (allOf 1) | string | All variants apply | One of: ach, check, domesticWire, internationalWire, realTimePayment |
purpose | JSON | Optional | Purpose of payment with category and optional additional info. Required when paymentMethod is 'domesticWire' or 'internationalWire'. |
purpose (allOf 1) | Model | All variants apply | Expand Request to send money — request body — body purpose External API representation of Send Money Purpose |
recipientId | JSON | Required within parent | Recipient ID from the /recipients endpoint. |
recipientId (allOf 1) | string | All variants apply | ID 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
| 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 |
Request to send money — request body — body purpose External API representation of Send Money Purpose
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | External API representation of SendMoneyPurpose. Only exposes the 'simple' field to decouple internal implementation from external API. Additional keys: not allowed |
simple | JSON | Optional | |
simple (anyOf 1) | JSON | Alternative | |
simple (anyOf 1) (allOf 1) | Model | All variants apply | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
additionalInfo | string | Optional | Additional information. Required for: Vendor (vendor name), Contractor (contractor name), Other (payment description). Optional for Subsidiary (subsidiary name). Not accepted for any other categories. |
category | string | Required within parent | Payment category. One of: employee, landlord, vendor, contractor, subsidiary, transferToMyExternalAccount, familyMemberOrFriend, forGoodsOrServices, angelInvestment, savingsOrInvestments, expenses, travel, other |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.