The developer tools (Agent Skills, the plugin, and the CLI) use your API key and default to the sandbox. The MCP Server connects an assistant to your live business data with your HitPay login. It can create payment links, invoices, products, and plans, but it can’t issue refunds, move money, or change settings.
One-step setup
- Claude Code
- Cursor
- ChatGPT
- Windsurf
Install the HitPay plugin from inside Claude Code:Then set Run
HITPAY_API_KEY, HITPAY_SALT, and HITPAY_ENV=sandbox as described in the plugin guide, and ask: “Add PayNow checkout to my Next.js app.”To connect Claude Code to your live business data as well, add the MCP Server:/mcp, select hitpay, and choose Authenticate.Test webhooks from your terminal
Whichever assistant you use, the HitPay CLI helps you test the code it writes. It needs Node.js 18 or later.hitpay listen tunnels HitPay webhooks to your local server, and hitpay trigger sends test events to it.
HitPay for Vercel
If you deploy on Vercel, HitPay for Vercel connects your HitPay account to your projects with a HitPay sign-in, so there are no API keys to copy. Install the HitPay integration from the Vercel Marketplace and choose your projects. Each project gets aHITPAY_ACCESS_TOKEN environment variable that can create and read payments. Redeploy to pick it up.
If you build with v0 or another AI coding tool, install the integration on the project the app deploys to rather than pasting a token into an environment variable form. You can also point your agent at this llms.txt file, which tells AI coding tools how to get a HitPay token instead of asking you for credentials.
The integration connects live HitPay accounts, so payments made while testing are real. To use scopes the integration doesn’t request, or to avoid storing a token in your project, use Vercel Connect.
WebMCP for browser agents
WebMCP is for agents that act on behalf of a payer in the browser, not for building integrations or reading your business data. WebMCP is a proposed web standard that lets a page register structured tools for an AI agent running in the user’s browser. HitPay registers these tools on two pages:- HitPay online store: search products, read product details, manage the cart, and fill the store’s checkout form (
search_products,get_product,add_to_cart,set_customer_details, and others). No online store tool submits payment. - HitPay checkout page: read the checkout, list payment methods, fill the payer’s details, select a method, get the QR code while one is on screen, and pay by card (
get_checkout_summary,list_payment_methods,fill_checkout_form,select_payment_method,get_payment_qr,submit_payment).
submit_payment is marked with the consequentialHint annotation: get the user’s confirmation before calling it. HitPay also asks the payer to confirm the merchant, amount, and currency on the page. Values that come from the merchant carry untrustedContentHint and should be treated as data, not instructions.
LLM-ready docs
Every page in these docs is available in formats that AI tools can read directly:llms.txt: an index of every page with a one-line summary, grouped by sectionllms-full.txt: the full text of every page in one file- Markdown pages: add
.mdto any page URL, for example/apis/guide/sandbox.md - OpenAPI spec: the full API definition
Prompts to try
FAQ
Which tool should I start with?
Which tool should I start with?
If you’re building an integration in Claude Code, start with the plugin. In Cursor, Copilot, or Windsurf, install Agent Skills. To ask questions about your own sales and payouts, connect the MCP Server. If your app runs on Vercel, install HitPay for Vercel. See the comparison in the AI tools overview.
Do the developer tools work with the sandbox?
Do the developer tools work with the sandbox?
Yes. The plugin and the CLI default to the sandbox, and Agent Skills generate code that reads the API URL from your environment. The MCP Server works with live accounts only.
Can an AI assistant issue refunds or payouts through HitPay?
Can an AI assistant issue refunds or payouts through HitPay?
Not through the MCP Server or the plugin: both exclude destructive operations by design. Code your assistant writes runs with whatever API key you give it, so review it before using a production key.
Where do I find my API key and webhook salt?
Where do I find my API key and webhook salt?
The API key is under Settings → API Keys in the dashboard. Each webhook endpoint you create under Developers → Webhook Endpoints has its own salt, used to verify
Hitpay-Signature.