> ## 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. # Check payout eligibility > Pre-check whether a payout would succeed right now, without executing anything. Returns the flat/tradable state, the current payout cycle (starting balance, cycle profit, payout count), any locked loss floor, and the **full consistency status** — including the daily cap, the best day, and plain-language `reasons` whenever the rule is currently blocking. Use this to show traders their payout readiness, or gate your own payout approval flow before calling the payout endpoint with `enforceConsistency`. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/accounts/{accountId}/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/accounts/{accountId}/payout-eligibility: get: tags: - Payouts summary: Check payout eligibility description: >- Pre-check whether a payout would succeed right now, without executing anything. Returns the flat/tradable state, the current payout cycle (starting balance, cycle profit, payout count), any locked loss floor, and the **full consistency status** — including the daily cap, the best day, and plain-language `reasons` whenever the rule is currently blocking. Use this to show traders their payout readiness, or gate your own payout approval flow before calling the payout endpoint with `enforceConsistency`. operationId: getV1OrganizationAccountsAccountidPayouteligibility parameters: - description: Trading account to check x-format: guid: true name: accountId in: path required: true schema: type: string responses: '200': description: Eligibility computed content: '*/*': schema: $ref: '#/components/schemas/Model404' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '404': description: Account not found content: '*/*': schema: $ref: '#/components/schemas/Model405' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model404: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model403' 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 Model405: type: object properties: statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Account not found in your organization code: type: string example: ACCOUNT_NOT_FOUND 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 Model403: type: object example: accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 eligible: false flat: true status: InProgress currentBalance: 52500 cycleStartingBalance: 50000 cycleProfit: 2500 payoutCount: 0 lossFloorBalance: null consistency: enforced: true gate: funded_payout eligible: false consistency_pct: 50 base_mode: cycle_profit base_amount: 2500 daily_cap: 1290 buffer: 40 best_day_pnl: 1290 best_day: '2026-07-10' profitable_days: 3 min_profitable_days: 0 reference_pnl: 2500 blocking_days: - trading_day: '2026-07-10' net_pnl: 1290 reasons: - >- Best day $1,290.00 reaches the $1,290.00 daily cap (50% of $2,500.00 + $40.00 buffer). Spread gains across more days to dilute it. properties: accountId: type: string eligible: type: boolean flat: type: boolean status: type: string currentBalance: type: number 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 - [Payout queue — bulk payout eligibility](/platform-api/payouts/payout-queue-—-bulk-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) - [Execute a payout (balance withdrawal)](/platform-api/payouts/execute-a-payout-balance-withdrawal.md) - [Errors](/concepts/errors.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.