> ## 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.

# Associate a referral code with the authenticated account

> Records attribution for a referral code against the authenticated wallet.
The request body contains only the referral code; wallet and account
identity are resolved from the Bearer session by the platform BFF.

The endpoint is idempotent per wallet: if the wallet already has a
referral attribution, it returns `associated: true` with `already: true`
and does not write a second redemption row.




## OpenAPI

````yaml /_generated/openapi.yaml post /v1/referral/associate
openapi: 3.1.0
info:
  title: Joyride Exchange REST API
  version: 1.0.0
  description: >
    REST API for the Joyride 0DTE Options Exchange.


    ## Authentication


    **Public endpoints** (`/health`, `/v1/market/*`, `/v1/spot/*`,
    `/v1/oracle/*`) require no authentication.


    **Competition prize claims** (`/v1/competition/claim`) are
    self-authenticated

    by a Solana ed25519 signature over the wallet, Discord handle, and payout

    destination in the request body. No JWT is required for that endpoint.


    **Account endpoints** (`/v1/account/*`, `/v1/orders/*`,
    `/v1/social/profile`, `/v1/social/avatar`) require JWT authentication via
    one of:

    1. `Authorization: Bearer <jwt>` header (primary — native clients)

    2. `Cookie: joyride_session=<jwt>` (web clients, set automatically by
    `/v1/auth/verify`)


    **Withdrawal endpoints** (`/withdrawals`, `/v1/withdrawals`) require the

    `Authorization: Bearer <jwt>` header. A session cookie alone is not
    accepted.


    Obtain a JWT by completing the SIWS (Sign In With Solana) flow:

    1. `POST /v1/auth/nonce` with your wallet address to get a nonce

    2. Sign the canonical SIWS message with your wallet

    3. `POST /v1/auth/verify` with wallet, signature, and message to receive a
    JWT


    **Mutating admin endpoints** require a bearer token:

    ```

    Authorization: Bearer <ADMIN_TOKEN>

    ```


    ## Data Conventions


    - **Prices**: Integer values in USDC micros (1 USDC = 1,000,000 micros).
      Example: `1500000` = $1.50
    - **Sizes**: Integer values in millicontracts (1 contract = 1000
    millicontracts).
      Example: `1000` = 1 contract
    - **Balances**: USDC micros. Example: `10_000_000_000` = $10,000

    - **Timestamps**: Unix microseconds (µs since epoch)

    - **Instrument IDs**: Format `{ASSET}_USDC-{DMMMYY}-{STRIKE}-{C|P}`.
      Example: `SOL_USDC-28FEB26-150-C`

    ## Trading


    **Trading is WebSocket-only.** The HTTP API has no order placement
    endpoints.

    See the AsyncAPI spec for WebSocket trading methods.
  contact:
    name: Joyride Engineering
    email: engineering@joyride.exchange
  license:
    name: Proprietary
servers:
  - url: https://joyride.exchange/api
    description: Production
security: []
tags:
  - name: Authentication
    description: |
      SIWS (Sign In With Solana) authentication flow. Obtain a JWT for use
      with all authenticated endpoints. No prior authentication required.
  - name: Health
    description: Service health check.
  - name: Market Data
    description: Publicly accessible market data. No authentication required.
  - name: Account
    description: User-specific account data. Requires user identification.
  - name: Orders
    description: User order history. Requires user identification.
  - name: Withdrawals
    description: Request signed withdrawal authorizations and list withdrawal history.
  - name: Social
    description: Social features — profiles, leaderboard, and activity.
  - name: Referrals
    description: Referral-code validation and attribution surfaces.
  - name: Competition
    description: Competition-specific collection flows.
  - name: Spot
    description: Spot prices and volatility data.
  - name: Oracle
    description: Oracle data — prices, TWAP previews, and settlement timing.
  - name: AI Chat
    description: >
      AI-powered trading assistant. Uses SIWS (Sign In With Solana)
      authentication

      and JWT sessions. Returns responses as Server-Sent Events (SSE).
  - name: Admin
    description: Administrative operations. Requires admin bearer token.
paths:
  /v1/referral/associate:
    post:
      tags:
        - Referrals
      summary: Associate a referral code with the authenticated account
      description: >
        Records attribution for a referral code against the authenticated
        wallet.

        The request body contains only the referral code; wallet and account

        identity are resolved from the Bearer session by the platform BFF.


        The endpoint is idempotent per wallet: if the wallet already has a

        referral attribution, it returns `associated: true` with `already: true`

        and does not write a second redemption row.
      operationId: associateReferralCode
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferralAssociateRequest'
      responses:
        '200':
          description: Referral association recorded or already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralAssociateResponse'
        '401':
          description: Missing or invalid Bearer session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralErrorResponse'
        '409':
          description: Code is missing, inactive, exhausted, or malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralErrorResponse'
              example:
                error: CODE_UNAVAILABLE
        '429':
          description: Per-IP or per-wallet rate limit exceeded
          headers:
            retry-after:
              description: Seconds until the request may be retried.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralErrorResponse'
              example:
                error: RATE_LIMITED
        '503':
          description: Identity verification or referral write temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralErrorResponse'
      security:
        - aiAuth: []
components:
  schemas:
    ReferralAssociateRequest:
      type: object
      properties:
        code:
          type: string
          description: Referral code to associate with the authenticated wallet.
          example: ALICE
      required:
        - code
    ReferralAssociateResponse:
      type: object
      properties:
        associated:
          type: boolean
          description: True when the wallet is associated with a referral code.
          example: true
        code:
          type: string
          description: Normalized referral code recorded for this wallet.
          example: ALICE
        already:
          type: boolean
          description: True when the wallet already had an attribution before this request.
          example: false
      required:
        - associated
        - code
        - already
    ReferralErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable message or machine-readable referral error code.
          example: CODE_UNAVAILABLE
        code:
          type: string
          description: >-
            Optional machine-readable code. Present on auth/upstream failures;
            409 and 429 use `error`.
          example: AUTH_UPSTREAM_ERROR
      required:
        - error
  securitySchemes:
    aiAuth:
      type: http
      scheme: bearer
      description: |
        JWT obtained from POST /v1/auth/verify after SIWS authentication.
        Include as: `Authorization: Bearer <jwt>`

````