Request a payout of the available balance
POST/api/referral/payout
Records a payout request for the referrer's FULL available balance. Admin / account owner only.
Refused 422 when the available balance is below the configured minimum
(config('referral.min_payout')) or zero, and 409 when the referrer
already has an open (pending) payout request. On success the created row is
requested only.
FINANCIAL BOUNDARY: this NEVER initiates a real transfer. Settlement (paid) is
a manual operator step (no super-admin role yet — the request waits in the
queue). There is no request body — the amount is always the full available
balance, computed server-side; the client can never name an amount.
Responses
- 201
- 401
- 403
- 409
- 422
The recorded payout request.
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
Authenticated but not allowed.
The referrer already has an open (pending) payout request; only one is allowed at a time until the operator settles it.
The request failed validation.