> ## 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. # Reverse a balance credit > Takes back the credits of a credit batch: each applied, not yet reversed credit is debited from its account by the same amount, with the same day-baseline and high-water-mark treatment, as a new batch of kind `reversal`. A credit is reversed at most once. A reversal lowers the balance like any other debit, so it can bring an account to its loss limits. Passed, failed or expired accounts are not debited (`ACCOUNT_CLOSED`). Returns `202` with the reversal's `batchId`; follow it like any batch. Requires **manage** permission on traders. ```bash curl -X POST "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60/reverse" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"reason": "Credited in error"}' ``` ## OpenAPI ````yaml https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/reverse 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: 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 key. - 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/balance-adjustments/{batchId}/reverse: post: tags: - Mass credit summary: Reverse a balance credit description: >- Takes back the credits of a credit batch: each applied, not yet reversed credit is debited from its account by the same amount, with the same day-baseline and high-water-mark treatment, as a new batch of kind `reversal`. A credit is reversed at most once. A reversal lowers the balance like any other debit, so it can bring an account to its loss limits. Passed, failed or expired accounts are not debited (`ACCOUNT_CLOSED`). Returns `202` with the reversal's `batchId`; follow it like any batch. Requires **manage** permission on traders. ```bash curl -X POST "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60/reverse" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"reason": "Credited in error"}' ``` operationId: postV1OrganizationBalanceadjustmentsBatchidReverse parameters: - x-format: guid: true name: batchId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Model1114' responses: '200': description: 'Preview - What would be reversed (only with `preview: true`)' content: '*/*': schema: $ref: '#/components/schemas/Model1116' '202': description: Accepted - The reversal has started content: '*/*': schema: $ref: '#/components/schemas/Model1119' '400': description: No applied, unreversed credit in this batch matches content: '*/*': schema: $ref: '#/components/schemas/Model1120' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model11' '403': description: >- Forbidden - The caller lacks traders:manage (`INSUFFICIENT_PERMISSIONS`) content: '*/*': schema: $ref: '#/components/schemas/Model1121' '404': description: Balance adjustment batch not found content: '*/*': schema: $ref: '#/components/schemas/Model1122' '409': description: The batch is still being applied; reverse it once it has finished content: '*/*': schema: $ref: '#/components/schemas/Model1123' '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/Model93' security: - X-API-Key: [] components: schemas: Model1114: type: object properties: reason: type: string example: Credited in error minLength: 3 maxLength: 200 x-convert: trim: true accountIds: $ref: '#/components/schemas/Model1113' preview: type: boolean description: >- When true, only report how many credits, and how much, would be reversed. default: false required: - reason Model1116: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model1115' Model1119: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model1118' Model1120: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: No applied, unreversed credit in this batch matches code: type: string description: Machine-readable error code — switch on this, not on message text example: NOTHING_TO_REVERSE 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 Model1121: 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' Model1122: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Balance adjustment batch not found code: type: string description: Machine-readable error code — switch on this, not on message text example: BATCH_NOT_FOUND Model1123: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 409 error: type: string example: Conflict message: type: string example: The batch is still being applied; reverse it once it has finished code: type: string description: Machine-readable error code — switch on this, not on message text example: BATCH_RUNNING 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 Model93: 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 Model1113: type: array description: >- Reverse only these accounts' credits. All applied credits of the batch when omitted. example: - 7c9e6679-7425-40de-944b-e07fc1f90ae7 minItems: 1 maxItems: 5000 items: type: string x-format: guid: true Model1115: type: object properties: preview: type: boolean example: true total: type: integer example: 838 totalAmount: type: number example: 186010.25 Model1118: type: object properties: batchId: type: string example: 5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60 x-format: guid: true kind: $ref: '#/components/schemas/kind' tag: type: string example: incident-2026-10-21 reason: type: string example: US-open outage, 21 October status: $ref: '#/components/schemas/Model1117' windowStart: type: string example: '2026-10-21T13:30:00.000Z' windowEnd: type: string example: '2026-10-21T14:15:00.000Z' policy: $ref: '#/components/schemas/policy' requestedBy: type: string description: Staff email, or `api-key` example: ops@yourfirm.com total: type: integer description: Adjustments in the batch example: 840 processed: type: integer example: 840 applied: type: integer example: 838 failed: type: integer description: Adjustments not applied, or not confirmed; see `adjustments` example: 2 skipped: type: integer description: Accounts the preview left out example: 410 totalAmount: type: number description: Negative for a reversal example: 186420.75 appliedAmount: type: number example: 186010.25 reversesBatchId: type: string description: 'For a reversal: the credit batch it reverses' example: null x-format: guid: true createdAt: type: string example: '2026-10-25T15:02:11.000Z' lastProgressAt: type: string example: '2026-10-25T15:04:52.000Z' completedAt: type: string example: '2026-10-25T15:04:52.000Z' code: type: string example: INSUFFICIENT_PERMISSIONS enum: - INSUFFICIENT_PERMISSIONS kind: type: string example: credit enum: - credit - reversal Model1117: type: string description: >- `interrupted`: the batch stopped making progress before it finished (for example during a service restart). Retry it to finish; nothing is applied twice. example: completed enum: - running - completed - interrupted policy: type: object description: >- How the credit is computed and applied. Every field is optional; the defaults are shown. properties: lossBasis: $ref: '#/components/schemas/lossBasis' shiftDailyBaseline: type: boolean description: >- Default `true`: the day's starting balance moves with the credit, so the credit is not counted as that day's profit (daily loss limit and daily profit stay as they were). example: true highWaterMarkMode: $ref: '#/components/schemas/highWaterMarkMode' requireFlat: type: boolean description: >- Default `false`. When `true`, accounts that hold positions or working orders when the credit is applied are not credited (they fail with `OPEN_EXPOSURE`; retry later). example: false skipAlreadyCredited: type: boolean description: >- Default `true`: leave out accounts already credited, and not reversed, by a batch whose window overlaps this one. example: true maxCreditPerAccount: type: number description: Largest credit one account may get. No cap by default. example: null x-constraint: precision: 2 sign: positive lossBasis: type: string description: >- What is credited back: the net P&L of the window's fills after fees and commission (default), or before them. example: net_after_fees enum: - net_after_fees - net_before_fees highWaterMarkMode: type: string description: >- Default `unchanged`: the high-water mark (trailing drawdown peak) stays where it is. `shift` moves it by the credit as well. example: unchanged enum: - unchanged - shift 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 - [Reverse a mass credit](https://docs.hyperprop.com/platform-api/mass-credit/reverse-a-mass-credit.md) - [Reverse a payout (restore the withdrawn balance)](https://docs.hyperprop.com/platform-api/payouts/reverse-a-payout-restore-the-withdrawn-balance.md) - [Preview a balance credit](https://docs.hyperprop.com/platform-api/mass-credit/preview-a-balance-credit.md) - [Get a balance adjustment batch](https://docs.hyperprop.com/platform-api/mass-credit/get-a-balance-adjustment-batch.md) - [List balance adjustment batches](https://docs.hyperprop.com/platform-api/mass-credit/list-balance-adjustment-batches.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.