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

Numeral (BYOK) — connector documentation

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

What Numeral (BYOK) is for

Numeral (BYOK) lets an AI assistant read your own Numeral data through the Numeral API with a key you supply (Numeral secret key (sk_test_... or sk_prod_...)). Read-only: 11 tools (ping_numeral, list_merchants, get_merchant, list_products, get_product, list_customers, get_customer, get_transaction, get_transaction_refunds, list_exemption_certificates, list_certificate_requests). 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.numeralhq.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Numeral. Numeral 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:

  • "Does my Numeral key work, and is it test or production?"
  • "List the merchants in my Numeral account."
  • "Show Numeral merchant my-seller-123."
  • "Which products are registered in Numeral?"
  • "Show Numeral product p-20506."
  • "Which Numeral customers are tax exempt?"

What it does

  • ping_numeral: Check the key works: returns status, whether it is a test or production key, timestamp and API version.
  • list_merchants: List merchants (sellers) on your platform account: reference ID, name, default address and status.
  • get_merchant: Get one merchant by Numeral ID or your own reference merchant ID.
  • list_products: List the products you registered with Numeral, with name and tax product category (up to 50 per page).
  • get_product: Get one product by your reference product ID: name, tax category and timestamps.
  • list_customers: List customers known to Numeral with your reference ID and tax-exempt flag.
  • get_customer: Get one customer by Numeral customer ID: reference ID and tax-exempt flag.
  • get_transaction: Get a recorded sale by transaction ID: order reference, currencies, line items with products and tax jurisdictions.
  • get_transaction_refunds: List the refunds recorded against a transaction, with processing time and refunded line items.
  • list_exemption_certificates: List exemption (resale) certificates with status, type, covered jurisdictions and dates. Filter by status or customer. Live keys only.
  • list_certificate_requests: List requests sent to customers for exemption certificates, with status, customer and dates. Filter by status or customer. Live keys only.

BYOK key

You bring your own Numeral Numeral secret key (sk_test_... or sk_prod_...) (https://dashboard.numeralhq.com/developers). 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.numeralhq.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 Numeral API (api.numeralhq.com) with a BYOK key; documentation: https://docs.numeral.com/api-reference/v2026-03-01/introduction. 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 Numeral. Numeral 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 Numeral account.

Built for: Worldwide. Languages: English.