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

Stripe Terminal (BYOK) — connector documentation

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

What Stripe Terminal (BYOK) is for

Stripe Terminal (BYOK) lets an AI assistant read your own Stripe Terminal data through the Stripe Terminal API with a key you supply (restricted API key with read permissions only (starts with rk_live_ or rk_test_)). Read-only: 6 tools (list_readers, get_reader, list_locations, get_location, list_configurations, get_configuration). 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.stripe.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Stripe Terminal. Stripe Terminal 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 of my Stripe Terminal readers are offline?"
  • "When was reader tmr_Fzz8ZjGmn1X last online?"
  • "Which Terminal locations do I have?"
  • "What is the address of Terminal location tml_FDOtHwxN?"
  • "Which Terminal configuration is the account default?"
  • "Does Terminal configuration tmc_Fzz allow offline mode?"

What it does

  • list_readers: List Terminal card readers with label, model, online status, serial number, software version and location. Works with a restricted key that has read access to this resource only.
  • get_reader: Get one Terminal reader by id: label, model, status, serial number, software version and last seen time. Works with a restricted key that has read access to this resource only.
  • list_locations: List Terminal locations (the places readers are registered to) with display name and address. Works with a restricted key that has read access to this resource only.
  • get_location: Get one Terminal location by id with its name, address and configuration override. Works with a restricted key that has read access to this resource only.
  • list_configurations: List Terminal configurations: default flag, offline mode, cellular and reboot window. Wi-Fi settings and tipping rules are not returned. Works with a restricted key that has read access to this resource only.
  • get_configuration: Get one Terminal configuration by id: name, default flag, offline mode, cellular and reboot window. Wi-Fi settings are not returned. Works with a restricted key that has read access to this resource only.

BYOK key

You bring your own Stripe Terminal restricted API key with read permissions only (starts with rk_live_ or rk_test_) (https://dashboard.stripe.com/apikeys). 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.stripe.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 Stripe Terminal API (api.stripe.com) with a BYOK key; documentation: https://docs.stripe.com/api/terminal/readers. 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 Stripe Terminal. Stripe Terminal 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 Stripe Terminal account.

Built for: Worldwide. Languages: English.