Skip to content

PayoutPaymentMethod ​

Type: schema

TypeScript Definition ​

typescript
PayoutPaymentMethod: {{
            id?: $Read<string>;
            name?: $Read<string>;
            /** @description Slug of the payment provider to pay out through, for example `juspay` or `icici-cib`. The only identifier required when writing the payout configuration. */
            slug: string;
            description?: $Read<string>;
            /** @enum {unknown} */
            status?: $Read<"active" | "inactive">;
            /**
             * @description `auto` for connected payment service providers; `manual` for store-defined payment methods.
             * @enum {unknown}
             */
            type?: $Read<"auto" | "manual">;
            /** @description `true` when the provider is linked in the store payout configuration. */
            used_in_payout?: $Read<boolean>;
            /**
             * @description Marks the provider used to settle payout batches by default. Exactly one entry should be `true` when `payment_option` is `auto`.
             * @default false
             */
            is_default: boolean;
            logo_dark?: $Read<string | null>;
            logo_light?: $Read<string | null>;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
        };
        /** PercentageDiscountRule */
}

OpenAPI Schema ​

json
{
  "title": "PayoutPaymentMethod",
  "type": "object",
  "required": [
    "slug"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "slug": {
      "description": "Slug of the payment provider to pay out through, for example `juspay` or `icici-cib`. The only identifier required when writing the payout configuration.",
      "type": "string"
    },
    "description": {
      "type": "string",
      "readOnly": true
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "readOnly": true
    },
    "type": {
      "description": "`auto` for connected payment service providers; `manual` for store-defined payment methods.",
      "enum": [
        "auto",
        "manual"
      ],
      "readOnly": true
    },
    "used_in_payout": {
      "description": "`true` when the provider is linked in the store payout configuration.",
      "type": "boolean",
      "readOnly": true
    },
    "is_default": {
      "description": "Marks the provider used to settle payout batches by default. Exactly one entry should be `true` when `payment_option` is `auto`.",
      "type": "boolean",
      "default": false
    },
    "logo_dark": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "logo_light": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: