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

# 按用户引用取消

> 按客户端自定义引用取消订单

取消指定赛事中 `userReference` 匹配所提供引用之一的每一笔未成交订单。适用于你用自己的 ID 标记了订单、并希望按这些 ID 取消而不是跟踪 4casters 订单 ID 的情况。

<h2 id="request">
  请求
</h2>

`POST /session/cancelByReference`

<ParamField body="gameID" type="string" required>
  将搜索限定到单场赛事。
</ParamField>

<ParamField body="userReferences" type="array" required>
  `userReference` 字符串数组。`gameID` 中 `userReference` 属于该数组的每一笔未成交订单都会被取消。
</ParamField>

<CodeGroup>
  ```bash curl theme={null}
  curl -X POST https://api.4casters.io/session/cancelByReference \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "gameID": "6924f82640a7e89c3d3acc41",
      "userReferences": ["my-order-1", "my-order-2"]
    }'
  ```
</CodeGroup>

<h2 id="response">
  响应
</h2>

<ResponseField name="data" type="array">
  按单取消结果。形态与 [取消一笔订单](/zh-Hans/pages/rest/orders/cancel-order#response) 相同。
</ResponseField>

<h2 id="errors">
  错误
</h2>

| 状态 | 含义 |
| - | - |
| `400` | `userReferences` 缺失或不是数组。 |


## OpenAPI

````yaml POST /session/cancelByReference
openapi: 3.1.0
info:
  title: 4casters REST API
  version: 1.0.0
  description: >-
    Public REST API for the 4casters peer-to-peer betting exchange. Use this API
    to manage your account, query the orderbook and games, and place / edit /
    cancel orders.


    All responses (unless noted otherwise) are JSON envelopes of the form `{
    "data": ... }`.
  contact:
    name: 4casters
    url: https://4casters.io
servers:
  - url: https://api.4casters.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Login and account session management
  - name: User
    description: Read account info, bets, and orders
  - name: Orders
    description: Place, edit, look up, and cancel orders
  - name: Markets
    description: Browse leagues, games, participants, and orderbooks
  - name: Affiliate
    description: Affiliate / referral commission
paths:
  /session/cancelByReference:
    post:
      tags:
        - Orders
      summary: Cancel orders by user reference
      description: >-
        Cancel every open order in the given game whose `userReference` matches
        one of the supplied references.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - userReferences
                - gameID
              properties:
                userReferences:
                  type: array
                  items:
                    type: string
                gameID:
                  type: string
            example:
              gameID: 6924f82640a7e89c3d3acc41
              userReferences:
                - my-order-1
                - my-order-2
      responses:
        '200':
          description: Per-order cancel results
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CancelResult'
        '400':
          description: '`userReferences` missing or not an array'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CancelResult:
      type: object
      properties:
        success:
          type: boolean
        reason:
          type: string
          description: Failure reason. Present only when `success` is `false`.
        sessionID:
          type: string
          description: Order id.
        description:
          type: string
          description: Human-readable order description (e.g. `Lakers -3.5 -110`).
        odds:
          type: integer
          description: American odds of the cancelled order.
        filled:
          type: number
        offered:
          type: number
        remaining:
          type: number
        gameID:
          type: string
        userReference:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid auth token
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your auth token in the `Authorization` header. The `Bearer` prefix
        is optional; the server also accepts a signed `auth` cookie or a `token`
        field in the request body.

````

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