> ## 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 deposit networks

> List reusable-deposit networks with their limits, fees and indicative liquidity.

Returns the supported reusable-deposit networks, each asset's minimum and configured cap, your current commercial rates and indicative Routing liquidity. Read-only and safe to cache for a minute.

| Field | Meaning |
| - | - |
| `live` | Whether the network's deposit-address rail is operational; a particular cross-chain route can still be unavailable. A network with `live: false` cannot issue new addresses, but existing addresses and deposits stay visible and keep reconciling. See `depositAddresses.disabledReason`. |
| `minimumDeposit` | Smallest accepted source amount. Smaller transfers are detected but ignored, and stay on the address. |
| `configuredMaximumDeposit` | Enforced per-deposit cap, or `null` when none is set. Larger confirmed deposits need manual review. |
| `maximumDeposit` | Compatibility field combining the cap with the largest recent quote sampled against reference destinations. A `basis: "liquidity"` value is neither guaranteed capacity nor a limit for this account's preferred destination. |
| `liquidity.available` | Read-only sample of Routing quotes, or `null` when not measured. Check `checkedAt` for freshness; never use it as payment acceptance evidence. |
| `fees` | Your organization's current platform and partner basis-point rates and fee basis. Rates freeze when a deposit is detected; network and Routing costs can still change the settlement amount. |

See [Depositing funds](/payments/depositing-funds).


## OpenAPI

````yaml openapi.json GET /v2/deposit-networks
openapi: 3.1.0
info:
  title: Stableyard Partner API
  version: 2.0.0-staging
  x-stableyard-api-version: '2026-09-09'
  x-stableyard-supported-api-versions:
    - '2026-09-09'
  summary: Backend API for UPAs, Payments, activity, and optional financial products.
  description: >

    Use this API from a trusted partner backend with an app ID and app secret.


    ## Recommended integration


    1. Call `GET /v2/partners/config` to verify credentials and discover enabled
    capabilities.

    2. Create a UPA only when your product needs a persistent Stableyard
    account.

    3. Create a receive or send Payment with `POST /v2/payments`.

    4. Redirect a payer to the returned `paymentUrl` or pass the Payment
    credentials to an official Stableyard interface SDK.

    5. Process signed webhooks and fetch the Payment by ID for reconciliation.


    Checkout execution and account-bound browser endpoints are intentionally
    documented in the separate Interfaces & SDKs reference. Console endpoints
    are dashboard implementation details and are not part of the partner
    integration contract.
  x-stableyard-documentation-surface: partner
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: Accounts
    x-displayName: UPA Accounts
    description: Create Universal Payment Accounts and manage account settings.
  - name: Deposit Addresses
    description: Create reusable receive addresses and verify inbound deposits.
  - 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: Vaults
    description: >-
      Create Safe/Zodiac controlled stablecoin vaults and manage policy updates
      for accounts.
  - name: Payments
    description: >-
      Create escrow-first payments, issue partner-authenticated send
      instructions or executions, power public checkout, and reconcile
      collection through final account settlement.
  - name: Balances & Transactions
    description: >-
      Read Stableyard-posted financial activity. Balances are ledger projections
      of activity Stableyard processed; they are not live balances of externally
      controlled wallets.
paths:
  /v2/deposit-networks:
    get:
      tags:
        - Deposit Addresses
      summary: List deposit networks
      description: >

        Lists supported reusable-deposit networks, each asset's minimum and
        configured cap, current commercial rates, and indicative Routing
        liquidity.


        - `live` reports whether this network's deposit-address rail is
        operational; a particular cross-chain route can still be unavailable.

        - A catalogued network with `live: false` cannot issue a new address.
        Existing addresses and deposits remain visible and continue through
        reconciliation; inspect `depositAddresses.disabledReason`.

        - `minimumDeposit` is the smallest accepted source amount. Smaller
        transfers are detected but ignored and remain on the address.

        - `configuredMaximumDeposit` is the enforced per-deposit cap, or `null`
        when no cap is set. Larger confirmed deposits require manual review.

        - `maximumDeposit` is a compatibility field combining the configured cap
        with the largest recent quote sampled against reference destinations. A
        `basis: "liquidity"` value is neither a guaranteed capacity nor a limit
        for this account's preferred destination.

        - `liquidity.available` is a read-only sample of Routing quotes, or
        `null` when not measured. Check `checkedAt` for freshness; do not use it
        as payment acceptance evidence.

        - `fees` gives the authenticated organization's current platform and
        partner basis-point rates and fee basis. Rates freeze on deposit
        detection. Network and Routing costs can change the eventual settlement
        amount.


        Read-only and safe to cache for a minute.
      operationId: listDepositNetworks
      parameters:
        - name: Stableyard-Version
          in: header
          required: false
          schema:
            type: string
            enum:
              - '2026-09-09'
          description: >-
            Optional contract-version assertion. Omit it to use the app
            environment's pinned version. A different supported version is
            accepted only after that environment is explicitly migrated.
      responses:
        '200':
          description: Deposit networks
          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/DepositNetworksResponse'
              examples:
                example:
                  summary: List deposit networks 200 response
                  value:
                    networks:
                      - code: ethereum
                        aliases:
                          - example
                        chainFamily: evm
                        chainId: 1
                        live: true
                        depositAddresses:
                          operational: true
                          disabledReason: null
                        supportedAssets:
                          - symbol: USDT
                            tokenAddress: '0xdac17f958d2ee523a2206206994597c13d831ec7'
                            decimals: 6
                            kind: token
                            feeModel:
                              version: 3
                              basis: verified_destination_receipt
                            minimumDeposit:
                              amount: '0.5'
                              amountAtomic: '500000'
                              inclusive: true
                            maximumDeposit:
                              amount: '10240'
                              amountAtomic: '10240000000'
                              inclusive: true
                              basis: liquidity
                            configuredMaximumDeposit:
                              amount: '1000'
                              amountAtomic: '1000000000'
                              inclusive: true
                            liquidity:
                              available: null
                              checkedAt: null
                            sourceDeduction:
                              amount: '2'
                              amountAtomic: '2000000'
                              reason: btc_fee_reserve
                            sourceSetupCharge:
                              amount: '2'
                              amountAtomic: '2000000'
                              reason: tron_address_setup
                              frequency: once_per_address
                    fees:
                      version: 3
                      basis: verified_destination_receipt
                      partnerFeeBps: 0
                      platformFeeBps: 0
                      totalFeeBps: 0
                    refreshedAt: '2026-08-28T10:00:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '424':
          $ref: '#/components/responses/FailedDependency'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - partnerBasicAuth: []
components:
  schemas:
    DepositNetworksResponse:
      type: object
      additionalProperties: false
      required:
        - networks
        - fees
        - refreshedAt
      properties:
        networks:
          type: array
          items:
            $ref: '#/components/schemas/DepositNetwork'
        fees:
          type: object
          additionalProperties: false
          required:
            - version
            - basis
            - partnerFeeBps
            - platformFeeBps
            - totalFeeBps
          description: >-
            Current reusable-deposit commercial fee rates for this organization.
            Rates freeze per deposit at detection. The version and basis here
            describe the legacy default; supportedAssets[].feeModel is
            authoritative for newly observed deposits when a chain is explicitly
            enabled for v4.
          properties:
            version:
              type: integer
              enum:
                - 3
            basis:
              type: string
              enum:
                - verified_destination_receipt
            partnerFeeBps:
              type: integer
              minimum: 0
            platformFeeBps:
              type: integer
              minimum: 0
            totalFeeBps:
              type: integer
              minimum: 0
        refreshedAt:
          type: string
          format: date-time
    DepositNetwork:
      type: object
      additionalProperties: false
      required:
        - code
        - aliases
        - chainFamily
        - chainId
        - live
        - depositAddresses
        - supportedAssets
      properties:
        code:
          type: string
          example: ethereum
        aliases:
          type: array
          items:
            type: string
        chainFamily:
          type: string
          enum:
            - evm
            - tron
            - btc
            - solana
            - movement
        chainId:
          type: integer
          example: 1
        live:
          type: boolean
          description: >-
            True when deposit addresses can currently be created and monitored
            on this network. Routing liquidity is reported separately per asset
            and is destination-dependent.
        depositAddresses:
          type: object
          additionalProperties: false
          required:
            - operational
            - disabledReason
          properties:
            operational:
              type: boolean
            disabledReason:
              type:
                - string
                - 'null'
              enum:
                - deposit_addresses_not_supported_on_network
                - deposit_address_issuance_paused
                - deposit_webhook_not_configured
                - deposit_webhook_provider_not_configured
                - null
              example: null
        supportedAssets:
          type: array
          description: >-
            On a v4-configured chain, only explicitly enabled assets are
            offered. An unlisted transfer to an existing address is held for
            intervention, not repriced as v3.
          items:
            $ref: '#/components/schemas/DepositNetworkAsset'
    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: {}
    DepositNetworkAsset:
      type: object
      additionalProperties: false
      required:
        - symbol
        - tokenAddress
        - decimals
        - kind
        - minimumDeposit
        - maximumDeposit
        - configuredMaximumDeposit
        - liquidity
        - feeModel
        - sourceDeduction
        - sourceSetupCharge
      properties:
        symbol:
          type: string
          example: USDT
        tokenAddress:
          type: string
          example: '0xdac17f958d2ee523a2206206994597c13d831ec7'
        decimals:
          type: integer
          minimum: 0
          maximum: 36
          example: 6
        kind:
          type: string
          enum:
            - token
            - native
        feeModel:
          type: object
          additionalProperties: false
          required:
            - version
            - basis
          properties:
            version:
              type: integer
              enum:
                - 3
                - 4
            basis:
              type: string
              enum:
                - verified_destination_receipt
                - source_amount
        minimumDeposit:
          description: >-
            Smallest amount recorded as a deposit on this source asset. A
            specific route or fee combination may require more to settle
            automatically.
          type: object
          additionalProperties: false
          required:
            - amount
            - amountAtomic
            - inclusive
          properties:
            amount:
              type: string
              example: '0.5'
            amountAtomic:
              type: string
              example: '500000'
            inclusive:
              type: boolean
              example: true
        maximumDeposit:
          description: >-
            Null when no cap or sampled Routing quote is known. A
            liquidity-basis value is the highest sampled quotable amount, not a
            guaranteed hard limit. A configured-basis value is an enforced
            per-deposit cap; larger confirmed deposits require manual review.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: false
              required:
                - amount
                - amountAtomic
                - inclusive
                - basis
              properties:
                amount:
                  type: string
                  example: '10240'
                amountAtomic:
                  type: string
                  example: '10240000000'
                inclusive:
                  type: boolean
                  example: true
                basis:
                  type: string
                  enum:
                    - liquidity
                    - configured
        configuredMaximumDeposit:
          description: >-
            The actual enforced per-deposit hard cap, if configured. Null means
            no configured cap, not unlimited Routing liquidity.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: false
              required:
                - amount
                - amountAtomic
                - inclusive
              properties:
                amount:
                  type: string
                  example: '1000'
                amountAtomic:
                  type: string
                  example: '1000000000'
                inclusive:
                  type: boolean
                  example: true
        liquidity:
          type: object
          additionalProperties: false
          required:
            - available
            - checkedAt
          properties:
            available:
              type:
                - boolean
                - 'null'
              description: >-
                True/false from sampled Routing quotes to reference
                destinations; null when not measured. This is not
                account-specific preferred-settlement liquidity.
            checkedAt:
              type:
                - string
                - 'null'
              format: date-time
        sourceDeduction:
          description: >-
            Current per-deposit source-asset deduction before Routing. Null for
            assets with no fixed source deduction. Actual gas and Routing rates
            can vary.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: false
              required:
                - amount
                - amountAtomic
                - reason
              properties:
                amount:
                  type: string
                  example: '2'
                amountAtomic:
                  type: string
                  example: '2000000'
                reason:
                  type: string
                  enum:
                    - btc_fee_reserve
                    - tron_sweep_charge
        sourceSetupCharge:
          description: >-
            A one-time charge on the first eligible Tron USDT deposit for this
            reusable address. A pending or ambiguous first charge holds later
            deposits until verified.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: false
              required:
                - amount
                - amountAtomic
                - reason
                - frequency
              properties:
                amount:
                  type: string
                  example: '2'
                amountAtomic:
                  type: string
                  example: '2000000'
                reason:
                  type: string
                  enum:
                    - tron_address_setup
                frequency:
                  type: string
                  enum:
                    - once_per_address
  responses:
    BadRequest:
      description: Bad request
      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: BadRequest response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    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
    NotFound:
      description: Not found
      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: NotFound response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    Conflict:
      description: Conflict
      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: Conflict response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    FailedDependency:
      description: Required chain, network, or provider configuration is missing
      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: FailedDependency response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
    TooManyRequests:
      description: >-
        Rate limit, payment-option limit, selection cooldown, or temporary abuse
        block
      headers:
        Stableyard-Version:
          description: >-
            Effective date-based Stableyard API contract version for this
            response.
          schema:
            type: string
            enum:
              - '2026-09-09'
        Retry-After:
          description: Seconds until the caller should retry.
          schema:
            type: integer
            minimum: 1
        RateLimit-Limit:
          description: Quota for the most constrained policy.
          schema:
            type: integer
            minimum: 1
        RateLimit-Remaining:
          description: Requests remaining in that policy window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Seconds until that policy window resets.
          schema:
            type: integer
            minimum: 0
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            example:
              summary: TooManyRequests response
              value:
                error:
                  code: bad_request
                  message: The request is invalid
                  details: example
  securitySchemes:
    partnerBasicAuth:
      type: http
      scheme: basic
      description: >-
        HTTP Basic auth. Username is the Stableyard app ID. Password is the app
        secret. The optional Stableyard-Version request header must match the
        environment pin.

````

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