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

# Settlement updates

> Settlement timing updates and per-user settlement results. Requires authentication.



## AsyncAPI

````yaml _generated/asyncapi.yaml settlementChannel
id: settlementChannel
title: Settlement updates
description: >-
  Settlement timing updates and per-user settlement results. Requires
  authentication.
servers:
  - id: production
    protocol: wss
    host: joyride.exchange
    bindings: []
    variables: []
address: settlement
parameters: []
bindings: []
operations:
  - &ref_0
    id: receiveSettlementUpdate
    title: Receive settlement update
    description: Receive settlement timing updates and per-user settlement results.
    type: receive
    messages:
      - &ref_1
        id: SettlementUpdate
        contentType: application/json
        payload:
          - name: Settlement event
            description: >-
              Settlement timing updates or per-user settlement results on the
              `settlement` channel.
            type: object
            properties:
              - name: type
                type: string
                description: object
                required: false
              - name: description
                type: string
                description: Settlement timing or result data
                required: false
        headers: []
        jsonPayloadSchema:
          type: object
          description: Settlement timing or result data
          x-parser-schema-id: <anonymous-schema-234>
        title: Settlement event
        description: >-
          Settlement timing updates or per-user settlement results on the
          `settlement` channel.
        example: |-
          {
            "type": "<string>",
            "description": "<string>"
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: SettlementUpdate
    bindings: []
    extensions:
      - id: x-parser-unique-object-id
        value: settlementChannel
sendOperations:
  - *ref_0
receiveOperations: []
sendMessages:
  - *ref_1
receiveMessages: []
extensions:
  - id: x-parser-unique-object-id
    value: settlementChannel
securitySchemes: []

````