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

# Cancel an order

> Stops the expiry remainder and asks the bookmaker to cancel every bet it has not accepted yet. A bet the bookmaker accepted cannot be recalled. Each bet is tagged with its outcome; cancelling again gives the same answer. Not counted against any per-key rate limit.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/orders/{id}/cancel
openapi: 3.1.0
info:
  title: Apexium Trading API
  version: '1'
  description: Public API, authenticated with an API key in the x-api-key header.
servers:
  - url: https://api.apexiumbet.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Health
    description: Whether the API is up, without an API key
  - name: Account
    description: The account behind the API key and its balance
  - name: Reference data
    description: OddsPapi sports, tournaments, participants, markets and bookmakers
  - name: Fixtures
    description: 'OddsPapi fixtures: schedule, status, scores'
  - name: Odds
    description: OddsPapi odds, limited to the account's bookmakers
  - name: Betslip
    description: >-
      The price and stake limits of one selection at each of the account's
      bookmakers
  - name: Orders
    description: Preview, place, read and cancel orders
  - name: Bets
    description: The bets your orders were split into
  - name: Positions and PnL
    description: Open exposure and realised results
paths:
  /v1/orders/{id}/cancel:
    post:
      tags:
        - Orders
      summary: Cancel an order
      description: >-
        Stops the expiry remainder and asks the bookmaker to cancel every bet it
        has not accepted yet. A bet the bookmaker accepted cannot be recalled.
        Each bet is tagged with its outcome; cancelling again gives the same
        answer. Not counted against any per-key rate limit.
      parameters:
        - schema:
            format: uuid
            type: string
          in: path
          name: id
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - clientOrderId
                  - status
                  - selection
                  - side
                  - bookmakers
                  - requestedStake
                  - filledStake
                  - remainingStake
                  - minPrice
                  - averageFilledPrice
                  - acceptBetterOdds
                  - acceptPartialStake
                  - expiresAt
                  - createdAt
                  - updatedAt
                  - version
                  - remainder
                  - bets
                properties:
                  id:
                    format: uuid
                    type: string
                  clientOrderId:
                    anyOf:
                      - type: string
                      - type: 'null'
                  status:
                    type: string
                    enum:
                      - PENDING
                      - PARTIALLY_FILLED
                      - FILLED
                      - EXPIRED
                      - CANCELLED
                      - REJECTED
                  selection:
                    type: object
                    required:
                      - fixtureId
                      - outcomeId
                      - playerId
                      - sportId
                      - tournamentId
                      - marketId
                    properties:
                      fixtureId:
                        type: string
                      outcomeId:
                        type: integer
                      playerId:
                        type: integer
                      sportId:
                        type: integer
                      tournamentId:
                        anyOf:
                          - type: integer
                          - type: 'null'
                      marketId:
                        type: integer
                  side:
                    description: Only back is supported in v1
                    type: string
                    enum:
                      - back
                  bookmakers:
                    description: Bookmakers the stake was split across
                    type: array
                    items:
                      type: string
                  requestedStake:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
                  filledStake:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
                  remainingStake:
                    description: Money amount
                    type: object
                    required:
                      - amount
                      - amountCents
                      - currency
                    properties:
                      amount:
                        pattern: ^-?\d+\.\d{2}$
                        description: Decimal string, two decimals
                        type: string
                      amountCents:
                        description: 'The same amount in integer cents: amount times 100'
                        type: integer
                      currency:
                        description: ISO 4217 code
                        type: string
                  minPrice:
                    description: Decimal price floor
                    type: string
                  averageFilledPrice:
                    anyOf:
                      - description: Stake-weighted price of the filled legs
                        type: string
                      - type: 'null'
                  acceptBetterOdds:
                    type: boolean
                  acceptPartialStake:
                    type: boolean
                  expiresAt:
                    anyOf:
                      - format: date-time
                        type: string
                      - type: 'null'
                  createdAt:
                    format: date-time
                    type: string
                  updatedAt:
                    format: date-time
                    type: string
                  version:
                    description: >-
                      Goes up by one at every change of the order or one of its
                      bets
                    type: integer
                  remainder:
                    type: string
                    enum:
                      - cancelled
                      - alreadyTerminal
                      - none
                  bets:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - orderId
                        - bookmaker
                        - status
                        - requestedStake
                        - filledStake
                        - filledPrice
                        - declineReason
                        - placedAt
                        - filledAt
                        - settlement
                        - cancellation
                      properties:
                        id:
                          format: uuid
                          type: string
                        orderId:
                          format: uuid
                          type: string
                        bookmaker:
                          type: string
                        status:
                          type: string
                          enum:
                            - PENDING
                            - WAITING
                            - PARTIALLY_PLACED
                            - PLACED
                            - REJECTED
                            - CANCELLED
                            - SETTLED
                        requestedStake:
                          description: Money amount
                          type: object
                          required:
                            - amount
                            - amountCents
                            - currency
                          properties:
                            amount:
                              pattern: ^-?\d+\.\d{2}$
                              description: Decimal string, two decimals
                              type: string
                            amountCents:
                              description: >-
                                The same amount in integer cents: amount times
                                100
                              type: integer
                            currency:
                              description: ISO 4217 code
                              type: string
                        filledStake:
                          anyOf:
                            - description: Money amount
                              type: object
                              required:
                                - amount
                                - amountCents
                                - currency
                              properties:
                                amount:
                                  pattern: ^-?\d+\.\d{2}$
                                  description: Decimal string, two decimals
                                  type: string
                                amountCents:
                                  description: >-
                                    The same amount in integer cents: amount
                                    times 100
                                  type: integer
                                currency:
                                  description: ISO 4217 code
                                  type: string
                            - type: 'null'
                        filledPrice:
                          anyOf:
                            - type: string
                            - type: 'null'
                        declineReason:
                          anyOf:
                            - type: string
                            - type: 'null'
                        placedAt:
                          anyOf:
                            - format: date-time
                              type: string
                            - type: 'null'
                        filledAt:
                          anyOf:
                            - format: date-time
                              type: string
                            - type: 'null'
                        settlement:
                          type: object
                          required:
                            - status
                            - amount
                            - settledAt
                          properties:
                            status:
                              type: string
                              enum:
                                - UNSETTLED
                                - WON
                                - LOST
                                - VOID
                                - HALF_WON
                                - HALF_LOST
                                - PUSH
                                - CASHOUT
                            amount:
                              description: Profit or loss of the account on this bet
                              anyOf:
                                - description: Money amount
                                  type: object
                                  required:
                                    - amount
                                    - amountCents
                                    - currency
                                  properties:
                                    amount:
                                      pattern: ^-?\d+\.\d{2}$
                                      description: Decimal string, two decimals
                                      type: string
                                    amountCents:
                                      description: >-
                                        The same amount in integer cents: amount
                                        times 100
                                      type: integer
                                    currency:
                                      description: ISO 4217 code
                                      type: string
                                - type: 'null'
                            settledAt:
                              anyOf:
                                - format: date-time
                                  type: string
                                - type: 'null'
                        cancellation:
                          type: string
                          enum:
                            - cancelled
                            - alreadyTerminal
                            - notRecallable
        '400':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '401':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '403':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '404':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '409':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '429':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '502':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '503':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.