Stripe

Stripe Terminal API

Use Stripe Terminal to accept in-person payments and extend Stripe payments to your point of sale.

GitHub OpenAPI
Business capability
Payments & Card Management BC-1340

Operations 21

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/terminal/configurations List reader configurations · Get terminal configurations #
Ask an LLM
“How do I see all the configurations I've set up for my in-person card readers?”
“Can I find which reader configuration is the account default?”
Tell an agent
List my Terminal reader configurations.
Show the configurations where account default is {is_account_default}.
POST /v1/terminal/configurations Create a reader configuration · Post terminal configurations #
Ask an LLM
“How do I set up tipping options for my in-store card readers?”
“Can I turn on offline payments for my readers through a configuration?”
Tell an agent
Create a reader configuration with tipping settings {tipping}.
Create a reader configuration with offline mode set to {offline}.
DELETE /v1/terminal/configurations/{configuration} Delete a reader configuration · Delete terminal configurations configuration #
Ask an LLM
“How do I remove a reader configuration I no longer use?”
“Can I delete a Terminal configuration permanently?”
Tell an agent destructive · confirm first
Delete Terminal configuration {configuration}.
Remove reader configuration {configuration}.
GET /v1/terminal/configurations/{configuration} Look up a reader configuration · Get terminal configurations configuration #
Ask an LLM
“How do I check the tipping and offline settings in one reader configuration?”
“What does a particular Terminal configuration contain?”
Tell an agent
Get Terminal configuration {configuration}.
Show me the settings in reader configuration {configuration}.
POST /v1/terminal/configurations/{configuration} Update a reader configuration · Post terminal configurations configuration #
Ask an LLM
“How do I change the tipping percentages on an existing reader configuration?”
“Can I switch offline payments on or off for a configuration I already have?”
Tell an agent
Update configuration {configuration} with tipping settings {tipping}.
Set offline mode on configuration {configuration} to {offline}.
POST /v1/terminal/connection_tokens Create a reader connection token · Post terminal connection tokens #
Ask an LLM
“How does my point-of-sale app get a token to connect to a card reader?”
“Can I restrict a reader connection token to a single location?”
Tell an agent
Create a connection token for the Terminal SDK.
Create a connection token limited to location {location}.
GET /v1/terminal/locations List store locations · Get terminal locations #
Ask an LLM
“How do I see all the physical store locations where I run card readers?”
“What locations have I registered for in-person payments?”
Tell an agent
List my Terminal locations.
Show the first {limit} store locations.
POST /v1/terminal/locations Create a store location · Post terminal locations #
Ask an LLM
“How do I add a new physical store where I'll use card readers?”
“Which address fields are required when creating a location in a given country?”
Tell an agent
Create a location called {display_name} at {address}.
Add store location {display_name} at {address} using reader configuration {configuration_overrides}.
DELETE /v1/terminal/locations/{location} Delete a store location · Delete terminal locations location #
Ask an LLM
“How do I remove a store location I've closed?”
“Can I delete a Terminal location permanently?”
Tell an agent destructive · confirm first
Delete Terminal location {location}.
Remove store location {location}.
GET /v1/terminal/locations/{location} Look up a store location · Get terminal locations location #
Ask an LLM
“How do I check the address and name of one of my reader locations?”
“What configuration is applied to a particular store location?”
Tell an agent
Get Terminal location {location}.
Show me the details of store location {location}.
POST /v1/terminal/locations/{location} Update a store location · Post terminal locations location #
Ask an LLM
“How do I rename a store location or change its address?”
“Can I change which reader configuration a location uses?”
Tell an agent
Rename location {location} to {display_name}.
Change the address of location {location} to {address}.
GET /v1/terminal/readers List card readers · Get terminal readers #
Ask an LLM
“How do I see all the card readers registered to my account?”
“Can I find which readers are offline or at a specific location?”
Tell an agent
List all my card readers.
List readers at location {location} with status {status}.
POST /v1/terminal/readers Register a card reader · Post terminal readers #
Ask an LLM
“How do I register a new card reader using the code it shows on screen?”
“Can I assign a reader to a store location when I register it?”
Tell an agent
Register a reader with code {registration_code} at location {location}.
Register reader {registration_code} and label it {label}.
DELETE /v1/terminal/readers/{reader} Remove a card reader · Delete terminal readers reader #
Ask an LLM
“How do I unregister a card reader I've retired?”
“Can I delete a reader from my account for good?”
Tell an agent destructive · confirm first
Delete card reader {reader}.
Unregister reader {reader}.
GET /v1/terminal/readers/{reader} Look up a card reader · Get terminal readers reader #
Ask an LLM
“How do I check whether a particular card reader is online and what it's doing?”
“What details are stored for one of my readers?”
Tell an agent
Get card reader {reader}.
Show me the status of reader {reader}.
POST /v1/terminal/readers/{reader} Rename or tag a card reader · Post terminal readers reader #
Ask an LLM
“How do I rename a card reader so staff can tell them apart?”
“Can I attach my own metadata to a reader?”
Tell an agent
Rename reader {reader} to {label}.
Set metadata {metadata} on reader {reader}.
POST /v1/terminal/readers/{reader}/cancel_action Cancel what a reader is doing · Post terminal readers reader cancel action #
Ask an LLM
“How do I stop a card reader that's stuck waiting for a customer to tap?”
“Can I cancel an in-progress payment prompt on a reader from my server?”
Tell an agent destructive · confirm first
Cancel the current action on reader {reader}.
Stop whatever reader {reader} is doing right now.
POST /v1/terminal/readers/{reader}/process_payment_intent Take a payment on a card reader · Post terminal readers reader process payment intent #
Ask an LLM
“How do I send a payment to a card reader so the customer can tap or insert their card?”
“Can I start a server-driven in-person payment on a specific reader?”
Tell an agent
Collect PaymentIntent {payment_intent} on reader {reader}.
Start payment {payment_intent} on reader {reader} with options {process_config}.
POST /v1/terminal/readers/{reader}/process_setup_intent Save a card in person on a reader · Post terminal readers reader process setup intent #
Ask an LLM
“How do I save a customer's card for later using an in-person reader?”
“Do I need to record customer consent before saving a card on a reader?”
Tell an agent
Collect SetupIntent {setup_intent} on reader {reader} with consent {customer_consent_collected}.
Start saving a card for SetupIntent {setup_intent} on reader {reader}.
POST /v1/terminal/readers/{reader}/refund_payment Refund a payment on a card reader · Post terminal readers reader refund payment #
Ask an LLM
“How do I refund an in-person payment by having the customer present their card on the reader?”
“Can I refund only part of an in-person charge on a reader?”
Tell an agent
Refund charge {charge} on reader {reader}.
Refund {amount} of PaymentIntent {payment_intent} on reader {reader}.
POST /v1/terminal/readers/{reader}/set_reader_display Show the cart on a reader screen · Post terminal readers reader set reader display #
Ask an LLM
“How do I show the customer their cart and total on the card reader screen?”
“Can I update what the reader displays while the order is being built?”
Tell an agent
Show cart {cart} on reader {reader}.
Set the display on reader {reader} to type {type} with cart {cart}.

Documentation

📖
Documentation
https://stripe.com/docs/terminal

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-terminal-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-post-terminal-configurations-configuration-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-post-terminal-configurations-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-terminal-reader-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-post-terminal-readers-reader-refund-payment-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-terminal-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-post-terminal-locations-request-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/overlays/stripe-terminal-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stripe:stripe-terminal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stripe-terminal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stripe Terminal API
  description: Needs description.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-terminal-api-openapi.yml