{"openapi":"3.1.0","info":{"title":"Stripe Terminal (BYOK) API","version":"0.1.0","description":"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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-stripe-terminal.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-stripe-terminal/docs"},"termsOfService":"https://connectorbay.com/byok-stripe-terminal/terms"},"servers":[{"url":"https://byok-stripe-terminal.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-stripe-terminal/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_readers":{"post":{"operationId":"list_readers","summary":"List Terminal card readers with label, model, online status, serial number, software version and location. Works with a ","description":"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. Use for \"Which of my Stripe Terminal readers are offline\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["offline","online"],"type":"string"},{"type":"null"}],"default":null,"description":"Only readers that are online or offline.","title":"Status"},"location":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only readers at this location id, for example tml_Ej1qJxkd9Z2RdA.","title":"Location"},"device_type":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only readers of this model, for example bbpos_wisepos_e or stripe_s700.","title":"Device Type"},"serial_number":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the reader with this serial number.","title":"Serial Number"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_readersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_reader":{"post":{"operationId":"get_reader","summary":"Get one Terminal reader by id: label, model, status, serial number, software version and last seen time. Works with a re","description":"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. Use for \"When was reader tmr_Fzz8ZjGmn1X last online\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"reader":{"description":"Reader id, for example tmr_FDOt2wlRZEdpd7.","maxLength":200,"title":"Reader","type":"string"}},"required":["reader"],"title":"get_readerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_locations":{"post":{"operationId":"list_locations","summary":"List Terminal locations (the places readers are registered to) with display name and address. Works with a restricted ke","description":"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. Use for \"Which Terminal locations do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_locationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_location":{"post":{"operationId":"get_location","summary":"Get one Terminal location by id with its name, address and configuration override. Works with a restricted key that has ","description":"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. Use for \"What is the address of Terminal location tml_FDOtHwxN\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"location":{"description":"Location id, for example tml_FDOtHwxNblAU9N.","maxLength":200,"title":"Location","type":"string"}},"required":["location"],"title":"get_locationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_configurations":{"post":{"operationId":"list_configurations","summary":"List Terminal configurations: default flag, offline mode, cellular and reboot window. Wi-Fi settings and tipping rules a","description":"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. Use for \"Which Terminal configuration is the account default\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"is_account_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for the account default configuration only, false for the others.","title":"Is Account Default"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many objects to return (1 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last object on the previous page. Use it while has_more is true.","title":"Starting After"}},"title":"list_configurationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_configuration":{"post":{"operationId":"get_configuration","summary":"Get one Terminal configuration by id: name, default flag, offline mode, cellular and reboot window. Wi-Fi settings are n","description":"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. Use for \"Does Terminal configuration tmc_Fzz allow offline mode\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"configuration":{"description":"Configuration id, for example tmc_FDOtHwxNblAU9N.","maxLength":200,"title":"Configuration","type":"string"}},"required":["configuration"],"title":"get_configurationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}