Tock · Schema

tockRefund

tockRefund schema from Tock Reservation Model

HospitalityReservationsRestaurantsWineriesTicketed EventsTakeoutDeliveryExperiencesDiningAmerican Express

Properties

Name	Type	Description
id	string	A unique identifier assigned to the refund. Used internally by Tock.
amount	integer	The amount of the original payment that was refunded. This value will always be a positive number.
isDispute	boolean	This field indicates whether this refund was issued because of a lost chargeback dispute.
status	object	The current status of the refund within the payment processor that serviced the original payment.
payout	object	The Tock-generated payout that includes this refund as a debit to the business bank account. If the business connects to Tock for payment processing using Stripe this field will not be present.
processorId	string	A unique identifier assigned to the refund by the payment processor indicated by the paymentType.
processorFeeRefundedCents	integer	The amount the of the payment processor fee that was returned as a result of the refund.
tockFeeRefundedCents	integer	The amount of the Tock fee that was returned as a result of the refund.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tock/refs/heads/main/json-schema/reservation-refund-schema.json",
  "title": "tockRefund",
  "description": "tockRefund schema from Tock Reservation Model",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "int64",
      "description": "A unique identifier assigned to the refund. Used internally by Tock."
    },
    "amount": {
      "type": "integer",
      "format": "int32",
      "description": "The amount of the original payment that was refunded. This value will always be a positive number."
    },
    "isDispute": {
      "type": "boolean",
      "description": "This field indicates whether this refund was issued because of a lost chargeback dispute."
    },
    "status": {
      "$ref": "reservation-refund-refund-status-schema.json",
      "description": "The current status of the refund within the payment processor that serviced the original payment."
    },
    "payout": {
      "$ref": "reservation-payout-schema.json",
      "description": "The Tock-generated payout that includes this refund as a debit to the business bank account. If the business connects to Tock for payment processing using Stripe this field will not be present."
    },
    "processorId": {
      "type": "string",
      "description": "A unique identifier assigned to the refund by the payment processor indicated by the paymentType."
    },
    "processorFeeRefundedCents": {
      "type": "integer",
      "format": "int64",
      "description": "The amount the of the payment processor fee that was returned as a result of the refund."
    },
    "tockFeeRefundedCents": {
      "type": "integer",
      "format": "int64",
      "description": "The amount of the Tock fee that was returned as a result of the refund."
    }
  }
}