> ## Documentation Index > Fetch the complete documentation index at: https://docs.hitpayapp.com/llms.txt > Use this file to discover all available pages before exploring further. # Use the HitPay MCP Server in Claude > Connect Claude on claude.ai or Claude Desktop to your HitPay business data. Sign in with your HitPay login over OAuth — no API key. HitPay is listed in the Claude connector directory, so you do not need to paste a server URL. After you connect, Claude can query your live HitPay business data and create payment links, invoices, products, and recurring plans. The hosted server is at `https://mcp.hit-pay.com/`. Authentication uses OAuth. You sign in with your HitPay dashboard login and authorize the connection for one business. API keys are not involved. ## Setup HitPay documents this flow for claude.ai and the Claude desktop app. Connecting opens the HitPay login page in your browser. Sign in, pick which business to connect under **Connect as**, and approve. > [!WARNING] > > Only users with the owner or admin role on a business can authorize a connection. Other team-member roles (such as staff or cashier) cannot connect. **1. Open the Claude connector directory** Open the Directory in [claude.ai](https://claude.ai) or the Claude desktop app and select **Connectors**. **2. Add HitPay** Search for **HitPay** and add it, or go straight to the [HitPay listing](https://claude.ai/directory/2d134a7d-77a0-4e3f-a0e9-f644a70923d8). No URL entry is needed. **3. Connect and approve** Click **Connect**, sign in with your HitPay dashboard login, choose the business under **Connect as**, and approve access. The HitPay tools are then available in Claude's tool menu. The hosted endpoint behind the listing is `https://mcp.hit-pay.com/`. ## Example prompts The assistant selects tools automatically based on your prompt. You do not call tools directly. 1. **"What were my total sales last month, and how do they compare to the month before?"**\ Uses `get_sales_summary`, `get_growth_indicator` — Reads sales totals and the growth comparison the server exposes for a date range. 2. **"When is my next payout, and what's my current balance?"**\ Uses `get_payout_schedule`, `get_balances` — Reads payout timing and current balances. The server cannot initiate a payout or transfer. 3. **"Create a payment link for SGD 49.90 for a consultation session"**\ Uses `create_payment_link` — One of the four write tools. The link is visible in your HitPay dashboard and can be deactivated there. Other documented prompts include "Show my top-selling products this quarter", "List my recent transactions above SGD 100", "Which payment methods do I have enabled?", "Invoice [acme@example.com](mailto:acme@example.com) SGD 1,200 for March services and email it to them", "Which bills are waiting for approval?", and "List my vendors". ## Available tools The server exposes 24 tools for every connected business: 20 read tools and 4 create tools. Businesses with BillPay also get 4 extra read tools for bills and vendors. | Category | Tools | | - | - | | Sales & analytics | `get_sales_summary`, `get_top_products`, `get_sales_by_payment_method`, `get_sales_by_category`, `get_transactions_volume`, `get_channel_distribution`, `get_growth_indicator` | | Transactions | `list_charges`, `get_charge_details`, `get_charge_refunds` | | Payouts & balances | `list_payouts`, `get_payout_schedule`, `get_balances` | | Commerce records | `list_orders`, `list_invoices`, `list_payment_links`, `get_payment_link` | | BillPay | `list_bills`, `get_bill`, `list_vendors`, `get_vendor` — shown only when the business has BillPay | | Create | `create_payment_link`, `create_invoice`, `create_product`, `create_recurring_plan` | | Account | `get_payment_methods`, `get_verification_status`, `get_integrations` | Bills awaiting approval include an `approve_url` that opens the bill in the HitPay dashboard. Vendor bank details are not returned. ### Excluded operations The server does not expose: * Refunds, or cancelling and modifying transactions * Payout or transfer operations * Submitting, approving, rejecting, funding, or paying bills * Changes to account settings, payment methods, or team members The only write operations are the four `create_*` tools listed above; everything else is read-only. ## Security * OAuth 2.0 authorization code flow with PKCE. You approve access on `dashboard.hit-pay.com`, and your password is never shared with the AI assistant or client. * Business-scoped tokens: a connection can only see the business it was authorized for. * Owner and admin only: other team-member roles cannot authorize a connection. * Rate limited to 30 requests per minute per business. * Revocable: remove the connector from your MCP client to stop it making new requests. ## Frequently asked questions > [accordion] Do I need an API key? > > No. The MCP Server authenticates with your HitPay account login via OAuth. API keys are only used by the developer tools (Claude Code Plugin, Agent Skills, and the CLI). > [accordion] How is this different from the Claude Code Plugin? > > Both use the Model Context Protocol, but they serve different audiences. The hosted MCP Server authenticates with your account login and is for querying and operating your business from an AI assistant. The Claude Code Plugin runs locally inside Claude Code, authenticates with an API key, and is for developers building payment integrations. It exposes integration-focused API tools and code-generation skills. > [accordion] Is it safe to connect to my live business? > > The server exposes no destructive operations: it cannot refund, cancel, transfer money, pay bills, or change settings. The only writes are creating payment links, invoices, products, and recurring plans, all of which are visible in your dashboard and can be deactivated there. For bills awaiting approval, it returns a dashboard approve\_url instead of approving the bill. Only owner or admin users can authorize a connection, and each connection is scoped to one business. > [accordion] Can my team members connect? > > Team members with the admin role can connect, in addition to the account owner. Other roles (such as staff or cashier) cannot authorize a connection. Tokens are always scoped to the single business that was authorized. > [accordion] Does it work with the sandbox environment? > > Not yet. The MCP Server is currently available for live accounts at mcp.hit-pay.com only. > [accordion] Which AI assistants can I use? > > HitPay documents setup for Claude (web and desktop), Claude Code, Codex, and Cursor. Any other native MCP client that supports the streamable HTTP transport with OAuth and loopback (localhost) redirects also works. Web-based clients other than claude.ai are not currently allowlisted for registration. ## See also * [HitPay MCP Server](https://docs.hitpayapp.com/apis/guide/mcp-server.md) * [Use in Claude](https://docs.hitpayapp.com/apis/guide/mcp-server/claude.md) * [Use in Cursor](https://docs.hitpayapp.com/apis/guide/mcp-server/cursor.md) * [Use in Claude Code](https://docs.hitpayapp.com/apis/guide/mcp-server/claude-code.md) * [Claude Code Plugin](https://docs.hitpayapp.com/apis/guide/claude-code-plugin.md) * [AI Developer Tools Overview](https://docs.hitpayapp.com/apis/guide/ai-developer-tools.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.