RefundObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/marketsdk/json-schema/marketsdk-refund-object-schema.json",
  "title": "RefundObject",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/marketsdk-openapi.json#/components/schemas/RefundObject",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "refund"
      ]
    },
    "id": {
      "type": "string"
    },
    "payment": {
      "type": "string"
    },
    "order": {
      "type": "string"
    },
    "amount": {
      "type": "number",
      "description": "Minor units."
    },
    "currency": {
      "type": "string"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "requested_by_customer",
        "duplicate",
        "fraudulent",
        null
      ]
    },
    "initiated_by": {
      "type": "string",
      "enum": [
        "api",
        "order_cancelled",
        "order_expired",
        "late_payment",
        "stripe"
      ],
      "description": "`api` for a refund you asked for; `order_cancelled` and `order_expired` when an order ended without completing; `late_payment` for a payment that arrived after its order lapsed; `stripe` for a refund made in the Stripe dashboard, which does not reverse the transfer."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "succeeded",
        "failed",
        "canceled"
      ]
    },
    "failure_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "transfer_reversal": {
      "description": "Present when the refund came after release.",
      "anyOf": [
        {
          "$ref": "#/$defs/RefundReversalObject"
        },
        {
          "type": "null"
        }
      ]
    },
    "stripe": {
      "$ref": "#/$defs/RefundStripeObject"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "object",
    "id",
    "payment",
    "order",
    "amount",
    "currency",
    "reason",
    "initiated_by",
    "status",
    "failure_reason",
    "transfer_reversal",
    "stripe",
    "metadata",
    "created_at",
    "updated_at"
  ],
  "$defs": {
    "RefundReversalObject": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number",
          "description": "Taken back from the seller's transfer. Minor units."
        }
      },
      "required": [
        "amount"
      ]
    },
    "RefundStripeObject": {
      "type": "object",
      "properties": {
        "refund": {
          "type": [
            "string",
            "null"
          ]
        },
        "transfer_reversal": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "refund",
        "transfer_reversal"
      ]
    }
  }
}