Skip to content

Mercury: List send money approval requests

Mercury sendMoney.listSendMoneyApprovalRequests: arguments, response, policy and SDK examples.

← Send money operations · Get started

Operation mercury.listsendmoneyapprovalrequests

Provider route: GET /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["sendMoney"]["listSendMoneyApprovalRequests"]>[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.sendMoney.listSendMoneyApprovalRequests(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.send_money.list_send_money_approval_requests(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.accountIdstringOptionalID for a Mercury account.
Format: uuid
query.statusstringOptionalOne of: pendingApproval, approved, rejected, cancelled
query.start_afterstringOptionalThe ID of the send money approval request to start the page after (exclusive). When provided, results will begin with the send money approval request immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the send money approval request to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List send money approval requests — response body

Referenced models: List send money approval requests — response body

List send money approval requests — response body
FieldTypePresenceDescription and constraints
$objectRoot
pageobjectRequired within parent
page.nextPagestringOptionalID for the send money approval request
Format: uuid
page.previousPagestringOptionalID for the send money approval request
Format: uuid
requestsarrayRequired within parent
requests[]ModelEach itemExpand 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 — 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.listsendmoneyapprovalrequests. Catalog operation: mercury:listSendMoneyApprovalRequests. 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.