Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

HitPay (BYOK) — connector documentation

  • MCP endpoint: https://byok-hitpay.connectorbay.com/mcp
  • REST API: POST https://byok-hitpay.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-hitpay.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own HitPay business API key (live), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-hitpay.connectorbay.com/health · Tool schemas: https://byok-hitpay.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-hitpay · agent@connectorbay.com

What HitPay (BYOK) is for

HitPay (BYOK) lets an AI assistant read your own HitPay data through the HitPay API with a key you supply (business API key (live)). Read-only: 9 tools (list_charges, get_charge, list_payouts, get_payout, list_balances, list_payment_requests, list_subscription_plans, get_account_status, list_locations). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.hit-pay.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HitPay. HitPay and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which HitPay charges succeeded this week?"
  • "Show HitPay charge 9c1b2f4e"
  • "When is my next HitPay payout arriving?"
  • "Show HitPay payout 9d2a"
  • "How much available balance do I have on HitPay?"
  • "Which HitPay payment requests are open?"

What it does

  • list_charges: List charges newest first with amount, fees, status, payment method, channel and dates; filter by status, date range, amount, customer, payment request or payout.
  • get_charge: Get one charge by id: amount, amount without fees, refunded amount, fees, status, payment method, channel and reference; customer details are left out.
  • list_payouts: List payouts (settlements of your balance to your own bank account) newest first with status, amount, currency, bank name, reference and arrival date; the bank account number is left out.
  • get_payout: Get one payout by id with status, amount, bank name, reference, failure reason and arrival date; the bank account number is left out.
  • list_balances: List the account's balance per currency: available, pending, deposit and reserve wallets.
  • list_payment_requests: List payment requests (payment links and checkouts); filter by free text on email, id or reference number.
  • list_subscription_plans: List recurring-billing subscription plans with price, currency, cycle and frequency.
  • get_account_status: Show the account's bank-account status and verification status (overall, owner, business).
  • list_locations: List business locations (stores) with name, city, country and active flag.

BYOK key

You bring your own HitPay business API key (live) (https://dashboard.hit-pay.com/login). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.hit-pay.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the HitPay API (api.hit-pay.com) with a BYOK key; documentation: https://docs.hitpayapp.com/apis/overview. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HitPay. HitPay and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your HitPay account.

Built for: Worldwide. Languages: English.