Skip to content

SellerPayoutConfig ​

Type: schema

TypeScript Definition ​

typescript
SellerPayoutConfig: {{
            seller_id?: string;
            seller_details?: components["schemas"]["AdminSellerInfo"];
            commission_fixed_amount?: number;
            commission_percent?: number;
            /** @enum {string} */
            commission_type?: "percent" | "fixed" | "percent_plus_fixed";
            /** Format: date-time */
            created_at?: string;
            hold_period_days?: number;
            include_shipping_in_payout?: boolean;
            include_tax_in_payout?: boolean;
            tcs_percent?: number;
            tds_percent?: number;
            minimum_payout_amount?: number;
            /** Format: date-time */
            modified_at?: string;
            store_id?: string;
            ulid?: string;
        };
        /**
         * SellerPayoutInvoice
         * @description A seller invoice tracked through the payout pipeline, from eligibility to settlement in a payout batch.
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["AdminSellerInfo"]AdminSellerInfo

OpenAPI Schema ​

json
{
  "title": "SellerPayoutConfig",
  "type": "object",
  "properties": {
    "seller_id": {
      "type": "string"
    },
    "seller_details": {
      "$ref": "#/components/schemas/AdminSellerInfo"
    },
    "commission_fixed_amount": {
      "type": "number"
    },
    "commission_percent": {
      "type": "number",
      "maximum": 100,
      "minimum": 0
    },
    "commission_type": {
      "type": "string",
      "enum": [
        "percent",
        "fixed",
        "percent_plus_fixed"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "hold_period_days": {
      "type": "integer"
    },
    "include_shipping_in_payout": {
      "type": "boolean"
    },
    "include_tax_in_payout": {
      "type": "boolean"
    },
    "tcs_percent": {
      "type": "number"
    },
    "tds_percent": {
      "type": "number"
    },
    "minimum_payout_amount": {
      "type": "number"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    },
    "store_id": {
      "type": "string"
    },
    "ulid": {
      "type": "string"
    }
  },
  "x-tags": [
    "Payouts"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: