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

# Order Status WebSocket

> Upgrade to a WebSocket for real-time order events. Authenticate with a `connect` message, then `subscribe` by `order_id`. Event pushes use `{"type":"event","data":{"event":"ORDER_*","delivered_at":...,"order":{...}}}`.



## OpenAPI

````yaml https://api.coinvoyage.io/v3/openapi.json get /ws
openapi: 3.1.0
info:
  title: CoinVoyage API (v3)
  description: >-
    CoinVoyage v3 payment API. Unified Intent envelope, snake_case money via the
    Amount shape, and a single SHA-256 signature scheme.
  version: 3.0.0
servers:
  - url: https://api.coinvoyage.io/v3
security: []
paths:
  /ws:
    get:
      tags:
        - websocket
      summary: Order Status WebSocket
      description: >-
        Upgrade to a WebSocket for real-time order events. Authenticate with a
        `connect` message, then `subscribe` by `order_id`. Event pushes use
        `{"type":"event","data":{"event":"ORDER_*","delivered_at":...,"order":{...}}}`.
      operationId: v3OrderStatusWebSocket
      responses:
        '101':
          description: Switching Protocols - WebSocket established
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: WebSocket upgrade failed
components:
  schemas:
    ErrorResponse:
      example:
        code: 400
        error: Bad Request
        message: Invalid request parameters
      properties:
        error:
          example: Bad Request
          type: string
        message:
          example: Invalid request parameters
          type: string
        code:
          example: 400
          format: int64
          type: integer
        details:
          anyOf:
            - type: string
            - type: number
            - type: object
      required:
        - error
        - message
        - code
      type: object

````