Payout queue — bulk payout eligibility
List all in-progress accounts of a type (default sim_funded) with live payout eligibility computed for each — one call instead of checking accounts one by one. Built for payout runs: pull the queue, review who is ready, then execute payouts per account.
Each row includes: the account (number, plan, trader email), current balance, and an eligibility object with eligible, flat, the current payout cycle (cycleStartingBalance, cycleProfit, payoutCount), any locked loss floor, and the full consistency status with plain-language blocking reasons.
The summary block aggregates the page: how many accounts are eligible, the combined cycle profit, and the eligible cycle profit (a realistic upper bound for the payout run).
Notes:
eligibility: nullmeans the engine could not be reached for that account (counted asunknownin the summary) — retry or check the account individually.- Eligibility means: account is flat (no open positions/orders), tradable, and passes its funded consistency rule (when
consistencyEnforced). cycleProfitis profit since the last payout withconsistencyReset(or since funding) — the natural maximum payout amount.
Example:
curl "https://api.hyperprop.com/platform/v1/organization/payout-eligibility?eligibleOnly=true" \
-H "X-API-Key: hp_live_your_key_here"
Authorizations
JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.
Query Parameters
Account type to check. Payouts normally apply to sim_funded accounts only — evaluation/competition are supported for special cases.
evaluation, sim_funded, competition Return only accounts that are payout-eligible right now.
Accounts per page (eligibility is computed live for each account on the page).
1 <= x <= 200Pagination offset.
x >= 0Related topics
Check payout eligibilityList roles (system presets + your custom roles)Create a custom roleList payouts for an accountGet daily payout activity