Toast Yourendpointname API
The Yourendpointname API from Toast — 1 operation(s) for yourendpointname.
Toast Yourendpointname API is one of 80 APIs that Toast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Yourendpointname. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 80 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://toast-api-server/yourapiname/v1, /yourapiname/v1.
1 operations
1 paths
80 schemas
1 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Yourendpointname 1
POST
/yourendpointname
Returns gift card transaction information
Schemas 80
The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are TransactionInformationReverse_3 (11 properties), Offer (10 properties), Redemption (8 properties), TransactionInformationPayments (8 properties). Each schema is shown below with its type and property counts.
TransactionResponseAddValue
object
Information about a gift card transaction from the gift card service provider for add value transactions. The Toast platform uses this information to complete…
1 property
TransactionResponseGetBalance
object
Information about a gift card transaction from the gift card service provider for get balance transactions. The Toast POS system uses this information to compl…
1 property
TransactionInformationRedeem
TransactionInformationAddValue
TransactionResponseReverse
object
Information about a gift card transaction from the gift card service provider that undoes a previous gift card transaction. The Toast platform uses this inform…
1 property
TransactionInformationActivate
TransactionInformation
object
3 properties
TransactionInformationReverse
object
Information about a gift card transaction in the Toast platform that undoes a previous transaction. Gift card providers are expected to handle the transaction.…
1 property
GiftCardTransaction
object
Information about a gift card transaction in the Toast platform. Gift card providers are expected to handle that transaction. The set of information in this ob…
5 properties
TransactionResponseActivate
object
Information about a gift card transaction from the gift card service provider for activating a new gift card. The Toast POS system uses this information to com…
1 property
GiftCardTransactionResponse
object
Information about a gift card transaction from the gift card provider. The Toast platform uses this information to complete guests' gift card transactions. The…
6 properties
TransactionResponseRedeem
object
Information about a gift card transaction from the gift card service provider that reduces the balance of funds available from the card. For example, when the…
2 properties
TransactionInformationGetBalance
object
Information about a gift card transaction in the Toast platform that requests the currency value of the funds available from the gift card. Gift card providers…
Device
object
The Device ID value that the Toast POS system assigns to a specific Toast POS device. The id value is a unique identifier for a device. To find the ID for a To…
1 property
TransactionInformationCheck
object
Information needed to complete an inquire, redeem, or accrue transaction. Included if the toastTransactionType is one of LOYALTYINQUIRE, LOYALTYREDEEM, or LOYA…
4 properties
AppliedDiscountTrigger
object
The Selection which triggered the application of this discount
2 properties
ItemRedemptionInfo
object
Information about the application of a Redemption to a specific item.
3 properties
TransactionInformationReverse_2
object
Information needed to complete a reverse transaction. Included if the toastTransactionType is LOYALTYREVERSE, absent otherwise.
3 properties
LoyaltyTransaction
object
Information about a loyalty transaction in the Toast POS system. Loyalty providers are expected to handle that transaction. The set of information in this obje…
6 properties
ToastReference
object
A wrapper object with fields that allow reference to a Toast entity by Toast GUID.
2 properties
2 required
AppliedLoyaltyInfo
object
Information about the customer loyalty program account associated with a check.
2 required
TransactionInformationSearch
object
Information needed to complete a search transaction. Included if the toastTransactionType is LOYALTYSEARCH, absent otherwise.
1 property
Offer
object
Information about a potential discount or other benefit available to the holder of a loyalty account. Contrast with a Redemption, which is an Offer that is app…
10 properties
LoyaltyTransactionResponse
object
Information about a loyalty transaction from the loyalty provider. The Toast POS system uses this information to complete guests' loyalty transactions. The set…
5 properties
Refund
object
A discount applied to a check or item.
4 properties
AppliedTaxRate
object
A tax rate applied to an Item or ServiceCharge.
1 required
ConfigReference
object
A wrapper object containing identifier values for Toast platform entities.
AppliedServiceCharge
object
A percentage/open/fixed service charge added to a check which could represent in general an upcharge like a gratuity or delivery fee. Whether the upcharge is t…
Selection
object
A Selection object can represent either a primary item (i.e. Check.selections) or a modifier (Selection.modifiers) selection. Quantity defaults to 1. Specify a…
ExternalReference
object
A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.
AccountSearchCriteria
object
A set of possible criteria to be used to search for a given loyalty account. The provider must return a list of loyalty accounts that match the criteria given…
4 properties
RedemptionLimit
object
Controls the maximum number of rewards a guest can redeem for this check. When this object is present (non-null), the Toast POS enforces the limit you specify…
1 property
1 required
TransactionInformationSignup
object
Information needed to complete a signup transaction. Included if the toastTransactionType is LOYALTYSIGNUP, absent otherwise. Requires exactly one of email or…
2 properties
TransactionInformationTransfer
object
Information needed to complete a transfer transaction. Included if the toastTransactionType is LOYALTYTRANSFER, absent otherwise.
2 properties
ExpirationData
object
If an offer will expire, this can detail information of when that offer is set to expire.
2 properties
Payment
object
Defines a payment.
RejectedRedemption
object
A redemption that was included in a list of redemptions to redeem, but is not valid based on the partner's validation logic.
2 properties
1 required
LoyaltyDetails
object
Information about the loyalty program discount applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the check.
2 properties
2 required
VoidInformation
object
Information about a void applied to a check or item.
5 properties
ResponseSignup
object
Response to a signup request. For a signup response this field is required. Contains the loyalty identifier of the newly created account.
1 property
1 required
Redemption
object
Information about an offer to be redeemed (or that was redeemed) to a check.
8 properties
ResponseTransfer
object
Response to a transfer request. For a transfer response this field is required. Contains the loyalty identifier that the old account transferred to.
1 property
AccountInfo
object
Identifying information about a specific loyalty account.
6 properties
AppliedDiscount
object
A discount applied to a check or item. The Toast POS system calculates service charges before applying discounts. The system calculates tax after applying disc…
Check
object
Represents a single check within an order.
ResponseCheck
object
Response to an inquire, redeem, or accure request. For an inquire response this field is requried. For all other responses it is optional unless any of the red…
6 properties
ResponseSearch
object
Response to a search request. Contains the array of account information matching the search criteria. If no matching accounts were found, the service should re…
1 property
TransactionInformationPayments
object
A request for the provider to return a list of payments that apply to the check. The Toast POS system will then send a TENDERREDEEM request with the discounts…
8 properties
Device_2
object
The Device ID value that the Toast POS system assigns to a specific Toast POS device. The id value is a unique identifier for a device. To find the ID for a To…
1 property
AppliedDiscountTrigger_2
object
The Selection which triggered the application of this discount.
2 properties
TransactionResponseGratuity
object
Response to a request to update the gratuity amount on an already tendered payment.
2 properties
TenderPayment
object
Payment returned by the tender provider to be applied to the check.
6 properties
TransactionResponseSearchConfig
object
A list of search terms supported by the tender provider. This will populate the list of search terms displayed by the Toast POS system when a search is request…
1 property
TransactionResponseSearch
object
A list of accounts matching the search terms submitted as part of a search request.
2 properties
KeyValue
object
An abstract key-value pair, used anytime the Toast POS system needs to submit or accept one or more configurable values.
4 properties
TransactionInformationReverse_3
object
A request to reverse discounts and/or payments made as part of a previous transaction.
11 properties
AppliedLoyaltyInfo_2
object
Information about the customer loyalty program account associated with a check.
2 required
TransactionInformationSearch_2
object
A request to search for all tender accounts that match the given search terms.
6 properties
TenderTransactionStatus
string
Indicates the result of a tender transaction, reported by the tender service provider. This property must be present on all responses. Possible values are: ACC…
Refund_2
object
A discount applied to a check or item.
4 properties
AppliedTaxRate_2
object
A tax rate applied to an Item or ServiceCharge.
1 required
AppliedServiceCharge_2
object
A percentage/open/fixed service charge added to a check which can represent in general an upcharge like a gratuity or delivery fee. Whether the upcharge is tax…
Selection_2
object
"A Selection object can represent either a primary item (i.e. Check.selections) or a modifier (Selection.modifiers) selection. Quantity defaults to 1. Specify…
TransactionInformationGratuity
object
A request to add an additional gratuity to a existing tender transaction.
5 properties
TransactionInformationDiscounts
object
A request for the provider to return a list of discounts (if any) that apply to the given check. The Toast POS system will then send a TENDERRETRIEVEPAYMENTS r…
5 properties
TenderTransactionResponse
object
Information about a tender transaction from the tender provider. The Toast POS system uses this information to complete guests' tender transactions. The set of…
6 properties
Payment_2
object
Defines a payment.
TransactionInformationRedeem_2
object
A request for the provider to mark as consumed the discounts and payments included in this message, that were previously retrieved with TENDERRETRIEVEDISCOUNTS…
7 properties
TransactionResponseDiscounts
object
A list of discounts that apply to the given check with the given account identifier.
2 properties
LoyaltyDetails_2
object
Information about the loyalty program discount applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the check.
2 properties
2 required
TenderTransaction
object
Information about a tender transaction in the Toast POS system. Tender providers are expected to handle that transaction. The set of information in this object…
6 properties
VoidInformation_2
object
Information about a void applied to a check or item.
5 properties
TenderCoupon
object
Reserved for future use.
6 properties
TransactionResponsePayments
object
A list of discounts that apply to the given check with the given account identifier.
2 properties
AccountInfo_2
object
Information related to a given tender user.
3 properties
Customer
object
CheckInfo
object
Information about a check associated with a transaction
2 properties
2 required
AppliedDiscount_2
object
A discount applied to a check or item. The Toast POS system calculates service charges before applying discounts. The system calculates the tax after applying…
Check_2
object
Represents a single check within an order.
TenderDiscount
object
A discount to be applied to a check. In response to a TENDERRETRIEVEDISCOUNTS request, the Toast POS system attempts to apply the discount to the check. In the…
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Toast 12
Other APIs Toast publishes across the network.
Toast Authentication API
Toast ConnectedRestaurants API
Toast Discounts API
Toast Employees API
Toast Groups API
Toast Jobs API
Toast Menus API
Toast Metadata API
Toast Orders API
Toast Payments API
Toast Restaurants API
Toast Shifts API
#Yourendpointname
Where this information came from
This is an independent, third-party profile of Toast Yourendpointname API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.