Flipdish · Schema

Refund

Refund

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
RefundReason string Refund reason
RefundAmount number Refund amount
NotifyCustomer boolean If true, the system sends notification to the customer about the refund
View JSON Schema on GitHub

JSON Schema

orders-refund-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/orders-refund-schema.json",
  "title": "Refund",
  "description": "Refund",
  "type": "object",
  "properties": {
    "RefundReason": {
      "description": "Refund reason",
      "type": "string",
      "example": "string"
    },
    "RefundAmount": {
      "format": "double",
      "description": "Refund amount",
      "minimum": 0,
      "type": "number",
      "example": 12.5
    },
    "NotifyCustomer": {
      "description": "If true, the system sends notification to the customer about the refund",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "RefundAmount",
    "NotifyCustomer"
  ],
  "example": {
    "RefundReason": "reason",
    "RefundAmount": 20,
    "NotifyCustomer": true
  }
}