Refund

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/withreach/json-schema/withreach-refund-schema.json",
  "title": "Refund",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/withreach-reach-s-drop-in-api-openapi.yml#/components/schemas/Refund",
  "type": "object",
  "properties": {
    "RefundId": {
      "description": "Reach-generated unique id of a refund",
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "minLength": 36,
      "maxLength": 36,
      "readOnly": true
    },
    "Amount": {
      "description": "Amount of the refund. Must be at most the total value of the original order, minus any other refunds.",
      "type": "number",
      "format": "float"
    },
    "State": {
      "description": "Refund state. See: https://docs.withreach.com/docs/states-and-events#refund-states",
      "type": "string",
      "enum": [
        "INPROGRESS",
        "SUCCEEDED",
        "FAILED"
      ],
      "readOnly": true
    },
    "RefundReference": {
      "description": "A merchant-supplied reference ID. This must be unique within the order for the given refund",
      "type": "string",
      "minLength": 1
    },
    "Times": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/$defs/Times"
        }
      ]
    }
  },
  "$defs": {
    "Times": {
      "description": "Gives times of various order state transitions",
      "type": "object",
      "properties": {
        "Created": {
          "description": "The RFC 3339 timestamp at which the order was created.",
          "type": "string"
        },
        "Authorized": {
          "description": "The RFC 3339 timestamp at which the order’s payment was authorized. This will be null if the payment has not yet been authorized or the payment method used for the order does not support pre-authorization (eg. Boleto).",
          "type": "string"
        },
        "Processed": {
          "description": "The RFC 3339 timestamp at which the order's payment was processed. This will be null if the order's payment has not been processed yet or has failed to be processed.",
          "type": "string"
        }
      }
    }
  }
}