Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Credit Cards Merchants API

2 actions 2 updates phrasing extends openapi/toast-merchants-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 2

$.info

$.paths['/merchants/{merchantUuid}/payments/{paymentUuid}'].put

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 Credit Cards Merchants API
  version: 1.0.0
extends: openapi/toast-merchants-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: 1
- target: $.paths['/merchants/{merchantUuid}/payments/{paymentUuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Authorize a credit card payment
      effect: write
      questions:
      - How do I authorize a credit card so funds are held until capture or void?
      - How long do I have to apply an authorized card payment to a check?
      - Can I authorize a tip amount along with the card payment?
      instructions:
      - text: Authorize {amount} plus a {tip} tip on card payment {payment} for merchant {merchant}.
        slots:
          amount: requestBody.amount
          tip: requestBody.tipAmount
          payment: path.paymentUuid
          merchant: path.merchantUuid
      - text: Place a hold of {amount} on the encrypted card for payment {payment} at merchant {merchant}.
        slots:
          amount: requestBody.amount
          payment: path.paymentUuid
          merchant: path.merchantUuid
      method: generated
      generated: '2026-10-01'