> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trdrs.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a balance operation

> Legacy. New integrations use the venue door: `POST /api/partner/venues/{venueId}/accounts/{accountId}/balance` runs the same operation behind a venue key scope, and this route is kept for firms that predate venues. Credits, debits, or adjusts the balance of one firm-issued account outside of trading: a payout debit, a promotional credit, a correction. `amount` is positive and `op` carries the direction; the move lands on the account immediately and the trader’s dashboard repaints live.

The ledger entry, balance, revision and webhook delivery records commit together, keyed on your `referenceId` — a duplicate reference answers 409 and moves nothing, so a retried pipeline can never pay out twice. The ledger row is permanent and auditable on both sides; trading P&L never flows through this route (fills settle on their own path). Balance operations share the account execution lane with trading. An unknown prior effect blocks admission. If a dispatched operation returns outcome_unknown, read GET on this endpoint using the original reference before retrying. Requests are limited to 16 KiB.



## OpenAPI

````yaml /partner-platform/openapi.json post /api/partner/balance-op
openapi: 3.1.0
info:
  title: trdrs Engine API
  version: 1.1.0
  description: >-
    ## API Reference


    This is the served OpenAPI contract for the trdrs engine: market data,
    trading and account

    routes for your firm's traders, trdrs Connect account-registration handoff,
    and preview

    challenge routes.


    See Quick Start for the first integration path: key setup, market config,
    chart data, Connect

    account registrations, idempotency, stream reconnects, and conformance.


    See Overview and API Standards for the cross-cutting contract rules.
servers:
  - url: https://app.trdrs.co
    description: Production
  - url: /
    description: This engine
security: []
tags:
  - name: Venue platform preview
    description: >-
      Disabled private-preview venue configuration APIs.
      VENUE_CONFIGURATION_ENABLED and a vault are required. Every route
      documented here under /api/partner/ is also served under /api/operator/ to
      a verified owner session, by the same router with a different credential:
      a browser must never hold a venue key, so an operator console reaches the
      identical checks that way rather than through a second copy of this
      surface. Not part of the stable public contract until qualification and
      release; existing partner APIs remain unchanged.
  - name: Market data
    description: >-
      Symbol search and resolution, OHLCV history, quote snapshots, the server
      clock, and the live bar stream. Crypto rides each venue’s public feed;
      futures stream from the caller’s own connected Rithmic account. With none
      connected, futures requests answer 503 `feed_requires_connection`.
  - name: News
    description: >-
      Aggregated market news and the economic calendar, from licensed/open
      sources, keyword-tagged with futures roots at ingest. Platform-wide
      content (nothing per-user), admitted exactly like Market data: a licensed
      origin, a session, or a firm API key. Headlines page by published time,
      scope by instrument root, and stream live over SSE; thumbnails serve
      through the image proxy.
  - name: Trading
    description: >-
      The money surface: entries, exits, replaces, cancels, and position/account
      flattening. Every order-placing call uses `clientOrderId` as its
      idempotency key.
  - name: Account
    description: >-
      Reading a connected account. You do not create trading accounts here: a
      trader connects their own broker account (or creates a free demo account)
      in the app, and firms create evaluation accounts through the Partner API
      (Firm accounts → Create evaluation accounts) or register venue accounts
      through Connect (Create an account registration). Account state and the
      durable ledgers: balances, positions, working orders, fills, P&L history,
      and the live account stream.
  - name: Connect
    description: >-
      Connect is the account picker a trader opens, in our app or embedded on a
      partner’s site: the brokers we run, plus every listed venue. These three
      routes are how a firm PRE-FILLS it. You tell us a trader has an account at
      a broker we support (their sign-in email, and optionally the account
      number and login name); when that trader signs in, Connect shows the
      account ready to link and they type only their own password. Nothing here
      sends a password or grants access before the trader’s own login succeeds.
      You can list who you pre-registered and who has linked, and cancel a
      pre-registration that has not been used. Pre-registrations expire after 30
      days; repeating one refreshes it. These routes take the Partner API key
      today and are Connect’s own; they are not part of the legacy
      firm-operations surface. The end-to-end flow is **[Quick
      Start](/docs/guides/quick-start)**.
  - name: Firm accounts (legacy)
    description: >-
      Legacy. Every route in this group has a venue twin under
      `/api/partner/venues/{venueId}/accounts…`, reached with a venue key and a
      named scope, and new integrations use those; this group stays for firms
      that predate venues, and the same operation runs behind both doors.
      Evaluation accounts your firm issues on the trdrs venue, through your
      partner key — the other half of account setup. Connect registrations hand
      off accounts that exist on your venue; these routes create and manage
      accounts on ours: the trader trades them on trdrs, and your firm owns the
      lifecycle. Every route is scoped to accounts your firm created through
      this API — an account the same trader opened themselves is invisible and
      untouchable here, by construction. Creation is batched with per-item
      results, and every write carries your own `referenceId`, so a crashed
      pipeline retries safely. Served when the deployment runs the prop engine;
      without it, every route in this group answers `404`.
  - name: Billing
    description: >-
      Legacy, per firm. What your firm is billed for in a month, computed from
      the execution ledger, and the accounts behind the number. The venue
      platform will carry per-venue usage; until it does these two routes answer
      the Partner API key.
  - name: Webhooks
    description: >-
      Being replaced by the venue API: venue-scoped events are not built yet, so
      this is the one job a venue-only backend still needs a Partner key for;
      nothing here is removed until they are. The outbound event bus: register
      an https endpoint and the platform pushes events to it instead of your
      back office polling us. Every delivery is signed (`trdrs-signature:
      t=<unix>,v1=<hmac-sha256>` over `${t}.${rawBody}`) so you can prove it
      came from us and is fresh, and every delivery is durable — a failed
      attempt is retried with backoff for about nine hours and the whole log is
      readable, so an endpoint that was down is a delay rather than a lost
      event. Serves brokers and prop firms alike: the account-registration
      (`registration.*`) events fire wherever Connect does, and the account
      events fire where the prop engine runs.
  - name: Challenges
    description: >-
      Being replaced by the venue API: stage rules on the venue carry the firm’s
      half of this; the trader’s enroll flow has not moved yet. The prop
      evaluation surface: challenge programs and a trader’s own enrollments.
      **Preview: the one group on this page outside the additive-only
      guarantee** (the pre-contract v1 scaffold; the Phase-1 rebuild will change
      these shapes; see Stability). **Cookie-authenticated, not
      key-authenticated**, and served only when the engine runs with
      `CHALLENGES_ENABLED`; without that flag the bundle is absent and every
      route below returns `404`. The firm-console/admin half of this surface is
      deliberately not documented here. It is back office, not licensed surface.
paths:
  /api/partner/balance-op:
    post:
      tags:
        - Firm accounts (legacy)
      summary: Create a balance operation
      description: >-
        Legacy. New integrations use the venue door: `POST
        /api/partner/venues/{venueId}/accounts/{accountId}/balance` runs the
        same operation behind a venue key scope, and this route is kept for
        firms that predate venues. Credits, debits, or adjusts the balance of
        one firm-issued account outside of trading: a payout debit, a
        promotional credit, a correction. `amount` is positive and `op` carries
        the direction; the move lands on the account immediately and the
        trader’s dashboard repaints live.


        The ledger entry, balance, revision and webhook delivery records commit
        together, keyed on your `referenceId` — a duplicate reference answers
        409 and moves nothing, so a retried pipeline can never pay out twice.
        The ledger row is permanent and auditable on both sides; trading P&L
        never flows through this route (fills settle on their own path). Balance
        operations share the account execution lane with trading. An unknown
        prior effect blocks admission. If a dispatched operation returns
        outcome_unknown, read GET on this endpoint using the original reference
        before retrying. Requests are limited to 16 KiB.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerBalanceOpRequest'
      responses:
        '200':
          description: Recorded and applied (PartnerBalanceOpResponse)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerBalanceOpResponse'
        '400':
          description: >-
            Malformed input — a missing field, a non-positive amount, or an
            unknown op
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The bearer is not a partner-scoped key for an active partner firm
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            No firm-issued account with that number (or issuing accounts is not
            enabled on this deployment)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            Duplicate referenceId (duplicate=true), or account admission refused
            (code=account_unavailable); no new operation dispatched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '413':
          description: Balance request exceeds 16 KiB
        '503':
          description: >-
            Ownership unavailable, draining, or dispatched outcome unknown; read
            the original operation result before retrying
      security:
        - partnerKey: []
      x-codeSamples:
        - lang: javascript
          label: TypeScript
          source: >-
            const res = await
            fetch('https://app.trdrs.co/api/partner/balance-op', {
              method: 'POST',
              headers: {
                'content-type': 'application/json',
                Authorization: `Bearer ${process.env.TRDRS_API_KEY}`,
              },
              body: JSON.stringify({
                "accountNumber": "EVAL-7C21A9",
                "op": "debit",
                "amount": 800,
                "referenceId": "payout-2026-08-31-a",
                "comment": "August profit-share payout"
              }),
            })

            const data = await res.json()
        - lang: shell
          label: cURL
          source: |-
            curl -X POST 'https://app.trdrs.co/api/partner/balance-op' \
              -H "Authorization: Bearer $TRDRS_API_KEY" \
              -H 'content-type: application/json' \
              -d '{"accountNumber":"EVAL-7C21A9","op":"debit","amount":800,"referenceId":"payout-2026-08-31-a","comment":"August profit-share payout"}'
components:
  schemas:
    PartnerBalanceOpRequest:
      type: object
      description: >-
        PartnerBalanceOpRequest. One non-trading balance move. `amount` is
        positive, in account currency — `op` carries the direction (`debit`
        subtracts). `referenceId` is your idempotency handle: a duplicate
        answers 409 and moves nothing.
      properties:
        accountNumber:
          type: string
          description: A firm-issued account number.
        op:
          type: string
          enum:
            - credit
            - debit
            - adjustment
        amount:
          type: number
          description: Positive, in account currency (≤10000000). The op carries the sign.
        referenceId:
          type: string
          description: Your idempotency handle for this operation (≤80 chars).
        comment:
          type: string
          description: Optional audit note (≤300 chars), kept on the ledger row.
      required:
        - accountNumber
        - op
        - amount
        - referenceId
      example:
        accountNumber: EVAL-7C21A9
        op: debit
        amount: 800
        referenceId: payout-2026-08-31-a
        comment: August profit-share payout
    PartnerBalanceOpResponse:
      type: object
      description: >-
        PartnerBalanceOpResponse. The operation was recorded on the ledger and
        the balance moved.
      properties:
        recorded:
          type: boolean
        op:
          type: string
          enum:
            - credit
            - debit
            - adjustment
        amount:
          type: number
      required:
        - recorded
        - op
        - amount
      example:
        recorded: true
        op: debit
        amount: 800
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
      required:
        - error
      example:
        error: invalid_instrument
  securitySchemes:
    partnerKey:
      type: http
      scheme: bearer
      description: >-
        A partner-scoped API key (`trdrs_sk_…`), issued to a trdrs Connect
        partner firm and accepted only under `/api/partner/`. Same format as the
        firm (`tenant`) key, different scope: a firm API key is refused here,
        and this key is refused everywhere else.

````