Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Toast Orders Payments API

5 actions 5 updates phrasing extends openapi/toast-payments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Toast's API. It is a proposal applied on top of the contract, not a document Toast publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/payments'].get

$.paths['/payments/{guid}'].get

$.paths['/orders/{orderGuid}/checks/{checkGuid}/payments'].post

$.paths['/orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Toast Orders Payments API
  version: 1.0.0
extends: openapi/toast-payments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment GUIDs for a business day
      effect: read
      questions:
      - Which payments were made during a restaurant business day?
      - Can I list payments that were refunded or voided on a given day?
      instructions:
      - text: List payment IDs at {restaurant} paid on business date {date}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          date: query.paidBusinessDate
      - text: List payments refunded on business date {date}.
        slots:
          date: query.refundBusinessDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payments/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one payment
      effect: read
      questions:
      - What does the full record of one payment look like?
      - What information is stored on a single payment record?
      instructions:
      - text: Get payment {guid} at restaurant {restaurant}.
        slots:
          guid: path.guid
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show me payment {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{orderGuid}/checks/{checkGuid}/payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add payments to a check
      effect: write
      questions:
      - How do I record a payment against a check in an existing order?
      - Can I apply multiple payments to one check in a single call?
      instructions:
      - text: Add a payment to check {check} on order {order}.
        slots:
          check: path.checkGuid
          order: path.orderGuid
      - text: Record these payments against order {order}, check {check}.
        slots:
          order: path.orderGuid
          check: path.checkGuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the tip on a payment
      effect: write
      questions:
      - Can a guest's tip be adjusted on a payment after the check is paid?
      - Can I edit anything other than the tip amount on an existing payment?
      instructions:
      - text: Set the tip on payment {payment} to {tip}, order {order}, check {check}.
        slots:
          payment: path.paymentGuid
          tip: requestBody.tipAmount
          order: path.orderGuid
          check: path.checkGuid
      - text: Update tip for payment {payment} on check {check} of order {order}.
        slots:
          payment: path.paymentGuid
          check: path.checkGuid
          order: path.orderGuid
      method: generated
      generated: '2026-10-01'