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.
The Toast gift card API specification includes a single endpoint. The Toast platform sends information about all gift card transaction types to that endpoint. The information in the HTTP request indicates the type of transaction and provides details about it.
You can name the single endpoint of your gift card integration API
anything that you want. For example, the REST path in the URL for your
API might be https://my-host-name/v1/myTransactions
. You
define every part of that URL. During the integration process, the Toast
technical partnership team will configure the REST path to your endpoint
in the Toast platform.
The Toast platform indicates the type of each transaction request
by including a transaction type identifier in the
Toast-Transaction-Type
HTTP header parameter. For
information about gift card transaction type identifiers see Gift card transaction types.
The Toast platform includes a set of values that provide
information about the gift card transaction in the JSON
GiftCardTransaction
object in the message body parameter
for each request.
Your single endpoint must return a JSON
GiftCardTransactionResponse
object in the message body of
the HTTP response to each request. The
GiftCardTransactionResponse
object indicates the success or
failure of transaction processing and provides information about the
state of the gift card after the transaction is processed. The
transactionStatus
value of the
GiftCardTransactionResponse
object includes a status
identifier. For information about transactionStatus
values,
see Response status types.
Important |
Your gift card API implementation must use HTTPS for all REST requests and responses. |