> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # 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: null` means the engine could not be reached for that account (counted as `unknown` in 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`). - `cycleProfit` is profit since the last payout with `consistencyReset` (or since funding) — the natural maximum payout amount. **Example:** ```bash curl "https://api.hyperprop.com/platform/v1/organization/payout-eligibility?eligibleOnly=true" \ -H "X-API-Key: hp_live_your_key_here" ``` ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/payout-eligibility openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/payout-eligibility: get: tags: - Payouts summary: Payout queue — bulk payout eligibility description: >- 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: null` means the engine could not be reached for that account (counted as `unknown` in 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`). - `cycleProfit` is profit since the last payout with `consistencyReset` (or since funding) — the natural maximum payout amount. **Example:** ```bash curl "https://api.hyperprop.com/platform/v1/organization/payout-eligibility?eligibleOnly=true" \ -H "X-API-Key: hp_live_your_key_here" ``` operationId: getV1OrganizationPayouteligibility parameters: - description: >- Account type to check. Payouts normally apply to sim_funded accounts only — evaluation/competition are supported for special cases. name: type in: query schema: type: string enum: - evaluation - sim_funded - competition default: sim_funded - description: Return only accounts that are payout-eligible right now. name: eligibleOnly in: query schema: type: boolean default: false - description: >- Accounts per page (eligibility is computed live for each account on the page). name: limit in: query schema: type: integer minimum: 1 maximum: 200 default: 100 - description: Pagination offset. name: offset in: query schema: type: integer minimum: 0 default: 0 responses: '200': description: Payout queue computed content: '*/*': schema: $ref: '#/components/schemas/Model88' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model88: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model87' Model9: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model87: type: object example: accounts: - accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: ACC-MR883A4P type: sim_funded status: in_progress initialBalance: 50000 currentBalance: 52500 planName: 25K Starter trader: email: trader@example.com name: Jane Trader eligibility: eligible: true flat: true engineStatus: InProgress cycleStartingBalance: 50000 cycleProfit: 2500 payoutCount: 0 lossFloorBalance: null consistency: null summary: totalAccounts: 12 checked: 12 eligible: 5 notEligible: 7 unknown: 0 totalCycleProfit: 18400 eligibleCycleProfit: 9200 pagination: total: 12 limit: 100 offset: 0 hasMore: false properties: accounts: $ref: '#/components/schemas/Model84' summary: $ref: '#/components/schemas/Model85' pagination: $ref: '#/components/schemas/Model86' Model84: type: array items: $ref: '#/components/schemas/Model83' Model85: type: object properties: totalAccounts: type: number checked: type: number eligible: type: number notEligible: type: number unknown: type: number totalCycleProfit: type: number eligibleCycleProfit: type: number Model86: type: object properties: total: type: number limit: type: number offset: type: number hasMore: type: boolean Model83: type: object properties: accountId: type: string accountNumber: type: string type: type: string status: type: string initialBalance: type: number currentBalance: type: number planName: type: string trader: $ref: '#/components/schemas/trader' eligibility: $ref: '#/components/schemas/eligibility' trader: type: object properties: email: type: string name: type: string eligibility: type: object description: null = engine unreachable for this account properties: eligible: type: boolean flat: type: boolean engineStatus: type: string cycleStartingBalance: type: number cycleProfit: type: number payoutCount: type: number lossFloorBalance: type: number consistency: $ref: '#/components/schemas/consistency' consistency: type: object securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Check payout eligibility](/platform-api/payouts/check-payout-eligibility.md) - [List roles (system presets + your custom roles)](/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles.md) - [Introduction](/introduction.md) - [Create a custom role](/platform-api/team-and-roles/create-a-custom-role.md) - [List payouts for an account](/platform-api/payouts/list-payouts-for-an-account.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.