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

# Cancel a batch of orders by id (max 100)

> Cancel up to 100 orders by id in one request. Each id is resolved against the authenticated wallet; ids that are unknown, belong to another wallet, or are already terminal come back under `notCancelled` (no existence leak). Duplicate ids are de-duplicated. The whole batch runs as one PG transaction — a single advisory-lock acquire and one COMMIT — with the matcher fan-out fired off the response path, so latency is bounded by a single round-trip rather than N. Idempotent: re-cancelling a terminal order reports `already_terminal`. Rate limited at 5 req/sec per wallet. No KYC / deposit-tier gating — cancellation is always permitted.



## OpenAPI

````yaml /api-reference/openapi.json post /api/orders/cancel-batch
openapi: 3.1.0
info:
  title: PredictStreet core-api
  description: >-
    Client-facing HTTP gateway for the PredictStreet prediction-market platform.
    This spec is hand-written against the NestJS controllers and DTOs in
    core-api/src/modules/. For the source-of-truth live spec, run
    `./scripts/pull-openapi.sh` against a running core-api (NestJS exposes it at
    /api/docs-json). **Partner kinds.** Every authenticated endpoint resolves a
    request's *effective wallet* from the partner row. `single_wallet` partners
    bind to one `associatedWallet` set at creation. `multi_wallet` partners
    declare the actor on every request via an `X-User-Wallet: 0x<40-hex>`
    header. See the [Partner kinds](/auth/api-keys#partner-kinds) doc for the
    full contract.
  version: '2026-06-16'
  contact:
    name: PredictStreet partners
    email: partners@predictstreet.com
servers:
  - url: https://core.api.dev.predictstreet.sde.adifoundation.ai
    description: Testnet (partner integrator API — final domain TBD)
security: []
tags:
  - name: Deposits
    description: >-
      Gasless USDC deposit relay - submit a signed EIP-2612 permit and the
      platform broadcasts the on-chain deposit for you (no gas).
  - name: Events
    description: >-
      Polymarket-style event grouping with football metadata (group, stage,
      teams, tags).
  - name: Tags
    description: Curated tag taxonomy used to filter events.
  - name: Markets
    description: 'Public market data: list, detail, orderbook, trades, OHLC.'
  - name: Orders
    description: >-
      Signed-order place / cancel / read. Requires `X-Api-Key` with
      `orders:read` / `orders:write` scope; every write additionally requires an
      EIP-712 signature over the order.
  - name: Portfolio
    description: >-
      Balances, positions, trades, fees, vault info for the key's
      `associatedWallet`. Requires `X-Api-Key` with `portfolio:read` scope.
  - name: Matches
    description: >-
      admin.matches aggregate — groups several events into one fixture/card (1X2
      + first-scorer + over-under under one matchup).
  - name: Vault
    description: >-
      Backend co-signatures for ERC-1155 split / merge, and recovery for
      off-chain locks when the corresponding chain tx never confirmed. Requires
      `X-Api-Key` with `vault:write` scope plus an EIP-712 signature over the
      operation.
  - name: Leaderboard
    description: Public ranked leaderboard across PnL / volume buckets.
  - name: Search
    description: Global search across users, events, and matches.
  - name: Withdrawal Security
    description: >-
      Self-service withdrawal 2FA (TOTP) and withdrawal-address whitelist. Same
      endpoints serve the frontend (Privy JWT) and API-key integrators.
      Mutations need `vault:write`, reads `portfolio:read`. Both are opt-in per
      wallet and only gate withdrawals once the platform enables
      withdrawal-security enforcement.
paths:
  /api/orders/cancel-batch:
    post:
      tags:
        - Orders
      summary: Cancel a batch of orders by id (max 100)
      description: >-
        Cancel up to 100 orders by id in one request. Each id is resolved
        against the authenticated wallet; ids that are unknown, belong to
        another wallet, or are already terminal come back under `notCancelled`
        (no existence leak). Duplicate ids are de-duplicated. The whole batch
        runs as one PG transaction — a single advisory-lock acquire and one
        COMMIT — with the matcher fan-out fired off the response path, so
        latency is bounded by a single round-trip rather than N. Idempotent:
        re-cancelling a terminal order reports `already_terminal`. Rate limited
        at 5 req/sec per wallet. No KYC / deposit-tier gating — cancellation is
        always permitted.
      operationId: OrdersController_cancelBatch
      parameters:
        - $ref: '#/components/parameters/UserWalletHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelBatchRequest'
      responses:
        '200':
          description: Per-id outcome split into `cancelled` and `notCancelled`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelBatchRespDto'
        '400':
          description: Empty array or more than 100 ids. Nothing is cancelled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: API-key caller is missing the orders:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - ApiKeyAuth:
            - orders:write
components:
  parameters:
    UserWalletHeader:
      name: X-User-Wallet
      in: header
      required: false
      description: >-
        **Required for `multi_wallet` partners on every authenticated request;
        ignored for `single_wallet`.** Declares the acting end-user wallet for
        this request — drives KYC checks, balances/positions/orders attribution,
        rate-limit buckets, and audit. Lower-cased server-side. Missing on a
        multi_wallet key → 401 `api_key_user_wallet_required`; malformed → 401
        `api_key_user_wallet_invalid`. The on-chain `CTFExchange`/`Vault`
        contracts still verify EIP-712 signer ↔ vault binding, so loosening
        API-layer attribution is safe by construction.
      schema:
        $ref: '#/components/schemas/EthereumAddress'
      example: '0x1234567890abcdef1234567890abcdef12345678'
  schemas:
    CancelBatchRequest:
      type: object
      required:
        - orderIds
      properties:
        orderIds:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: string
          description: >-
            1–100 server-side order ids (UUIDs). Duplicates are de-duplicated
            server-side.
    CancelBatchRespDto:
      type: object
      properties:
        cancelled:
          type: array
          items:
            type: string
          description: Ids of the orders that transitioned to CANCELLED.
        notCancelled:
          type: object
          additionalProperties:
            type: string
          description: >-
            Map of orderId → reason for every id that was not cancelled.
            Reasons: `not_found` (unknown id, or an order owned by another
            wallet — no existence leak), `already_terminal` (already CANCELLED /
            FILLED / REJECTED / EXPIRED — idempotent), `lock_invariant` (a
            per-order balance-lock invariant tripped; the rest of the batch is
            unaffected), `unknown` (transient failure — safe to retry).
      required:
        - cancelled
        - notCancelled
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        status:
          type: integer
          example: 400
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: bad_request
            message:
              type: string
            details:
              type: object
              additionalProperties: true
            trace_id:
              type: string
    EthereumAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3'
    Error:
      type: object
      required:
        - code
      properties:
        code:
          type: string
          description: >-
            Machine-readable code (e.g. `insufficient_funds`, `market_not_open`,
            `rate_limited`).
        message:
          type: string
        details:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid, or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        Rate limit exceeded. `Retry-After` and `X-RateLimit-Reset` headers are
        set.
      headers:
        Retry-After:
          schema:
            type: integer
        X-RateLimit-Limit:
          schema:
            type: integer
        X-RateLimit-Remaining:
          schema:
            type: integer
        X-RateLimit-Reset:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: Downstream service (exchange, matcher) unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Partner / integrator key — format `ps_live_<keyId>_<secret>`. Issued by
        PredictStreet ops via the admin panel; never self-service. Never ship to
        a browser. `multi_wallet` partners must additionally send
        `X-User-Wallet: 0x<40-hex>` on every authenticated request to declare
        the acting wallet. See the [API keys guide](/auth/api-keys) for scope
        taxonomy, partner kinds, rate limits, and rotation procedure.

````