This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Tender provider integrations overview

You can use the Toast tender API to integrate your tender provider with the Toast platform. The tender API supports the Hotel property management system integration and enables a hotel restaurant to directly bill a guest at the hotel, for example, by using their room number or name.

In addition, the tender API allows you to apply discounts from a third-party system and refund payments and discounts on a check.

The API can be defined by:

  • Transaction requests

  • Transaction responses

  • Error codes

Transaction types define the action to take and the related payload. Transactions between the Toast platform and the tender provider during a tender transaction are represented in the following figure.

Your implementation is responsible for returning the response synchronously.

Tender integrations define a single HTTPS endpoint. In your implementation, all requests are posted to this single endpoint. Requests from restaurants configured to use your service are sent to this endpoint. For example, you can name your endpoint to be:

https://toastapi.com/tenderapi

Each POST request to the endpoint includes:

  • A TenderTransaction object in the message body.

  • The following header parameters:

    Header Parameter

    Description

    Toast-transaction-type

    The type of tender transaction that occurred. Requests are filtered based upon this parameter.

    Toast-restaurant-external-ID

    The unique identifier of the restaurant, defined by the Toast platform. This parameter determines which restaurant is sending the request.

    Toast-transaction-GUID

    A unique identifier of the tender transaction, defined by the Toast platform.

    Authorization

    A JSON Web Token (JWT) that you can use to authenticate the request. Verify the token using the public key that you get from the Toast user management service. For more information, see Authenticating outbound API requests.

For more information about the transaction descriptions, workflows and examples, see Transaction descriptions.