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.
Your integration can return a custom error message that the Toast
platform will display to restaurant employees. To include a custom error
message, you add a message value to the
LoyaltyTransactionResponse object that you return to the
Toast platform.
|
Note |
The error message you submit does not appear on the Toast POS. Submitting a custom message allows your team and the Toast to understand error trends in logs, but servers and guests will not see this message. |
The following example shows a
LoyaltyTransactionResponse object that delivers a custom
error message to the restaurant employee who is processing a loyalty
program transaction.
LoyaltyTransactionResponse object that includes a custom error message
{
"transactionStatus": "ERROR",
"message": "This is my helpful message about the error condition."
}