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

# Retrieve wallet balance

> Get the latest balance of a user's wallet, including details like the blockchain network and currency.



## OpenAPI

````yaml https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/wallets/balance
openapi: 3.0.0
info:
  title: Hifi API
  version: 2.0.0
  description: API documentation for Hifi
servers:
  - url: https://production.hifibridge.com
    description: Production server
  - url: https://sandbox.hifibridge.com
    description: Sandbox server
security:
  - bearerAuth: []
tags:
  - name: Common
    description: Common endpoints
  - name: User
    description: User endpoints
  - name: Kyc
    description: Kyc endpoints
  - name: Wallet
    description: Wallet endpoints
  - name: Account
    description: Account endpoints
  - name: External Account
    description: External Account endpoints for managing beneficiary bank accounts
  - name: Fiat Account
    description: Fiat Account endpoints
  - name: Virtual Account
    description: Virtual Account endpoints
  - name: Onramp
    description: Onramp endpoints
  - name: Offramp
    description: Offramp endpoints
  - name: Orchestration Address
    description: >-
      Orchestration Address endpoints — persistent on-chain wallets that
      automatically off-ramp incoming stablecoin deposits to a USD bank account
  - name: Crypto Transfer
    description: Crypto Transfer endpoints
  - name: Cross-Chain Bridge
    description: Cross-Chain Bridge endpoints
  - name: Token Swap
    description: Token Swap endpoints
  - name: Canton Offers
    description: Canton Offers endpoints
  - name: Transfer Rules
    description: Transfer approval rules and configuration
  - name: Transfer Approvals
    description: Transfer approval workflow and admin actions
  - name: File
    description: File endpoints
  - name: Reporting
    description: Reporting and metrics endpoints
paths:
  /v2/users/{userId}/wallets/balance:
    get:
      tags:
        - Wallet
      summary: Retrieve wallet balance
      description: >-
        Get the latest balance of a user's wallet, including details like the
        blockchain network and currency.
      parameters:
        - $ref: '#/components/parameters/UserIdPathParameter'
        - $ref: '#/components/parameters/ChainParameter'
        - $ref: '#/components/parameters/CryptoCurrencyParameter'
      responses:
        '200':
          $ref: '#/components/responses/WalletBalanceResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  parameters:
    UserIdPathParameter:
      name: userId
      in: path
      schema:
        type: string
      description: ID of the user
      required: true
    ChainParameter:
      name: chain
      in: query
      schema:
        type: string
        enum:
          - POLYGON
          - ETHEREUM
          - SOLANA
          - BASE
          - TRON
      description: The blockchain network to retrieve the wallet balance from.
      required: true
    CryptoCurrencyParameter:
      name: currency
      in: query
      schema:
        type: string
        enum:
          - usdc
          - usdt
          - usdg
          - pyusd
      description: The type of currency to check the balance for.
      required: true
  responses:
    WalletBalanceResponse:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WalletBalanceObject'
          examples:
            WalletBalanceObjectExample:
              $ref: '#/components/examples/WalletBalanceObjectExample'
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    InternalServerErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
  schemas:
    WalletBalanceObject:
      type: object
      properties:
        balance:
          type: string
          description: >-
            The raw balance of the wallet expressed in the smallest denomination
            of the token. This format is ideal for backend calculations,
            automation processes, or when precise, unrounded figures are
            necessary for smart contract interactions. For example, use this
            when calculating transaction fees or performing token transfer
            operations that require exact values.
        displayBalance:
          type: string
          description: >-
            The wallet balance formatted as a decimal string for display
            purposes, adjusted according to the token's decimal places to
            facilitate human readability. This format is best used in user
            interfaces where balances are displayed to end-users, such as in
            wallet apps or dashboards, where readability and familiarity are
            crucial. For instance, displaying an account balance on a user's
            home screen or summary page.
        tokenInfo:
          type: object
          description: Detailed information about the token.
          properties:
            tokenAddress:
              type: string
              description: >-
                Blockchain generated unique identifier, associated with wallet
                (account), smart contract or other blockchain objects.
            standard:
              type: string
              enum:
                - ERC20
                - ERC721
                - ERC1155
            name:
              type: string
              description: Blockchain name of the specified token.
            symbol:
              type: string
              description: Blockchain symbol of the specified token.
            decimals:
              type: integer
              description: Number of decimal places shown in the token amount.
    Unauthorized:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        error:
          type: string
          description: Error type
        errorDetails:
          type: string
          description: Detailed error message
    InternalServerError:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        error:
          type: string
          description: Error type
        errorDetails:
          type: string
          description: Detailed error message
  examples:
    WalletBalanceObjectExample:
      summary: Wallet Balance Object
      value:
        balance: '0'
        displayBalance: '0'
        tokenInfo:
          tokenAddress: '0x41e94eb019c0762f9bfcf9fb1e58725bfb0e7582'
          standard: ERC20
          name: USDC
          symbol: USDC
          decimals: 6
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````