> ## 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.

# Overview

> Use AI with HitPay: connect Claude to your business data with the MCP Server, or build payment integrations with the Claude Code Plugin, Agent Skills, and the HitPay CLI.

HitPay's AI tools cover two jobs: **operating your business** from an AI assistant, and **building payment integrations** by describing what you want in natural language. There are four tools. Pick the ones that match your workflow.

<CardGroup cols={2}>
  <Card title="HitPay MCP Server" icon="plug" href="/apis/guide/mcp-server">
    Connect Claude to your business data: query sales, transactions, payouts, and balances, or create payment links and invoices. Authenticates with your HitPay login over OAuth.
  </Card>

  <Card title="Claude Code Plugin" icon="microchip-ai" href="/apis/guide/claude-code-plugin">
    MCP server with 28 live API tools, 5 auto-triggered skills, and 4 slash commands for building integrations. Claude Code only.
  </Card>

  <Card title="AI Agent Skills" icon="wand-magic-sparkles" href="/apis/guide/ai-skills">
    Code-generation skills for Claude Code, Cursor, GitHub Copilot, and Windsurf. Install once, describe what you want.
  </Card>

  <Card title="HitPay CLI" icon="terminal" href="/apis/guide/cli">
    Drive the API from your terminal, scripts, and CI pipelines. Test webhooks locally with `hitpay listen` and `hitpay trigger`.
  </Card>
</CardGroup>

## Which tool should I use?

|                                            |            MCP Server            |          Claude Code Plugin          |          Agent Skills         |       HitPay CLI      |
| ------------------------------------------ | :------------------------------: | :----------------------------------: | :---------------------------: | :-------------------: |
| **Best for**                               | Chatting with your business data | Building integrations in Claude Code | Code generation in any AI IDE | Scripts, CI, terminal |
| **Authentication**                         |       HitPay login (OAuth)       |                API key               |            API key            |        API key        |
| **Requires coding**                        |                 ✗                |                   ✓                  |               ✓               |           ✓           |
| **Live data access**                       |                 ✓                |                   ✓                  |               ✗               |           ✓           |
| **Code generation**                        |                 ✗                |                   ✓                  |               ✓               |           ✗           |
| **Webhook testing**                        |                 ✗                |                   ✓                  |               ✓               |           ✓           |
| **Works with Cursor / Copilot / Windsurf** |                 ✗                |                   ✗                  |               ✓               |           —           |
| **Sandbox support**                        |                 ✗                |              ✓ (default)             |               ✓               |      ✓ (default)      |

### Recommended choices

* **Querying your own business data?** Connect the [MCP Server](/apis/guide/mcp-server) to Claude to look up sales, payouts, and transactions.
* **Using Claude Code to build an integration?** Start with the [Claude Code Plugin](/apis/guide/claude-code-plugin), which combines live API access with auto-triggered skills. Add Agent Skills for offline code generation templates.
* **Using Cursor, Copilot, or Windsurf?** Install [Agent Skills](/apis/guide/ai-skills). It works with any AI coding assistant and generates code from natural language prompts.
* **Scripting, CI, or terminal work?** Use the [HitPay CLI](/apis/guide/cli), especially for webhook development with `hitpay listen` and `hitpay trigger`.

The tools can be used together; for example, the MCP Server for checking data while the CLI handles webhook testing.

## Prerequisites

The **MCP Server** only needs a HitPay account. You sign in as an owner or admin of the business when connecting.

The three developer tools require API credentials:

1. **HitPay Account**: [create an account](https://dashboard.hit-pay.com) or use the [sandbox environment](https://dashboard.sandbox.hit-pay.com)
2. **API Key**: found in **Settings → Payment Gateway → API Keys**
3. **Webhook Salt**: found in **Settings → Developers → Webhook Endpoints**

<Tip>
  When building integrations, always start in **sandbox** mode. The three developer tools default to the sandbox environment. Switch to production only when you are ready to accept real payments.
</Tip>

## Quick start by tool

### MCP Server

In [claude.ai](https://claude.ai) or the Claude desktop app, open **Settings → Connectors → Add custom connector** and enter `https://mcp.hit-pay.com/`. From Claude Code:

```bash theme={"system"}
claude mcp add --transport http hitpay https://mcp.hit-pay.com/
```

Sign in with your HitPay account, then ask: "What were my total sales last month?"

→ [Full guide](/apis/guide/mcp-server)

### Claude Code Plugin

Install inside Claude Code:

```
/plugin marketplace add hit-pay/claude-code-plugin
/plugin install hitpay@hitpay-plugins
```

Set your credentials:

```bash theme={"system"}
export HITPAY_API_KEY=your_api_key_here
export HITPAY_SALT=your_webhook_salt_here
export HITPAY_ENV=sandbox
```

Then describe what you want: "Add PayNow and GrabPay to my Next.js checkout"

→ [Full guide](/apis/guide/claude-code-plugin)

### Agent Skills

Install in your project:

```bash theme={"system"}
npx skills add hit-pay/agent-skills
```

Then prompt your AI assistant: "Add HitPay payment integration to my Next.js app"

→ [Full guide](/apis/guide/ai-skills)

### HitPay CLI

Install and log in:

```bash theme={"system"}
npm install -g @hit-pay/cli
hitpay login
```

Create a payment or test a webhook:

```bash theme={"system"}
hitpay payment create --amount 49.90 --currency SGD --email customer@example.com
hitpay listen --forward-to http://localhost:3000/api/webhooks
```

→ [Full guide](/apis/guide/cli)