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

# HitPay Meta Muse Connector

> Connect HitPay in Meta Muse via official Connectors or a Custom Connector backup. Create payment links, PayNow and SEA checkouts, invoices, and view charges.

To connect **HitPay to Meta Muse**, use the official **HitPay** connector in Muse **Connectors** (ask Muse to connect HitPay, or **Settings → Connectors → HitPay**, then authorize when prompted). If HitPay is not listed yet, use the **[Custom Connector backup](#backup-hitpay-custom-connector-in-muse)** with a Business API key and the paste prompt below. Once connected, you can create **payment links** (including **PayNow** and other **Southeast Asia** methods), **invoices**, products, subscription plans, and **list or check charges** — not refunds or payouts.

<Info>
  **Recommended:** Official **HitPay** in Muse **Connectors** (Meta-reviewed directory connector). **Backup:** [Custom Connector](#backup-hitpay-custom-connector-in-muse) with `X-BUSINESS-API-KEY` and the paste prompt — for private setups or when the directory listing is not visible yet. There is no public web URL for the Muse listing; you connect from inside Muse.
</Info>

## How to connect HitPay in Meta Muse

The official **HitPay Meta Muse connector** is listed in Muse's **Connectors** directory. Meta reviews directory connectors; you do not need to paste a system prompt or manage API keys for this path.

<Steps>
  <Step title="Open Connectors in Muse">
    Either ask Muse something like **"Connect HitPay"**, or go to **Settings → Connectors**, find **HitPay**, and choose **Connect**.
  </Step>

  <Step title="Authorize HitPay">
    Follow the steps Muse shows to authorize HitPay (for example sign-in or approval prompts). Use a [HitPay account](https://dashboard.hit-pay.com) with access to the business you want to manage.
  </Step>

  <Step title="Try an example ask">
    Once connected, ask Muse to create a payment link, list charges, or create an invoice — see [What you can do with HitPay in Muse](#what-you-can-do-with-hitpay-in-muse).
  </Step>
</Steps>

<Tip>
  Connector availability can roll out by **region** or **Muse client**. If you do not see **HitPay** under Connectors, use the [Custom Connector backup](#backup-hitpay-custom-connector-in-muse) or check again after Meta's rollout reaches your account.
</Tip>

## What you can do with HitPay in Muse

After you connect the **HitPay Muse connector**, you can use natural language to:

* Create **payment links** and checkout URLs (cards and local methods your account supports)
* Create **PayNow** and other **SEA** payment requests — for example PayNow (`paynow_online`), FPX, QRIS, GCash, and GrabPay (see [payment methods reference](/apis/guide/payment-methods-reference) and [online payments](/apis/guide/online-payments))
* Create **invoices**, **products**, and **subscription plans**
* **List charges** and check **payment request** status

### Recommended use (safe create + read)

Like other HitPay AI surfaces ([MCP Server](/apis/guide/mcp-server), [AI developer tools](/apis/guide/ai-developer-tools)), use Muse for **creating** payment requests, invoices, products, and subscription plans and **reading** charges and status — not for refunds, payouts, or destructive money moves. For refunds, transfers, team admin, or account settings, use the [HitPay Dashboard](https://dashboard.hit-pay.com).

### Example asks

* "Create a PayNow payment link for SGD 25 for a workshop deposit."
* "Create an invoice for SGD 150 due in 7 days for [jane@example.com](mailto:jane@example.com)."
* "List my last 10 charges."
* "What's the status of my latest payment request?"

## Backup: HitPay Custom Connector in Muse

Use the **HitPay Muse Custom Connector** only when the **official HitPay connector** is not available or you need a **private** API-key setup. Muse calls the HitPay REST API using the [OpenAPI spec](https://docs.hitpayapp.com/openapi.json). This path uses **`X-BUSINESS-API-KEY`**, not the Muse Connectors authorization flow.

### Authentication and environments

| Setting     | Value                                                                                              |
| ----------- | -------------------------------------------------------------------------------------------------- |
| **Header**  | `X-BUSINESS-API-KEY` (from HitPay Dashboard → **API Keys**)                                        |
| **Sandbox** | `https://api.sandbox.hit-pay.com`                                                                  |
| **Live**    | `https://api.hit-pay.com`                                                                          |
| **OpenAPI** | [https://docs.hitpayapp.com/openapi.json](https://docs.hitpayapp.com/openapi.json)                 |
| **Docs**    | [docs.hitpayapp.com](https://docs.hitpayapp.com) · [llms.txt](https://docs.hitpayapp.com/llms.txt) |

Southeast Asia payment methods (via `payment_methods` on create calls) include PayNow (`paynow_online`), FPX, QRIS, GCash, GrabPay, cards, and other methods enabled on your account.

<Warning>
  Store the API key only in Muse's **Secure Credentials Store** when prompted. Never paste the key into chat or into the connector prompt text.
</Warning>

### Merchant setup (4 steps)

<Steps>
  <Step title="Create an API key">
    In the HitPay Dashboard, open **API Keys**. Prefer **sandbox** first ([sandbox dashboard](https://dashboard.sandbox.hit-pay.com)).
  </Step>

  <Step title="Add the Custom Connector prompt">
    Paste the [full prompt](#copy-paste-muse-custom-connector-prompt) below into Muse as Custom Connector / system instructions.
  </Step>

  <Step title="Save credentials securely">
    When Muse asks for credentials, add your Business API key to Muse's **Secure Credentials Store** only.
  </Step>

  <Step title="Try an example ask">
    Use one of the [custom connector example asks](#example-asks-custom-connector). Switch the base URL to live when you are ready for production.
  </Step>
</Steps>

<Tip>
  Start in **sandbox** until payment flows work as expected. See the [sandbox guide](/apis/guide/sandbox) for test credentials and behaviour.
</Tip>

### Allowed operations (safe create + read)

The connector should only call these endpoints:

| Action                       | Method + path                           |
| ---------------------------- | --------------------------------------- |
| Create payment request       | `POST /v1/payment-requests`             |
| List payment requests        | `GET /v1/payment-requests`              |
| Get payment request / status | `GET /v1/payment-requests/{request_id}` |
| Create invoice               | `POST /v1/invoices`                     |
| List invoices                | `GET /v1/invoices`                      |
| Create product               | `POST /v1/products`                     |
| List products                | `GET /v1/products`                      |
| Create subscription plan     | `POST /v1/subscription-plan`            |
| List subscription plans      | `GET /v1/subscription-plan`             |
| List charges                 | `GET /v1/charges`                       |
| Get charge / payment status  | `GET /v1/charges/{charge_id}`           |

Use the OpenAPI spec for request bodies and response fields. Prefer `Content-Type: application/json`.

### Explicitly forbidden

Do **not** call or expose tools for:

* **Refunds** — `POST /v1/refund`, `GET /v1/refund/{refund_id}`
* **Transfers / payouts** — `/v1/transfers`, `/v1/transfers/*`
* **Destructive DELETEs** that move or cancel money (for example delete payment request, delete subscription plan, delete recurring billing)
* **Charge saved card** — `POST /v1/charge/recurring-billing/{id}`
* **Staff / account / settings** — `/v1/staffs`, `/v1/account-status`, location create/update/delete, and similar admin endpoints

If you ask Muse for a forbidden action, it should refuse briefly and direct you to the HitPay Dashboard.

### Copy-paste: Muse Custom Connector prompt

Copy the entire block below into Muse:

```text theme={"system"}
You are a HitPay payments assistant for this merchant's Meta Muse Custom Connector.

## Docs & API
- OpenAPI (source of truth): https://docs.hitpayapp.com/openapi.json
- Human docs: https://docs.hitpayapp.com
- LLM index: https://docs.hitpayapp.com/llms.txt

## Base URLs
- Sandbox (default until merchant says live): https://api.sandbox.hit-pay.com
- Live: https://api.hit-pay.com

## Auth
- Send header: X-BUSINESS-API-KEY: <key from Secure Credentials Store>
- Never ask the merchant to paste the key into chat. Use Muse Secure Credentials Store only.
- Not browser OAuth on this connector path.

## Allowed operations ONLY (safe-create + read)
1. POST /v1/payment-requests — create payment request / PayNow or card checkout link
2. GET /v1/payment-requests — list payment requests
3. GET /v1/payment-requests/{request_id} — get payment request status
4. POST /v1/invoices — create invoice
5. GET /v1/invoices — list invoices
6. POST /v1/products — create product
7. GET /v1/products — list products
8. POST /v1/subscription-plan — create subscription plan
9. GET /v1/subscription-plan — list subscription plans
10. GET /v1/charges — list charges
11. GET /v1/charges/{charge_id} — get charge / payment status

Use OpenAPI for request bodies and response fields. Prefer JSON Content-Type: application/json.

## FORBIDDEN (never call)
- POST /v1/refund and any refund endpoints
- /v1/transfers and payouts
- DELETE on payment-requests, invoices, products, subscription-plan, recurring-billing
- POST /v1/charge/recurring-billing/{id} (charge saved card)
- /v1/staffs, account settings, and other admin/destructive money moves

If asked for a forbidden action: refuse in one sentence and point to the HitPay Dashboard.

## Behaviour
- Confirm amount, currency, and payment method before create calls when ambiguous.
- SEA APMs: PayNow (`paynow_online`), FPX, QRIS, GCash, GrabPay, cards — set `payment_methods` to what the merchant asks for (and what their account supports).
- For Singapore PayNow links, set payment_methods to include paynow_online when creating a payment request.
- After create, return the checkout URL (url) and id clearly.
- Keep answers short and merchant-clear. No internal jargon.
```

### Example asks (custom connector)

* "Create a PayNow payment link for SGD 25, purpose: Workshop deposit."
* "Create an invoice for SGD 150 due in 7 days for customer [jane@example.com](mailto:jane@example.com)."
* "List my last 10 charges."
* "What's the status of payment request `{id}`?"
* "Create a monthly subscription plan called Cafe Membership for SGD 29.90."
* "List products."

## FAQ

<AccordionGroup>
  <Accordion title="How do I connect HitPay to Meta Muse?">
    Use the official **HitPay** entry in Muse **Connectors**: ask Muse to connect HitPay, or open **Settings → Connectors**, select **HitPay**, and **Connect**, then complete the authorization steps Muse shows. If HitPay is not listed, follow the [Custom Connector backup](#backup-hitpay-custom-connector-in-muse) on this page.
  </Accordion>

  <Accordion title="Is there a public listing URL for the HitPay Muse connector?">
    **No.** HitPay is connected from **inside Meta Muse** via Connectors. There is no separate public web listing URL to share; availability may vary by region and Muse client.
  </Accordion>

  <Accordion title="Official connector vs Custom Connector — which should I use?">
    Use the **official HitPay connector** in Muse Connectors whenever it appears — no paste prompt or API key required. Use the **Custom Connector** only as a backup when the directory listing is missing or you need a private API-key setup with the [OpenAPI](https://docs.hitpayapp.com/openapi.json)-driven prompt on this page.
  </Accordion>

  <Accordion title="Can HitPay in Muse create PayNow or other SEA payment links?">
    **Yes**, for methods enabled on your HitPay account. Ask Muse to create a payment link or payment request and specify the method (for example PayNow). The Custom Connector backup sets `payment_methods` such as `paynow_online` per the prompt; the official connector follows Meta's reviewed integration. See [online payments](/apis/guide/online-payments) and [payment methods](/apis/guide/payment-methods-reference) for API details.
  </Accordion>

  <Accordion title="Does HitPay in Muse use the HitPay MCP Server or OAuth?">
    **Usually not on these paths.** The official Muse connector uses Muse's Connectors authorization flow when you connect. The Custom Connector backup uses **`X-BUSINESS-API-KEY`**, not OAuth. The separate [HitPay MCP Server](/apis/guide/mcp-server) (`https://mcp.hit-pay.com/`) is for Muse Code and other MCP clients and uses **OAuth** via HitPay dashboard login — different from both Muse connector options above.
  </Accordion>

  <Accordion title="Can Muse refund or send payouts via HitPay?">
    **No** — not as recommended behaviour. HitPay in Muse is limited to **safe create + read** (payment links, invoices, products, plans, listing charges). Use the [HitPay Dashboard](https://dashboard.hit-pay.com) for refunds, transfers, payouts, and account admin.
  </Accordion>
</AccordionGroup>

## Optional: Muse Code and Hosted MCP

For **Muse Code** or other **MCP clients**, you can use HitPay's **hosted MCP** at `https://mcp.hit-pay.com/` (OAuth via HitPay dashboard login). This is separate from the Muse Connectors directory path and from the Custom Connector API-key backup.

```json theme={"system"}
{
  "mcpServers": {
    "hitpay": {
      "url": "https://mcp.hit-pay.com/",
      "transport": "streamable_http"
    }
  }
}
```

| Path         | Official Muse connector                  | Custom Connector (backup)               | [Hosted MCP](/apis/guide/mcp-server)       |
| ------------ | ---------------------------------------- | --------------------------------------- | ------------------------------------------ |
| **Where**    | Muse Connectors directory                | Paste prompt + Secure Credentials Store | Muse Code / MCP client config              |
| **Auth**     | Muse authorization flow when you connect | `X-BUSINESS-API-KEY`                    | OAuth (owner/admin dashboard login)        |
| **Best for** | Most merchants in Muse                   | Directory not visible or private setup  | Developers on Muse Code or other MCP tools |

The hosted MCP already excludes refunds, payouts, and destructive money moves. See the [MCP Server guide](/apis/guide/mcp-server) for setup and tool list.

## Related guides

* [AI developer tools overview](/apis/guide/ai-developer-tools) — MCP Server, Claude Code Plugin, Agent Skills, and CLI
* [HitPay MCP Server](/apis/guide/mcp-server) — OAuth connection for Claude, Cursor, Codex, and other MCP clients
* [Sandbox](/apis/guide/sandbox) — test before going live (Custom Connector backup)
* [Online payments](/apis/guide/online-payments) — payment requests and checkout flow
* [Payment methods reference](/apis/guide/payment-methods-reference) — PayNow, FPX, QRIS, and other methods
* [OpenAPI specification](https://docs.hitpayapp.com/openapi.json) — source of truth for request and response shapes (Custom Connector backup)