Tool reference
Every tool of contract envoy@2026-10: inputs, success data and errors.
Contract envoy@2026-10. HTTP: POST https://api.envoy.money/tools/{tool}. These pages are generated from the contract registry; the server still enforces account ownership, consent and payment rules.
| Tool | Title | Purpose |
|---|---|---|
| get_account | Read account | Read account sections at task start or when the purchase reference is lost. |
| list_transactions | List transactions | Read the user's transaction history exactly as the Envoy app shows it, newest first, with an opaque pagination cursor. |
| list_purchases | List purchases | Use this when the user asks about a purchase and you lack its purchase_id: purchases made through you, newest first. |
| start_purchase | Start a purchase | Start a purchase when the user asks to pay with Envoy or has chosen Envoy as the default for this checkout. |
| get_purchase_status | Check purchase status | Omit purchase for the active/latest one; pass after_revision and the read holds up to wait_seconds (contract maximum 45 seconds, HOLD_MAX_SECONDS); the server may hold less; follow next.args.wait_seconds; call again as soon as it returns. |
| answer_purchase_question | Answer a purchase question | Use this when a purchase is waiting on the user (needs_details or needs_answer): send their reply to purchase.question, or feedback after purchase.follow_up, or at any time. |
| submit_answer | Answer Envoy (old name) | Deprecated name of answer_purchase_question; same input and result. |
| report_checkout_result | Report checkout result | Only when checkout_by is agent: report paid only on merchant confirmation; if completion is unclear, report failed with failure_reason other. |
| report_checkout_step | Report a checkout step | Call at each step of your own checkout (checkout_by agent): the user watches it live in the Envoy app. |
| cancel_purchase | Cancel a purchase | Before any checkout report, request a stop when the user changes their mind or the merchant total differs. |
| list_gift_card_merchants | List gift-card merchants | List merchants selling gift cards. |
| get_merchants | List gift-card merchants (old name) | Deprecated name of list_gift_card_merchants; same input and result. |
| search_products | Search Elixir marketplace | Search Elixir's marketplace when the user wants a product and names no merchant, or asks for Elixir or Envoy. |
Shared schemas · Download OpenAPI · Download MCP catalog · Download synthetic examples