Mercury: List transfer approval requests
Mercury transferMoneyRequests.listTransferMoneyApprovalRequests: arguments, response, policy and SDK examples.
← Transfer money requests operations · Get started
Operation mercury.listtransfermoneyapprovalrequests
Provider route: GET /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"]["listTransferMoneyApprovalRequests"]>[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.listTransferMoneyApprovalRequests(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.list_transfer_money_approval_requests(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.sourceAccountId | string | Optional | ID for a Mercury account. Format: uuid |
query.destinationAccountId | string | Optional | ID for a Mercury account. Format: uuid |
query.status | string | Optional | One of: pendingApproval, approved, rejected, cancelled |
query.start_at | string | Optional | The ID of the transfer approval request to start the page at (inclusive). Cannot be combined with start_after or end_before. Format: uuid |
query.start_after | string | Optional | The ID of the transfer approval request to start the page after (exclusive). When provided, results will begin with the transfer 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_before | string | Optional | The ID of the transfer 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.limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
query.order | string | Optional | Sort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’ Default: asc One of: asc, desc |
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 List transfer approval requests — response body |
Referenced models: List transfer approval requests — response body
Schemas
Section titled “Schemas”List transfer approval requests — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of transfer approval requests. |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the transfer money approval request Format: uuid |
page.previousPage | string | Optional | ID for the transfer money approval request Format: uuid |
requests | array | Required within parent | |
requests[] | Model | Each item | Expand Request to transfer money — response body |
Referenced models: Request to transfer money — response body
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 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.listtransfermoneyapprovalrequests. Catalog operation: mercury:listTransferMoneyApprovalRequests. 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.