> ## 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. # Get a balance adjustment by reference > One adjustment on the account, by your reference: its status and the balance before and after. Use it to reconcile, or to check an adjustment whose response you did not receive. Requires **view** permission on traders. ```bash curl "https://api.hyperprop.com/platform/v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/balance-adjustments/DEP-2026-104233" \ -H "X-API-Key: hp_live_your_key_here" ``` ## OpenAPI ````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments/{reference} 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: Instruments description: >- The contracts your organization's accounts can trade, with their specifications. - 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: Mass credit description: >- Credit back losses across many accounts after an incident, as background jobs you can follow, pause, export and reverse. - 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 keys: rotation, read-only keys and IP allowlists. - name: Logs and health description: >- API request logs, the audit log, integration health, and idempotency key recovery. - 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/trading-accounts/{accountId}/balance-adjustments/{reference}: get: tags: - Trading accounts summary: Get a balance adjustment by reference description: >- One adjustment on the account, by your reference: its status and the balance before and after. Use it to reconcile, or to check an adjustment whose response you did not receive. Requires **view** permission on traders. ```bash curl "https://api.hyperprop.com/platform/v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/balance-adjustments/DEP-2026-104233" \ -H "X-API-Key: hp_live_your_key_here" ``` operationId: getV1OrganizationTradingaccountsAccountidBalanceadjustmentsReference parameters: - description: Trading account ID x-format: guid: true name: accountId in: path required: true schema: type: string - description: >- Your reference for this adjustment, for example your deposit or withdrawal ID: 1 to 128 characters, letters, digits and `. _ : @ + = ~ -`, starting with a letter or digit. Unique within your organization and case-sensitive. name: reference in: path required: true schema: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9._:@+=~-]{0,127}$ responses: '200': description: Adjustment retrieved content: '*/*': schema: $ref: '#/components/schemas/Model844' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model11' '403': description: >- Forbidden - The caller lacks traders:view (`INSUFFICIENT_PERMISSIONS`) content: '*/*': schema: $ref: '#/components/schemas/Model845' '404': description: >- Not Found - The account is not in your organization (`ACCOUNT_NOT_FOUND`), or it has no adjustment with this reference (`ADJUSTMENT_NOT_FOUND`) content: '*/*': schema: $ref: '#/components/schemas/Model847' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model6' '503': description: Balance adjustments are not available yet; nothing was changed content: '*/*': schema: $ref: '#/components/schemas/Model767' '504': description: >- Gateway Timeout - The request did not complete within 25 seconds (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the request (for example a shorter date range). content: '*/*': schema: $ref: '#/components/schemas/Model848' security: - X-API-Key: [] components: schemas: Model844: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model760' Model11: 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 Model845: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Your role does not have write access to "Traders & accounts" code: $ref: '#/components/schemas/code' Model847: type: object properties: success: type: boolean example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: No balance adjustment with this reference on this account code: $ref: '#/components/schemas/Model846' Model6: 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 Model767: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 503 error: type: string example: Error message: type: string example: Balance adjustments are not available yet; nothing was changed code: type: string description: Machine-readable error code — switch on this, not on message text example: FEATURE_NOT_READY Model848: type: object properties: statusCode: type: number example: 504 error: type: string example: Gateway Timeout message: type: string example: >- The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range). code: type: string description: Machine-readable error code — switch on this, not on message text example: REQUEST_TIMEOUT Model760: type: object properties: adjustmentId: type: string example: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d x-format: guid: true reference: type: string example: DEP-2026-104233 accountId: type: string example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 x-format: guid: true accountNumber: type: string example: ACC-50K-000123 type: $ref: '#/components/schemas/Model757' amount: type: number description: 'Signed: positive for a credit, negative for a debit' example: 500 status: $ref: '#/components/schemas/Model758' reason: type: string example: Deposit via card metadata: $ref: '#/components/schemas/Model759' countTowardDailyPnl: type: boolean example: false moveHighWaterMark: type: boolean example: false balanceBefore: type: number description: The live balance just before the adjustment (null until applied) example: 50000 balanceAfter: type: number description: The live balance just after the adjustment (null until applied) example: 50500 errorCode: type: string description: >- Why it is not applied: `ACCOUNT_CLOSED`, `OUTCOME_UNKNOWN`, or another refusal code example: null errorMessage: type: string example: null requestedBy: type: string description: '`api-key`, or the staff email for a portal user' example: api-key createdAt: type: string example: '2026-10-30T11:02:11.000Z' appliedAt: type: string example: '2026-10-30T11:02:11.412Z' code: type: string example: INSUFFICIENT_PERMISSIONS enum: - INSUFFICIENT_PERMISSIONS Model846: type: string example: ADJUSTMENT_NOT_FOUND enum: - ACCOUNT_NOT_FOUND - ADJUSTMENT_NOT_FOUND Model757: type: string example: credit enum: - credit - debit Model758: type: string description: >- `applied`: the balance changed. `pending`: not confirmed yet; send the same request again to settle it. `failed`: not applied (`errorCode`) example: applied enum: - applied - pending - failed Model759: 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 - [Get a balance adjustment batch](https://docs.hyperprop.com/platform-api/mass-credit/get-a-balance-adjustment-batch.md) - [Balance adjustments](https://docs.hyperprop.com/guides/balance-adjustments.md) - [List an account's balance adjustments](https://docs.hyperprop.com/platform-api/trading-accounts/list-an-accounts-balance-adjustments.md) - [List balance adjustment batches](https://docs.hyperprop.com/platform-api/mass-credit/list-balance-adjustment-batches.md) - [Retry a balance adjustment batch](https://docs.hyperprop.com/platform-api/mass-credit/retry-a-balance-adjustment-batch.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.