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

# List the client account's deposits

> List deposit and settlement state for the account fixed by the client token.

Returns deposit and settlement state for the account fixed by the client bearer token. Filter by `status` and page with `limit` (up to 100) and `cursor`.


## OpenAPI

````yaml frontend-openapi.json GET /v2/client/me/deposits
openapi: 3.1.0
info:
  title: Stableyard Interfaces & SDK API
  version: 2.0.0-staging
  x-stableyard-api-version: '2026-09-09'
  x-stableyard-supported-api-versions:
    - '2026-09-09'
  summary: >-
    Advanced browser API used by Stableyard Checkout, Add Money, and
    account-bound interfaces.
  description: >

    These endpoints power Stableyard's official interface SDKs, hosted checkout,
    Add Money, and advanced custom browser integrations.


    Most partners should use `@stableyard/react` or `@stableyard/sdk` instead of
    calling these routes directly. A browser must never receive an app secret.
    Public checkout uses a Payment-scoped client secret, while account-bound
    experiences use a short-lived client bearer token created by the partner
    backend.
  x-stableyard-documentation-surface: frontend
servers:
  - url: https://prod-api.stableyard.fi
    description: Production
  - url: https://staging-api-v2.stableyard.fi
    description: Staging
  - url: http://localhost:3001
    description: Local
security: []
tags:
  - name: Authentication
    x-displayName: API authentication
    description: Verify your app ID and app secret before calling UPA APIs.
  - name: Client API
    description: >-
      Account-bound browser and mobile routes authenticated with a short-lived
      client bearer token. App secrets never enter client code.
  - name: Identity & KYC
    description: >-
      Verify the UPA email and run provider-neutral identity verification.
      Managed vaults and fiat payment rails use this same verified UPA identity.
  - name: Payments
    description: >-
      Create escrow-first payments, issue partner-authenticated send
      instructions or executions, power public checkout, and reconcile
      collection through final account settlement.
paths:
  /v2/client/me/deposits:
    get:
      tags:
        - Client API
      summary: List my deposits
      description: >-
        Lists deposit and settlement state for the account fixed by the client
        bearer token.
      operationId: listClientDeposits
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - detected
              - confirming
              - settling
              - settled
              - reversed
              - failed
              - ignored
              - requires_intervention
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque cursor returned as nextCursor by the previous page.
      responses:
        '200':
          description: Deposits
          headers:
            Stableyard-Version:
              description: >-
                Effective date-based Stableyard API contract version for this
                response.
              schema:
                type: string
                enum:
                  - '2026-09-09'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositsResponse'
              examples:
                example:
                  summary: List my deposits 200 response
                  value:
                    accountId: acct_123
                    deposits:
                      - id: deposit_123
                        accountId: acct_123
                        depositAddressId: deposit_addr_123
                        status: detected
                        amount:
                          asset:
                            chainId: 42161
                            tokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
                            symbol: USDC
                            decimals: 6
                            kind: token
                          amount: '1250000'
                        sourceTransfer:
                          amount:
                            asset:
                              chainId: 42161
                              tokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
                              symbol: USDC
                              decimals: 6
                              kind: token
                            amount: '1250000'
                          txHash: null
                          logIndex: null
                          fromAddress: null
                        fees:
                          partnerAmountAtomic: '1000000'
                          platformAmountAtomic: '1000000'
                          networkAmountAtomic: '1000000'
                          setupAmountAtomic: '1000000'
                          denomination:
                            chainId: 42161
                            tokenAddress: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
                            symbol: USDC
                            decimals: 6
                            kind: token
                          basis: source_amount
                          actualReceivedAmountAtomic: null
                        settlement:
                          status: pending
                          txHash: null
                          settledAt: null
                          reasonCode: Requested by partner
                        settlementProfileSnapshot: {}
                        txHash: 0xabc123...
                    nextCursor: cursor_123
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - clientBearerAuth: []
components:
  schemas:
    DepositsResponse:
      type: object
      required:
        - accountId
        - deposits
      properties:
        accountId:
          type: string
          example: acct_123
        deposits:
          type: array
          items:
            $ref: '#/components/schemas/Deposit'
        nextCursor:
          type: string
          description: Pass this value as cursor to fetch the next page.
    Deposit:
      type: object
      required:
        - id
        - accountId
        - depositAddressId
        - status
        - amount
        - sourceTransfer
        - fees
        - settlement
        - settlementProfileSnapshot
      properties:
        id:
          type: string
          example: deposit_123
        accountId:
          type: string
          example: acct_123
        depositAddressId:
          type: string
          example: deposit_addr_123
        status:
          type: string
          enum:
            - detected
            - confirming
            - settling
            - settled
            - reversed
            - failed
            - ignored
            - requires_intervention
        amount:
          $ref: '#/components/schemas/Money'
        sourceTransfer:
          type: object
          additionalProperties: false
          required:
            - amount
            - txHash
            - logIndex
          properties:
            amount:
              $ref: '#/components/schemas/Money'
            txHash:
              type:
                - string
                - 'null'
            logIndex:
              type:
                - integer
                - 'null'
            fromAddress:
              type:
                - string
                - 'null'
              description: >-
                On-chain sender address that funded this deposit, when captured
                from the source chain.
        fees:
          type: object
          additionalProperties: false
          required:
            - partnerAmountAtomic
            - platformAmountAtomic
            - networkAmountAtomic
            - setupAmountAtomic
            - denomination
            - basis
            - actualReceivedAmountAtomic
          properties:
            partnerAmountAtomic:
              type: string
              pattern: ^[0-9]+$
            platformAmountAtomic:
              type: string
              pattern: ^[0-9]+$
            networkAmountAtomic:
              type: string
              pattern: ^[0-9]+$
            setupAmountAtomic:
              type: string
              pattern: ^[0-9]+$
              description: >-
                Frozen one-time Tron address setup fee for the claim-owning v4
                deposit; zero otherwise.
            denomination:
              $ref: '#/components/schemas/Asset'
            basis:
              type: string
              enum:
                - source_amount
                - verified_destination_receipt
              description: >-
                `source_amount` is returned before final settlement evidence
                exists. `verified_destination_receipt` is returned after v3
                escrow settlement has independently verified the received
                destination amount.
            actualReceivedAmountAtomic:
              type:
                - string
                - 'null'
              pattern: ^[0-9]+$
        netSettlementAmount:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
        settlement:
          type: object
          additionalProperties: false
          required:
            - status
            - txHash
            - settledAt
          properties:
            status:
              type: string
              enum:
                - pending
                - settled
                - failed
                - requires_intervention
            txHash:
              type:
                - string
                - 'null'
            settledAt:
              type:
                - string
                - 'null'
              format: date-time
            reasonCode:
              type: string
              description: >-
                Stable machine-readable reason when settlement requires manual
                review, including verified Routing refund failures such as
                routing_refund_proof_missing, routing_refund_proof_mismatch, or
                routing_refund_retry_exhausted. Raw provider errors are never
                exposed.
        settlementProfileSnapshot:
          type: object
          additionalProperties: true
          description: >-
            Immutable settlement profile snapshot captured when the deposit was
            detected.
        txHash:
          type:
            - string
            - 'null'
          example: 0xabc123...
        observedAt:
          type:
            - string
            - 'null'
          format: date-time
        settledAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
          properties:
            code:
              type: string
              minLength: 1
              maxLength: 128
              example: bad_request
            message:
              type: string
              minLength: 1
              maxLength: 1000
              example: The request is invalid
            details: {}
    Money:
      type: object
      required:
        - asset
        - amount
      properties:
        asset:
          $ref: '#/components/schemas/Asset'
        amount:
          type: string
          description: Atomic units for the token asset.
          example: '1250000'
    Asset:
      type: object
      required:
        - chainId
        - tokenAddress
        - symbol
        - decimals
      properties:
        chainId:
          type: integer
          enum:
            - 42161
            - 1
            - 8453
            - 137
            - 56
            - 43114
            - 4663
            - 4217
            - 10103
            - 10002
            - 728126428
            - 10001
          description: >-
            Supported deposit chain IDs: Arbitrum=42161, Ethereum=1, Base=8453,
            Polygon=137, BNB Smart Chain=56, Avalanche=43114, Robinhood
            Chain=4663, Tempo=4217, Solana=10103, Movement=10002,
            Tron=728126428, Bitcoin=10001.
        tokenAddress:
          type: string
          description: >-
            Contract/mint address for tokens, the EVM zero address for native
            EVM assets, native for BTC, or the Solana System Program address for
            SOL.
          example: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
        symbol:
          type: string
          enum:
            - USDC
            - USDT
            - THBT
            - JPYC
            - USDG
            - BTC
            - ETH
            - POL
            - BNB
            - SOL
        decimals:
          type: integer
          enum:
            - 6
            - 8
            - 9
            - 18
        kind:
          type: string
          enum:
            - token
            - native
          description: >-
            Present on deposit-address supportedAssets entries to distinguish
            contract tokens from native gas assets.
  responses:
    Unauthorized:
      description: Unauthorized
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: Unauthorized response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    Forbidden:
      description: The app secret does not include the required scope
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: Forbidden response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
  securitySchemes:
    clientBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Stableyard client access token
      description: >-
        Short-lived account-bound token returned by POST
        /v2/client/auth/exchange.

````

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