Toast · Schema
Refund
A currency amount removed from a guest payment.
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations
Properties
| Name | Type | Description |
|---|---|---|
| refundAmount | number | The amount of the refund, excluding the tip. |
| tipRefundAmount | number | The amount of the tip refund. |
| refundDate | string | The date and time when the refund was made. |
| refundBusinessDate | integer | The business date (yyyyMMdd) on which this refund was created. Response only. |
| refundTransaction | object | An identifier for the refund transaction. You can use the identifier to associate items and service charges that were refunded in the same transaction. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/orders-refund-schema.json",
"title": "Refund",
"description": "A currency amount removed from a guest payment.",
"type": "object",
"properties": {
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund, excluding the tip.",
"example": 1.0
},
"tipRefundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tip refund.",
"example": 1.0
},
"refundDate": {
"description": "The date and time when the refund was made.",
"type": "string",
"format": "date-time",
"example": "2026-06-03T12:00:00.000+0000"
},
"refundBusinessDate": {
"x-toast-read-only": true,
"description": "The business date (yyyyMMdd) on which this refund was created. Response only.",
"type": "integer",
"example": "2026-06-03T12:00:00.000+0000"
},
"refundTransaction": {
"description": "An identifier for the refund transaction. You can use the identifier to associate items and service charges that were refunded in the same transaction.\n",
"type": "object",
"$ref": "#/$defs/RefundTransaction"
}
},
"$defs": {
"RefundTransaction": {
"allOf": [
{
"$ref": "#/$defs/ToastReference"
},
{
"type": "object",
"description": "An identifier for the refund transaction. You can use the identifier to associate items and service charges that were refunded in the same transaction.\n"
}
]
}
}
}