Skip to main content

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​

The recorded payout request.