# Cancel a limit order

Asks 1Click to cancel one of the user's limit orders, for a cancel button on your own orders screen; the agent cancels through an approval in chat instead. Returns the order with `cancelRequestedAt` set: what filled stays filled, and cancellation can race a final fill. Read the order for its terminal fill status and `position`: canceled or expired input stops resting, while refund principal and provider payout completion remain separate from net wallet reconciliation. Asking again is safe, and answers the order as it stands.

`POST /v1/users/{userId}/wallet/orders/{orderId}/cancel`

## Authentication

Both headers are required.

- Header: `X-Api-Key: YOUR_API_KEY`
- Header: `Authorization: Bearer YOUR_USER_TOKEN` — A user's session token, from Create a session.

## Path parameters



```json
[
  {
    "schema": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
    },
    "in": "path",
    "name": "userId",
    "required": true,
    "description": "Your id for the user: the `userId` you sent to Create a user. It must be the session's user."
  },
  {
    "schema": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "in": "path",
    "name": "orderId",
    "required": true,
    "description": "The order's `id` (not the provider's `orderId`)."
  }
]
```


## Request example

Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.

```sh
curl --request POST 'https://api.example.test/v1/users/YOUR_USER_ID/wallet/orders/YOUR_ORDER_ID/cancel' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Authorization: Bearer YOUR_USER_TOKEN'
```

## Responses

### 200

The order, with the cancellation requested.



```json
{
  "description": "The order, with the cancellation requested.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/WalletOrder"
      }
    }
  }
}
```


### 400

The request could not be read as this operation expects.

- `invalid_input` — the body or query failed validation; `issues` names each field
- `invalid_cursor` — the `cursor` is not one this list minted



```json
{
  "description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 401

A credential is missing, invalid or expired.

- `partner_key_required` — no `X-Api-Key` header was sent
- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked
- `credential_expired` — the user token has expired; obtain a fresh one



```json
{
  "description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 403

The credentials are valid but may not do this.

- `subject_mismatch` — the `{userId}` in the path is not the token's user
- `account_disabled` — an operator disabled the account
- `origin_rejected` — a browser `Origin` other than the configured web origin
- `permission_required` — the verified credential is not permitted to make this call



```json
{
  "description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin\n- `permission_required` — the verified credential is not permitted to make this call",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 404

The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.



```json
{
  "description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 409

The operation lost to the current state.

- `order_not_cancelable` — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands



```json
{
  "description": "The operation lost to the current state.\n\n- `order_not_cancelable` — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 413

The body exceeds the size this deployment accepts.



```json
{
  "description": "The body exceeds the size this deployment accepts.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 429

A limit refused the request; wait for `Retry-After` when it is sent.

- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`
- `partner_request_capacity` — this partner's request quota across all keys and replicas is spent; honour Retry-After



```json
{
  "description": "A limit refused the request; wait for `Retry-After` when it is sent.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` — this partner's request quota across all keys and replicas is spent; honour Retry-After",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 500

A fault on our side; quote `requestId` when reporting it.

- `internal` — a fault on our side; quote `requestId` when reporting it



```json
{
  "description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


### 503

The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.

- `internal` — a fault on our side; quote `requestId` when reporting it
- `provider_unavailable` — an external provider the call depends on did not answer



```json
{
  "description": "The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it\n- `provider_unavailable` — an external provider the call depends on did not answer",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ProblemDetails"
      }
    }
  }
}
```


## Complete OpenAPI definition

The exact operation and all referenced components, including recursive schemas.



```json
{
  "operation": {
    "operationId": "wallets.cancelOrder",
    "summary": "Cancel a limit order",
    "tags": [
      "wallets"
    ],
    "description": "Asks 1Click to cancel one of the user's limit orders, for a cancel button on your own orders screen; the agent cancels through an approval in chat instead. Returns the order with `cancelRequestedAt` set: what filled stays filled, and cancellation can race a final fill. Read the order for its terminal fill status and `position`: canceled or expired input stops resting, while refund principal and provider payout completion remain separate from net wallet reconciliation. Asking again is safe, and answers the order as it stands.",
    "parameters": [
      {
        "schema": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
        },
        "in": "path",
        "name": "userId",
        "required": true,
        "description": "Your id for the user: the `userId` you sent to Create a user. It must be the session's user."
      },
      {
        "schema": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "in": "path",
        "name": "orderId",
        "required": true,
        "description": "The order's `id` (not the provider's `orderId`)."
      }
    ],
    "security": [
      {
        "apiKey": [],
        "userToken": []
      }
    ],
    "responses": {
      "200": {
        "description": "The order, with the cancellation requested.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/WalletOrder"
            }
          }
        }
      },
      "400": {
        "$ref": "#/components/responses/InvalidInput"
      },
      "401": {
        "$ref": "#/components/responses/Unauthorized"
      },
      "403": {
        "$ref": "#/components/responses/Forbidden"
      },
      "404": {
        "$ref": "#/components/responses/NotFound"
      },
      "409": {
        "description": "The operation lost to the current state.\n\n- `order_not_cancelable` — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "413": {
        "$ref": "#/components/responses/PayloadTooLarge"
      },
      "429": {
        "$ref": "#/components/responses/TooManyRequests"
      },
      "500": {
        "$ref": "#/components/responses/Internal"
      },
      "503": {
        "description": "The service cannot take this right now (draining, a dependency did not answer, or an operator paused the work); `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it\n- `provider_unavailable` — an external provider the call depends on did not answer",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "WalletOrder": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
            "description": "The order's id; the provider's own id is `orderId`."
          },
          "orderId": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              {
                "type": "null"
              }
            ],
            "description": "The provider's order id, or `null` until the provider confirms the order. Treat it as opaque."
          },
          "terms": {
            "type": "object",
            "properties": {
              "input": {
                "type": "object",
                "properties": {
                  "tokenId": {
                    "type": "string",
                    "maxLength": 256,
                    "pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
                    "description": "The exact ledger asset identifier, including its token standard namespace."
                  },
                  "decimals": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 38,
                    "description": "How many decimal places the token's smallest unit represents."
                  }
                },
                "required": [
                  "tokenId",
                  "decimals"
                ],
                "description": "The base asset the order sells, pinned to its token id and decimals."
              },
              "output": {
                "type": "object",
                "properties": {
                  "tokenId": {
                    "type": "string",
                    "maxLength": 256,
                    "pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
                    "description": "The exact ledger asset identifier, including its token standard namespace."
                  },
                  "decimals": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 38,
                    "description": "How many decimal places the token's smallest unit represents."
                  }
                },
                "required": [
                  "tokenId",
                  "decimals"
                ],
                "description": "The quote asset the order buys, pinned to its token id and decimals."
              },
              "quantity": {
                "type": "string",
                "pattern": "^(0|[1-9]\\d{0,38})$",
                "description": "The exact base-asset amount to sell, in the base asset's smallest unit."
              },
              "limitPrice": {
                "type": "string",
                "maxLength": 80,
                "pattern": "^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$",
                "description": "The minimum price a fill must reach: quote-asset units per one base unit, as a plain decimal."
              },
              "deadline": {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                "description": "The absolute instant the resting order expires."
              }
            },
            "required": [
              "input",
              "output",
              "quantity",
              "limitPrice",
              "deadline"
            ],
            "description": "The approved terms the order was placed with; they never change."
          },
          "state": {
            "type": "string",
            "enum": [
              "prepared",
              "creating",
              "created",
              "signing",
              "funded",
              "unconfirmed",
              "abandoned"
            ],
            "description": "Where this order is in our own lifecycle: prepared/creating/created/signing/funded, plus unconfirmed (a lost response, never retried) and abandoned (refused before any signature)."
          },
          "observation": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "orderId": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 128,
                    "description": "The provider's opaque order id."
                  },
                  "input": {
                    "type": "object",
                    "properties": {
                      "tokenId": {
                        "type": "string",
                        "maxLength": 256,
                        "pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
                        "description": "The exact ledger asset identifier, including its token standard namespace."
                      },
                      "decimals": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 38,
                        "description": "How many decimal places the token's smallest unit represents."
                      }
                    },
                    "required": [
                      "tokenId",
                      "decimals"
                    ],
                    "description": "The base asset the order sells."
                  },
                  "output": {
                    "type": "object",
                    "properties": {
                      "tokenId": {
                        "type": "string",
                        "maxLength": 256,
                        "pattern": "^(?:nep141|nep245|1cs_v1):[\\x21-\\x7e]+$",
                        "description": "The exact ledger asset identifier, including its token standard namespace."
                      },
                      "decimals": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 38,
                        "description": "How many decimal places the token's smallest unit represents."
                      }
                    },
                    "required": [
                      "tokenId",
                      "decimals"
                    ],
                    "description": "The quote asset the order buys."
                  },
                  "quantity": {
                    "type": "string",
                    "maxLength": 78,
                    "pattern": "^(0|[1-9][0-9]*)$",
                    "description": "The base-asset quantity the order rests on, in the base asset's smallest unit."
                  },
                  "limitPrice": {
                    "type": "string",
                    "maxLength": 80,
                    "pattern": "^(0|[1-9]\\d{0,38})(\\.\\d{1,38})?$",
                    "description": "The resting limit price: quote-asset units per one base unit."
                  },
                  "deadline": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                    "description": "The absolute instant the order expires at the provider."
                  },
                  "fillStatus": {
                    "type": "string",
                    "enum": [
                      "AWAITING_DEPOSIT",
                      "PENDING_CANCEL",
                      "UNTRIGGERED",
                      "OPEN",
                      "PARTIALLY_FILLED",
                      "FILLED",
                      "CANCELED",
                      "EXPIRED"
                    ],
                    "description": "How much matched. Independent of whether any payout arrived."
                  },
                  "payoutStatus": {
                    "type": "string",
                    "enum": [
                      "NOT_STARTED",
                      "IN_PROGRESS",
                      "COMPLETED",
                      "FAILED"
                    ],
                    "description": "Whether the output side is paying out; `COMPLETED` or `FAILED` is final, in progress is not."
                  },
                  "isPayoutStatusFinal": {
                    "type": "boolean",
                    "description": "Whether the payout axis stopped moving. True covers a failed payout and is not a success flag."
                  },
                  "depositedAmount": {
                    "type": "string",
                    "maxLength": 78,
                    "pattern": "^(0|[1-9][0-9]*)$",
                    "description": "Cumulative funded input in the base asset's smallest unit; zero until funded."
                  },
                  "filledInputRaw": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 78,
                        "pattern": "^(0|[1-9][0-9]*)$"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Successful fills' input total in atomic units, or null when an amount could not be read exactly."
                  },
                  "filledOutputRaw": {
                    "anyOf": [
                      {
                        "type": "string",
                        "maxLength": 78,
                        "pattern": "^(0|[1-9][0-9]*)$"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Successful fills' output total in atomic units, or null when unknown; a full fill with no reported fills stays null."
                  },
                  "cancelable": {
                    "type": "boolean",
                    "description": "Whether the provider may still accept a cancellation right now."
                  },
                  "observedAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                    "description": "When this provider projection was last read."
                  }
                },
                "required": [
                  "orderId",
                  "input",
                  "output",
                  "quantity",
                  "limitPrice",
                  "deadline",
                  "fillStatus",
                  "payoutStatus",
                  "isPayoutStatusFinal",
                  "depositedAmount",
                  "filledInputRaw",
                  "filledOutputRaw",
                  "cancelable",
                  "observedAt"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "What the provider last reported about fills and payouts, or `null` until it has been read."
          },
          "position": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "observedAt": {
                    "type": "string",
                    "format": "date-time",
                    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
                    "description": "Time Fin observed this provider report; not a cash settlement time."
                  },
                  "basis": {
                    "type": "string",
                    "const": "provider_report",
                    "description": "Allocation reported by the bound order provider, not a wallet cash receipt."
                  },
                  "restingInputRaw": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9]\\d{0,38})$"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Input atomic units still resting in the order; null when unknown, zero after matching ends."
                  },
                  "filledInputRaw": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9]\\d{0,38})$"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Cumulative input atomic units in known successful fills; null when incomplete or conflicting."
                  },
                  "filledOutputRaw": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9]\\d{0,38})$"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Cumulative output atomic units from successful fills; does not establish a wallet receipt or current holding."
                  },
                  "refund": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "principalRaw": {
                            "anyOf": [
                              {
                                "type": "string",
                                "pattern": "^(0|[1-9]\\d{0,38})$"
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Unfilled input principal allocated to refund clearing before unknown settlement fees; not spendable cash."
                          },
                          "providerStatus": {
                            "anyOf": [
                              {
                                "type": "string",
                                "enum": [
                                  "NOT_STARTED",
                                  "IN_PROGRESS",
                                  "COMPLETED",
                                  "FAILED"
                                ]
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Refund leg status, or null when no leg was reported; completion does not prove the net amount received."
                          },
                          "txHash": {
                            "anyOf": [
                              {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 256
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "Provider-reported completed refund reference; not proof of an amount received."
                          }
                        },
                        "required": [
                          "principalRaw",
                          "providerStatus",
                          "txHash"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "description": "Refund clearing claim for a terminal order, or null when none is reported."
                  },
                  "withdrawals": {
                    "maxItems": 1001,
                    "type": "array",
                    "items": {
                      "oneOf": [
                        {
                          "type": "object",
                          "properties": {
                            "status": {
                              "type": "string",
                              "const": "IN_PROGRESS",
                              "description": "The provider reports this payout is in progress."
                            }
                          },
                          "required": [
                            "status"
                          ],
                          "additionalProperties": {}
                        },
                        {
                          "type": "object",
                          "properties": {
                            "status": {
                              "type": "string",
                              "const": "COMPLETED",
                              "description": "The provider reports completion; this does not establish the exact net amount received."
                            },
                            "txHash": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 256,
                              "description": "The provider's payout transaction reference, not an amount or a receipt reconciliation."
                            }
                          },
                          "required": [
                            "status",
                            "txHash"
                          ],
                          "additionalProperties": {}
                        },
                        {
                          "type": "object",
                          "properties": {
                            "status": {
                              "type": "string",
                              "const": "FAILED",
                              "description": "The provider reports this payout failed; the funds' disposition remains unresolved."
                            },
                            "reason": {
                              "description": "The provider's reason for the payout failure, when supplied.",
                              "type": "string",
                              "maxLength": 256
                            }
                          },
                          "required": [
                            "status"
                          ],
                          "additionalProperties": {}
                        }
                      ]
                    },
                    "description": "Provider payout references, deduplicated for display; no inferred cash credits."
                  },
                  "reconciliation": {
                    "type": "string",
                    "enum": [
                      "not_required",
                      "unreconciled"
                    ],
                    "description": "Not required only for proven never-funded empty orders; otherwise actual cash settlement remains unreconciled."
                  }
                },
                "required": [
                  "observedAt",
                  "basis",
                  "restingInputRaw",
                  "filledInputRaw",
                  "filledOutputRaw",
                  "refund",
                  "withdrawals",
                  "reconciliation"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "Provider-reported order allocation and payout references, or null before a usable observation. Refund principal is before deductions and is not received wallet cash. Provider completion does not reconcile a payout."
          },
          "fills": {
            "anyOf": [
              {
                "maxItems": 1000,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128,
                      "description": "1Click's id for this fill. Treat it as opaque."
                    },
                    "inputRaw": {
                      "type": "string",
                      "pattern": "^(0|[1-9]\\d{0,38})$",
                      "description": "What this fill sold, in the sold asset's smallest unit, as 1Click reported it."
                    },
                    "outputRaw": {
                      "type": "string",
                      "pattern": "^(0|[1-9]\\d{0,38})$",
                      "description": "What this fill bought, in the bought asset's smallest unit, as 1Click reported it: not proof of what reached the wallet."
                    },
                    "filledAt": {
                      "anyOf": [
                        {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "When 1Click says the fill happened; `null` when it gave no time Fin can read."
                    },
                    "reportedAt": {
                      "anyOf": [
                        {
                          "type": "string",
                          "format": "date-time",
                          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "description": "When Fin first saw this fill in 1Click's report; `null` for a fill Fin saw before it kept this."
                    }
                  },
                  "required": [
                    "id",
                    "inputRaw",
                    "outputRaw",
                    "filledAt",
                    "reportedAt"
                  ]
                }
              },
              {
                "type": "null"
              }
            ],
            "description": "Each fill 1Click reported for this order, oldest first: what it sold and bought, when it happened and when Fin first saw it. A fill's price is `outputRaw` per `inputRaw`, each at its asset's decimals. Empty before anything fills; `null` whenever `position.filledInputRaw` is (no usable report yet, or one whose fills cannot be read exactly)."
          },
          "depositReportedAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ],
            "description": "When Fin first saw 1Click report that the order's funds arrived; `null` until then, and for an order whose funds arrived before Fin kept this."
          },
          "paidOutAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ],
            "description": "When Fin first saw 1Click report the order ended (filled, cancelled or expired) with its payouts complete and final: what filled came back as the bought asset, and what did not fill came back as the sold one. `null` until then."
          },
          "value": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ValueAtTime"
              },
              {
                "type": "null"
              }
            ],
            "description": "What the order sells (`terms.quantity`) was worth when it was placed, at the last market price Fin kept at or before then (the prices portfolio history uses): a five-minute close from the ten minutes before the placement, else an hourly close from the two hours before it. `null` when Fin kept neither."
          },
          "cancelRequestedAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
              },
              {
                "type": "null"
              }
            ],
            "description": "When the user asked to cancel, or `null`. Asking is not proof the provider canceled or refunded."
          },
          "failureReason": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "insufficient_funds",
                  "provider_refused",
                  "verification_failed",
                  "credentials_unavailable",
                  "provider_unavailable",
                  "placement_disabled",
                  "account_busy",
                  "expired"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "When `state` is `abandoned`, why nothing was funded; otherwise `null`. `insufficient_funds`: the wallet did not hold the amount. `provider_refused`: the provider refused the order. `verification_failed`: the order or its funding transfer failed its checks, or would receive less than the minimum the user signed. `credentials_unavailable`: the wallet could not sign or reach the provider. `provider_unavailable`: NEAR Intents did not answer before the order was created, so nothing was placed; placing it again later may work. `placement_disabled`: this deployment does not sign trades. `account_busy`: another funding held the wallet. `expired`: the user's signed request ran out before the order started. Prepare and place a new order to try again."
          },
          "conversationId": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
                "description": "The conversation's id."
              },
              {
                "type": "null"
              }
            ],
            "description": "The conversation in which the agent placed the order; `null` for an order the user placed with Place an order."
          },
          "approvalId": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
                "description": "The approval's id."
              },
              {
                "type": "null"
              }
            ],
            "description": "The approval the user gave for the order in that conversation: open the conversation at its card to show where the order was asked for. `null` for an order the user placed with Place an order."
          },
          "grid": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "gridId": {
                    "type": "string",
                    "format": "uuid",
                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
                    "description": "The grid's `id`: read it with Get a grid."
                  },
                  "cell": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 18,
                    "description": "The grid cell the order was placed for, lowest first."
                  }
                },
                "required": [
                  "gridId",
                  "cell"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "The grid that placed this order and the cell it rests for, or `null` for an order placed on its own."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
            "description": "When the order was placed."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
            "description": "When the order last changed."
          }
        },
        "required": [
          "id",
          "orderId",
          "terms",
          "state",
          "observation",
          "position",
          "fills",
          "depositReportedAt",
          "paidOutAt",
          "value",
          "cancelRequestedAt",
          "failureReason",
          "conversationId",
          "approvalId",
          "grid",
          "createdAt",
          "updatedAt"
        ],
        "description": "A limit order from the agent wallet: the approved terms, whether it is funded, how much has filled, and any cancellation."
      },
      "ValueAtTime": {
        "type": "object",
        "properties": {
          "usd": {
            "type": "string",
            "pattern": "^(0|[1-9]\\d*)(\\.\\d+)?$",
            "description": "The value in US dollars as plain decimal text, rounded down to the cent: the amount times `priceUsd`."
          },
          "priceUsd": {
            "type": "string",
            "maxLength": 80,
            "pattern": "^(0|[1-9]\\d*)(\\.\\d+)?$",
            "description": "The USD price of one whole token it was valued at, as plain decimal text."
          },
          "pricedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
            "description": "When that price was observed."
          }
        },
        "required": [
          "usd",
          "priceUsd",
          "pricedAt"
        ],
        "description": "What an amount was worth in US dollars when it moved, and the price it was valued at. Display only: derived on read, never an input to a transfer or a limit."
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The kind of problem as a URN, `urn:fin:error:<kind>`; stable, compare against it"
          },
          "title": {
            "type": "string",
            "description": "The kind's human title, for logs; never parse it"
          },
          "status": {
            "type": "integer",
            "minimum": 400,
            "maximum": 599,
            "description": "The HTTP status, repeated in the body"
          },
          "reason": {
            "description": "The machine-readable why. One of:\n\n- `run_active` (409) — a run already holds this conversation\n- `budget_exhausted` (429) — the user's AI usage budget, or your partner account's AI spend limit, is used up until the next day or month, or an operator froze it\n- `approval_not_pending` (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation\n- `execution_capacity` (429) — no capacity is free to run this right now; honour `Retry-After`\n- `execution_unavailable` (503) — the service that runs the agent could not take the work; `retryable` says whether to try again\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the automation changed while this request was handled; read it again and retry\n- `automation_held` (409) — an operator holds the automation; it fires again when released\n- `automation_invalid` (409) — the automation's definition cannot run as written\n- `automation_paused` (409) — the automation is paused; resume it first\n- `automation_has_no_webhook` (409) — the automation does not run on incoming events, so it has no webhook\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (400) — `profile.tools` names a tool this deployment does not have\n- `deployment_paused` (503) — an operator paused this kind of work for the deployment; try again later\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the request key already binds different withdrawal terms, or the current balance cannot cover the requested amount\n- `swap_changed` (409) — the swap cannot be made as asked: an asset is no longer available or the current balance cannot cover the amount; get a new quote\n- `order_changed` (409) — the order can no longer be placed as prepared: the agent wallet no longer holds the amount, an asset is no longer offered, or its minimum no longer matches the assets' precision; prepare it again\n- `prediction_order_changed` (409) — the Polymarket order can no longer be placed as signed: the market closed or stopped taking orders, its price is off the market's tick or its size off Polymarket's minimum, its fee or cost would exceed the signed caps, the Polymarket account cannot cover it, or the signature lapsed before it was placed. Nothing was placed; prepare it again\n- `solana_trade_changed` (409) — the Solana trade can no longer run as signed: the token's decimals or program changed, the agent's Solana account or holdings no longer fit it, another Solana trade is running, or the signature lapsed before it started. Nothing moved; prepare it again\n- `trade_not_recoverable` (409) — the original trade or a recovery attempt remains active or uncertain, its unfinished actions lack conclusive recovery proof, or its remaining proposal can no longer be used\n- `order_not_cancelable` (409) — the limit order can no longer be cancelled: it filled or expired, or the swap provider never took it. Read the order for where it stands\n- `grid_not_active` (409) — the grid is not running, so it cannot be paused: it is already paused, stopping or ended. Read the grid for where it stands\n- `grid_not_paused` (409) — the grid is not paused, so there is nothing to resume. Read the grid for where it stands\n- `suggestion_changed` (409) — the suggestion no longer holds: the account or the market moved since fin made it, the user set it aside, or it cannot be made where the user is now. Say it changed, and read the page's suggestions again\n- `request_key_conflict` (409) — the request identity already binds different terms; retrieve the original resource or use a new identity for a new request\n- `question_not_pending` (409) — the questionnaire has already been answered, closed, or is not awaiting this submission\n- `flag_changed` (409) — the flag's targeting changed since you read it; read it again and retry\n- `group_changed` (409) — the group changed or was deleted since you read it; read it again and retry\n- `group_in_use` (409) — a flag's rules still name this group; take it out of those rules first\n- `group_name_taken` (409) — another group already has this name\n- `agent_wallet_required` (409) — create the agent wallet before opening a perps, prediction-market or Solana account\n- `wallet_account_unsupported` (409) — the user's wallet is an Agent API wallet, whose Intents account is a 0x address this route cannot name; read it with Get wallet account, Get wallet account balances and Open a wallet account session instead\n- `conversation_deleted` (410) — the conversation was deleted; its history stays readable\n- `automation_deleted` (410) — the automation was deleted\n- `grid_ended` (410) — the grid stopped, expired or failed; it stays readable but takes no command. A new grid needs the user's approval in chat\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `perps_disabled` (403) — perps is not enabled for this user\n- `prediction_disabled` (403) — prediction-market trading is not enabled for this user\n- `solana_disabled` (403) — Solana trading is not enabled for this user\n- `no_account` (404) — the user has not opened the account this call reads; open it first\n- `not_available_in_region` (403) — perps funding is unavailable in the user's region for this request; withdrawals remain available\n- `steering_disabled` (403) — steering a working run is not turned on for this user; send the message with Start a run once the run ends\n- `baskets_disabled` (403) — idea baskets are not turned on for this user; hide the Ideas pages and their baskets\n- `basket_buying` (409) — the basket is still buying, so it cannot be deleted yet; try again once its result is in\n- `basket_awaiting_approval` (409) — an approval to buy this basket is still open; decline it in the chat, then delete the basket\n- `basket_step_not_failed` (409) — the step bought, or the basket is not partly bought, so no order can be linked to it; read the basket again\n- `basket_step_linked` (409) — another order is already linked to this step; a link is permanent, so read the basket again\n- `basket_order_not_linkable` (400) — the order cannot stand in for this step: it is not one of the step's `failures[].linkable` orders, or another basket step already holds it\n- `voice_disabled` (403) — voice input is not turned on for this user; let them type instead\n- `voice_unavailable` (503) — this deployment has no speech model, so it cannot transcribe recordings; let the user type instead\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `quote_refused` (400) — 1Click would not quote this request, usually an amount below what it routes or a pair it does not offer; nothing was reserved. Change the amount or the assets and quote again; for a deposit address, no address was issued, so offer another network\n- `invalid_input` (400) — the body or query failed validation; `issues` names each field\n- `internal` (500) — a fault on our side; quote `requestId` when reporting it\n- `partner_key_required` (401) — no `X-Api-Key` header was sent\n- `partner_key_invalid` (401) — the `X-Api-Key` is unknown or revoked\n- `subject_mismatch` (403) — the `{userId}` in the path is not the token's user\n- `origin_rejected` (403) — a browser `Origin` other than the configured web origin\n- `permission_required` (403) — the verified credential is not permitted to make this call\n- `signature_required` (403) — creating the agent wallet needs the user's signature: send the user's signature of `creation.message` from Get the agent wallet as `authorization`\n- `asset_not_withdrawable` (403) — tokenized stocks cannot be withdrawn; sell them first\n- `asset_not_swappable` (403) — the swap names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `asset_not_tradable` (403) — the order names an asset this user cannot buy or trade with this request: a tokenized stock with no `context.country`, or one where tokenized stocks are not available, or bought while buying them is not enabled for the user; or a yield vault's share token bought while the user's `earn` flag is off\n- `solana_token_not_tradable` (403) — Fin won't trade this token: its mint lets someone freeze, move or charge for holdings or pause transfers, it can't be sold back, Fin couldn't read its mint, it has no reliable price, or it is wrapped SOL. A sale is refused only for what would stop it landing\n- `limit_orders_disabled` (403) — limit orders are not enabled for this user\n- `grid_trading_disabled` (403) — grid trading is not enabled for this user, so a paused grid cannot be resumed; pausing and cancelling a grid are never gated\n- `deposit_limit_exceeded` (429) — the deposit would take the agent wallet past the user's deposit limit, or, for a deposit address, the wallet has no room left under it; nothing was recorded. Read `depositLimit.availableCents` from Get balances for how much fits now, and deposit no more than that\n- `policy_change_throttled` (429) — the user's Agent API wallet changed what it allows a few minutes ago, and the NEAR Intents Agent API lets it change again only after a cooldown; nothing was asked or signed, so call again once `Retry-After` has passed\n- `agent_slippage_exceeded` (403) — the user's wallet is an Agent API wallet whose agent signs only trades that lose at most the share of their value its owner allowed (`max_slippage_bps`): fees, price and slippage together, by 1Click's own USD values at the quote's minimum output. This trade's quote loses more, states no USD value, or, before there is a quote, its loss bound is already quoted with more slippage than that (half the bound, plus 1Click's fee at the most it has been seen to take, 20 basis points, before an approval). Very small trades lose more to fixed fees; nothing was signed, so ask again with a larger amount or a smaller loss bound\n- `agent_api_orders_unavailable` (403) — the user's Agent API wallet needs wallet setup to enable limit orders, or the order exceeds this wallet's 168-hour maximum; finish wallet setup or choose at most 168 hours before trying again; nothing was approved or signed\n- `destination_not_allowed` (403) — the user's wallet is an Agent API wallet, whose agent pays a deposit only to itself, to a NEAR Intents account its owner listed (on the confidential ledger) or to an address on a chain its owner listed; allow this one with Add a withdrawal destination (one owner signature), then ask again. A public NEAR Intents account, or an address with no valid spelling on its chain, cannot be paid at all; nothing was signed\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` (429) — this partner's request quota across all keys and replicas is spent; honour Retry-After\n- `partner_run_capacity` (429) — this partner's active run quota is full; honour Retry-After and reuse the same request identity\n- `stream_capacity` (429) — the partner, user or replica has no free stream capacity; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted\n- `invalid_question_answer` (400) — the questionnaire answer does not match its questions or allowed choices\n- `question_closed` (410) — the questionnaire expired or was cancelled\n- `unknown_target` (400) — a rule names a partner, group or user that does not exist, or a user outside the partners the same rule names\n- `scope_invalid` (400) — a subject in the scope is not a subject id, or appears twice\n- `subject_unsupported` (404) — a subject in the scope is not one market briefs cover; list them with List market subjects\n- `brief_not_found` (404) — no market brief job with this id was created with your partner key\n- `briefs_busy` (429) — your market briefs are at their limit of briefs generating at once; retry after `Retry-After`\n- `market_briefs_disabled` (403) — market briefs are not turned on for your partner key\n- `story_not_found` (404) — no market story with this id is current: it never was one, or Fin no longer shows it because its sources were withdrawn or its figures can no longer be read",
            "type": "string",
            "enum": [
              "run_active",
              "budget_exhausted",
              "approval_not_pending",
              "execution_capacity",
              "execution_unavailable",
              "stop_pending",
              "automation_changed",
              "automation_held",
              "automation_invalid",
              "automation_paused",
              "automation_has_no_webhook",
              "automation_limit",
              "profile_unknown_tool",
              "deployment_paused",
              "run_not_active",
              "withdrawal_changed",
              "swap_changed",
              "order_changed",
              "prediction_order_changed",
              "solana_trade_changed",
              "trade_not_recoverable",
              "order_not_cancelable",
              "grid_not_active",
              "grid_not_paused",
              "suggestion_changed",
              "request_key_conflict",
              "question_not_pending",
              "flag_changed",
              "group_changed",
              "group_in_use",
              "group_name_taken",
              "agent_wallet_required",
              "wallet_account_unsupported",
              "conversation_deleted",
              "automation_deleted",
              "grid_ended",
              "credential_expired",
              "account_disabled",
              "perps_disabled",
              "prediction_disabled",
              "solana_disabled",
              "no_account",
              "not_available_in_region",
              "steering_disabled",
              "baskets_disabled",
              "basket_buying",
              "basket_awaiting_approval",
              "basket_step_not_failed",
              "basket_step_linked",
              "basket_order_not_linkable",
              "voice_disabled",
              "voice_unavailable",
              "provider_unavailable",
              "quote_refused",
              "invalid_input",
              "internal",
              "partner_key_required",
              "partner_key_invalid",
              "subject_mismatch",
              "origin_rejected",
              "permission_required",
              "signature_required",
              "asset_not_withdrawable",
              "asset_not_swappable",
              "asset_not_tradable",
              "solana_token_not_tradable",
              "limit_orders_disabled",
              "grid_trading_disabled",
              "deposit_limit_exceeded",
              "policy_change_throttled",
              "agent_slippage_exceeded",
              "agent_api_orders_unavailable",
              "destination_not_allowed",
              "rate_limited",
              "partner_request_capacity",
              "partner_run_capacity",
              "stream_capacity",
              "invalid_cursor",
              "invalid_question_answer",
              "question_closed",
              "unknown_target",
              "scope_invalid",
              "subject_unsupported",
              "brief_not_found",
              "briefs_busy",
              "market_briefs_disabled",
              "story_not_found"
            ]
          },
          "requestId": {
            "type": "string",
            "description": "The id Fin used for this request; quote it when reporting a problem"
          },
          "retryable": {
            "type": "boolean",
            "description": "Whether repeating the same request later can succeed without changing it"
          },
          "detail": {
            "description": "Only on `invalid_input`: which part of the request failed validation",
            "type": "string"
          },
          "issues": {
            "description": "Only on `invalid_input`: one entry per failing field",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "The JSON pointer of the failing field; empty for the root object"
                },
                "message": {
                  "type": "string",
                  "description": "Why the field failed"
                }
              },
              "required": [
                "path",
                "message"
              ]
            }
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "requestId",
          "retryable"
        ],
        "description": "RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack."
      }
    },
    "responses": {
      "InvalidInput": {
        "description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "Forbidden": {
        "description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin\n- `permission_required` — the verified credential is not permitted to make this call",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "PayloadTooLarge": {
        "description": "The body exceeds the size this deployment accepts.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "A limit refused the request; wait for `Retry-After` when it is sent.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`\n- `partner_request_capacity` — this partner's request quota across all keys and replicas is spent; honour Retry-After",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      },
      "Internal": {
        "description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key"
      },
      "userToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "fin_session_<opaque>",
        "description": "A user's session token, from Create a session."
      }
    }
  }
}
```

