First success
Every setup path ends with one read-only account call. Run it to confirm your connection works.
Every setup path ends here, with one read-only get_account call. No write tool is called. No purchase is started.
Read this page after you connect an agent or integration. Run the call, check the result, then decide your next step.
Support revision: envoy@2026-10. Last updated: 28 October 2026.
Connect one way
- For a supported MCP host, follow Connect your assistant.
- For an agent that can use a browser, follow Envoy for browser agents.
- For your own integration, follow the MCP quickstart or the HTTP API quickstart.
Follow the sign-in steps for the route you chose. Keep any access token in private storage.
Before your first purchase, read Before you start.
Read the account
Call get_account with an empty argument object: {}. Use the tab for your route.
Call the get_account tool with {}.
Success: the result does not have isError: true,
and structuredContent.account is present.
Check structuredContent.account.services for purchase.What success proves
Your Envoy account read succeeded. No purchase was started. If purchase appears in the returned services list, the purchase service is enabled for this account and connection. This check does not prove KYC readiness or that a live checkout will succeed. Before buying anything, review the purchase guide and confirm the merchant and amount with the account owner.
If purchase is missing from the services list: the connection can read this account, but purchases are not enabled here. Stop before creating a purchase and follow the service-availability guidance in Availability. Do not label a successful account read a connection failure.
If active_purchase is non-null, a purchase is already open. Recover it with get_purchase_status, or ask the user to resolve it in the Envoy app. Recover it first; start a different purchase only if the user asks. See Account.
Next
Both steps are optional.
- Install skills: Skills.
- Read the purchase guide: Purchase walkthrough.