Toast

Toast Payments API

Related to guests' payments for restaurant orders. Toast platform payments apply to a check in an order.

GitHub OpenAPI

Operations 4

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 /payments List payment GUIDs for a business day · Toast Get Payment Identifiers #
Ask an LLM
“Which payments were made during a restaurant business day?”
“Can I list payments that were refunded or voided on a given day?”
Tell an agent
List payment IDs at {restaurant} paid on business date {date}.
List payments refunded on business date {date}.
GET /payments/{guid} Look up one payment · Toast Get a Payment #
Ask an LLM
“What does the full record of one payment look like?”
“What information is stored on a single payment record?”
Tell an agent
Get payment {guid} at restaurant {restaurant}.
Show me payment {guid}.
POST /orders/{orderGuid}/checks/{checkGuid}/payments Add payments to a check · Toast Post Payments #
Ask an LLM
“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?”
Tell an agent
Add a payment to check {check} on order {order}.
Record these payments against order {order}, check {check}.
PATCH /orders/{orderGuid}/checks/{checkGuid}/payments/{paymentGuid} Change the tip on a payment · Toast Update a Tip Amount #
Ask an LLM
“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?”
Tell an agent
Set the tip on payment {payment} to {tip}, order {order}, check {check}.
Update tip for payment {payment} on check {check} of order {order}.

Documentation

📖
Documentation
https://doc.toasttab.com/openapi/orders/overview/
📖
Documentation
https://doc.toasttab.com/openapi/menus/overview/
📖
Documentation
https://doc.toasttab.com/openapi/labor/overview/
📖
Documentation
https://doc.toasttab.com/openapi/restaurants/overview/
📖
Documentation
https://doc.toasttab.com/openapi/stock/overview/
📖
Documentation
https://doc.toasttab.com/openapi/partners/overview/
📖
Documentation
https://doc.toasttab.com/openapi/authentication/overview/

Specifications

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

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/toast:toast-payments-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

toast-payments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.9.0
  title: Toast Orders Payments API
  description: 'The orders API includes operations that create, update, and retrieve information about restaurant

    guest orders.'
  contact:
    name: Toast developer support
servers:
- url: https://toast-api-server/orders/v2
tags:


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