get_account

MCP tool get_account, called with tools/call on https://api.envoy.money/mcp (Streamable HTTP).

Read account sections at task start or when the purchase reference is lost. Defaults to balance, services, active_purchase and held_purchases (money in open agent purchases, separate from held by the bank). Add profile for the user's name, verified mobile and email, or addresses for saved delivery addresses to fill checkout forms. Never returns card details.

Title	Service	Read only	Destructive	Idempotent	External sites
Read account	shared	true	false	true	false

The text content is a plain-English briefing, then one line of JSON with the slim agent data. structuredContent holds that same slim data. isError is true when the call failed and changed nothing. Diagnostics for support are in _meta["money.envoy/support"]; they are not for the model. Tool annotations describe effects; they do not grant permission. The HTTP API returns the full envelope: see the API reference page.

Input

Prop

Type

Unknown fields are rejected. The exact input schema is on the schemas page.

Synthetic request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_account",
    "arguments": {}
  }
}

Success data

The text content opens with a briefing: one to three sentences for the user, then What to do: for the agent. Tell the user the first part in your own words and do what What to do says. One JSON line follows with these fields. Pass next.args unchanged to next.tool. Never show the JSON line, ids or codes to the user. Outputs may gain fields, so ignore ones you do not recognize.

Field	Required	Type	Description and rules
`spending_closed`	No	`boolean`	Spending access is closed: no further card details are released. It does not prove the issuer blocked the card, and recovery of any money continues separately.
`situation`	No	`"needs_details" \| "needs_answer" \| "waiting_for_user" \| "working" \| "ready" \| "confirming" \| "done" \| "stopped" \| "needs_support"`	Where the purchase stands. The English briefing above says what it means.
`money`	No	`"not_charged" \| "set_aside" \| "charged" \| "refunding" \| "refunded" \| "unknown"`	What has happened to the user's money.
`purchase_id`	No	`string`	Pass as purchase in later calls. Never show it to the user.
`checkout_by`	No	`"agent" \| "envoy"`	Who completes the merchant checkout. agent: you pay once with the one-time card Envoy releases. envoy: Envoy checks out itself; no card is released, so never open the merchant payment step. Absent until Envoy decides; it can change, so act on the latest reply.
`next`	No	`object`	The call to make next: tool, args (pass verbatim) and wait_seconds before calling.
`purchase`	No	`object or null`	question: the open question while situation is needs_answer or needs_details: id, kind and prompt. Show the user prompt word for word. funding: only for a gift-card pay_link task, the URL the user pays, amount and expiry. Never an approval link.
`follow_up`	No	`object`	Optional feedback call after a completed purchase: tool and args. Add the user's words as answer.
`retry`	No	`"same_call" \| "after_fix" \| "check_status_first" \| "new_purchase" \| "no"`	Whether and how to retry.
`fix`	No	`array`	Input fields to fix before retrying.
`card`	No	`object`	One-time card, only while ready.
`support_ref`	No	`string`	Give this to the user only if they ask for help.
`account`	No	`object`	Requested account sections.
`transactions`	No	`array`	Spending transactions.
`next_cursor`	No	`string`	Pass as cursor to list_transactions for the next page.

Synthetic result

Example synthetic-compatible-payload (synthetic data, the MCP text content; JSON is formatted here for reading but arrives on one line):

Envoy account: balance ₹5,000.00, available to spend ₹5,000.00, held by bank ₹0.00.

What to do: Use this only as far as the user's task needs it; Envoy needs nothing more.

{
  "account": {
    "currency": "INR",
    "balance": {
      "minor": 500000,
      "currency": "INR",
      "display": "₹5,000.00"
    },
    "held": {
      "minor": 0,
      "currency": "INR",
      "display": "₹0.00"
    },
    "spendable": {
      "minor": 500000,
      "currency": "INR",
      "display": "₹5,000.00"
    },
    "services": [
      "purchase"
    ],
    "active_purchase": null,
    "unavailable": []
  }
}

Errors

A failure sets isError to true and changes nothing. The briefing says what happened and what to do; retry and fix in the JSON line say whether and how to retry. Branch on those, not on a code: these common codes appear only in _meta["money.envoy/support"], for support. See all error codes for the complete contract list.

Code	HTTP status	Meaning	What the agent does
`INVALID_INPUT`	400	Fix the supplied input.	Fix the fields listed in the data below and make the same call again.
`UNAUTHENTICATED`	401	Reconnect through Central Auth.	Ask the user to reconnect Envoy, then try again.
`UNAVAILABLE`	503	The service is unavailable; follow retryable and next.	Wait, then make the same call again. Don't pay any other way meanwhile.

Downloads

OpenAPI · MCP catalog · Synthetic examples · Schemas