PayoutConfig
Type: schema
TypeScript Definition
typescript
PayoutConfig: {{
/**
* @description Controls how seller payouts are disbursed.
*
* - `auto` - payout batches are settled through the connected payment providers listed in `payment_methods`.
*
* - `manual` - payouts are settled outside the platform, so no provider is linked and `payment_methods` is empty.
* @enum {unknown}
*/
payment_option: "auto" | "manual";
/** @description Payment providers used to settle payout batches. When writing, send only `slug` and `is_default` for each entry; the response returns each fully expanded `PayoutPaymentMethod`. Send an empty array when `payment_option` is `manual`. */
payment_methods: components["schemas"]["PayoutPaymentMethod"][];
};
/** PayoutPaymentMethod */
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["PayoutPaymentMethod"] | PayoutPaymentMethod |
OpenAPI Schema
json
{
"title": "PayoutConfig",
"type": "object",
"required": [
"payment_option",
"payment_methods"
],
"properties": {
"payment_option": {
"description": "Controls how seller payouts are disbursed.\n\n- `auto` - payout batches are settled through the connected payment providers listed in `payment_methods`.\n\n- `manual` - payouts are settled outside the platform, so no provider is linked and `payment_methods` is empty.",
"enum": [
"auto",
"manual"
]
},
"payment_methods": {
"description": "Payment providers used to settle payout batches. When writing, send only `slug` and `is_default` for each entry; the response returns each fully expanded `PayoutPaymentMethod`. Send an empty array when `payment_option` is `manual`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PayoutPaymentMethod"
}
}
},
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions