# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Terminal API
  version: 1.0.0
extends: openapi/stripe-terminal-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 21
- target: $.paths['/v1/terminal/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List reader configurations
      effect: read
      questions:
      - 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?
      instructions:
      - text: List my Terminal reader configurations.
      - text: Show the configurations where account default is {is_account_default}.
        slots:
          is_account_default: query.is_account_default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/configurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reader configuration
      effect: write
      questions:
      - 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?
      - How do I create device-specific settings for a countertop reader?
      instructions:
      - text: Create a reader configuration with tipping settings {tipping}.
        slots:
          tipping: requestBody.tipping
      - text: Create a reader configuration with offline mode set to {offline}.
        slots:
          offline: requestBody.offline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/configurations/{configuration}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a reader configuration
      effect: read
      questions:
      - How do I check the tipping and offline settings in one reader configuration?
      - What does a particular Terminal configuration contain?
      instructions:
      - text: Get Terminal configuration {configuration}.
        slots:
          configuration: path.configuration
      - text: Show me the settings in reader configuration {configuration}.
        slots:
          configuration: path.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/configurations/{configuration}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a reader configuration
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update configuration {configuration} with tipping settings {tipping}.
        slots:
          configuration: path.configuration
          tipping: requestBody.tipping
      - text: Set offline mode on configuration {configuration} to {offline}.
        slots:
          configuration: path.configuration
          offline: requestBody.offline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/configurations/{configuration}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reader configuration
      effect: destructive
      questions:
      - How do I remove a reader configuration I no longer use?
      - Can I delete a Terminal configuration permanently?
      instructions:
      - text: Delete Terminal configuration {configuration}.
        slots:
          configuration: path.configuration
      - text: Remove reader configuration {configuration}.
        slots:
          configuration: path.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/connection_tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reader connection token
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a connection token for the Terminal SDK.
      - text: Create a connection token limited to location {location}.
        slots:
          location: requestBody.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List store locations
      effect: read
      questions:
      - How do I see all the physical store locations where I run card readers?
      - What locations have I registered for in-person payments?
      instructions:
      - text: List my Terminal locations.
      - text: Show the first {limit} store locations.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a store location
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a location called {display_name} at {address}.
        slots:
          display_name: requestBody.display_name
          address: requestBody.address
      - text: Add store location {display_name} at {address} using reader configuration {configuration_overrides}.
        slots:
          display_name: requestBody.display_name
          address: requestBody.address
          configuration_overrides: requestBody.configuration_overrides
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/locations/{location}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a store location
      effect: read
      questions:
      - How do I check the address and name of one of my reader locations?
      - What configuration is applied to a particular store location?
      instructions:
      - text: Get Terminal location {location}.
        slots:
          location: path.location
      - text: Show me the details of store location {location}.
        slots:
          location: path.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/locations/{location}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a store location
      effect: write
      questions:
      - How do I rename a store location or change its address?
      - Can I change which reader configuration a location uses?
      instructions:
      - text: Rename location {location} to {display_name}.
        slots:
          location: path.location
          display_name: requestBody.display_name
      - text: Change the address of location {location} to {address}.
        slots:
          location: path.location
          address: requestBody.address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/locations/{location}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a store location
      effect: destructive
      questions:
      - How do I remove a store location I've closed?
      - Can I delete a Terminal location permanently?
      instructions:
      - text: Delete Terminal location {location}.
        slots:
          location: path.location
      - text: Remove store location {location}.
        slots:
          location: path.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers'].get
  update:
    x-apievangelist-phrasing:
      intent: List card readers
      effect: read
      questions:
      - How do I see all the card readers registered to my account?
      - Can I find which readers are offline or at a specific location?
      - How do I look up a reader by its serial number?
      instructions:
      - text: List all my card readers.
      - text: List readers at location {location} with status {status}.
        slots:
          location: query.location
          status: query.status
      - text: Find the reader with serial number {serial_number}.
        slots:
          serial_number: query.serial_number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a card reader
      effect: write
      questions:
      - 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?
      instructions:
      - text: Register a reader with code {registration_code} at location {location}.
        slots:
          registration_code: requestBody.registration_code
          location: requestBody.location
      - text: Register reader {registration_code} and label it {label}.
        slots:
          registration_code: requestBody.registration_code
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a card reader
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get card reader {reader}.
        slots:
          reader: path.reader
      - text: Show me the status of reader {reader}.
        slots:
          reader: path.reader
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or tag a card reader
      effect: write
      questions:
      - How do I rename a card reader so staff can tell them apart?
      - Can I attach my own metadata to a reader?
      instructions:
      - text: Rename reader {reader} to {label}.
        slots:
          reader: path.reader
          label: requestBody.label
      - text: Set metadata {metadata} on reader {reader}.
        slots:
          metadata: requestBody.metadata
          reader: path.reader
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a card reader
      effect: destructive
      questions:
      - How do I unregister a card reader I've retired?
      - Can I delete a reader from my account for good?
      instructions:
      - text: Delete card reader {reader}.
        slots:
          reader: path.reader
      - text: Unregister reader {reader}.
        slots:
          reader: path.reader
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}/cancel_action'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel what a reader is doing
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Cancel the current action on reader {reader}.
        slots:
          reader: path.reader
      - text: Stop whatever reader {reader} is doing right now.
        slots:
          reader: path.reader
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}/process_payment_intent'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a payment on a card reader
      effect: write
      questions:
      - 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?
      - Can I pass processing options like skipping tipping when I push a payment to a reader?
      instructions:
      - text: Collect PaymentIntent {payment_intent} on reader {reader}.
        slots:
          payment_intent: requestBody.payment_intent
          reader: path.reader
      - text: Start payment {payment_intent} on reader {reader} with options {process_config}.
        slots:
          payment_intent: requestBody.payment_intent
          reader: path.reader
          process_config: requestBody.process_config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}/process_setup_intent'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a card in person on a reader
      effect: write
      questions:
      - 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?
      instructions:
      - text: Collect SetupIntent {setup_intent} on reader {reader} with consent {customer_consent_collected}.
        slots:
          setup_intent: requestBody.setup_intent
          reader: path.reader
          customer_consent_collected: requestBody.customer_consent_collected
      - text: Start saving a card for SetupIntent {setup_intent} on reader {reader}.
        slots:
          setup_intent: requestBody.setup_intent
          reader: path.reader
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}/refund_payment'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund a payment on a card reader
      effect: write
      questions:
      - 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?
      - Can I reverse the related transfer or application fee when refunding at a reader?
      instructions:
      - text: Refund charge {charge} on reader {reader}.
        slots:
          charge: requestBody.charge
          reader: path.reader
      - text: Refund {amount} of PaymentIntent {payment_intent} on reader {reader}.
        slots:
          amount: requestBody.amount
          payment_intent: requestBody.payment_intent
          reader: path.reader
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/terminal/readers/{reader}/set_reader_display'].post
  update:
    x-apievangelist-phrasing:
      intent: Show the cart on a reader screen
      effect: write
      questions:
      - 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?
      instructions:
      - text: Show cart {cart} on reader {reader}.
        slots:
          cart: requestBody.cart
          reader: path.reader
      - text: Set the display on reader {reader} to type {type} with cart {cart}.
        slots:
          reader: path.reader
          type: requestBody.type
          cart: requestBody.cart
      method: generated
      generated: '2026-09-26'