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

# Get customer balance

> Get the aggregated estimated balance across all customer wallets/assets.



## OpenAPI

````yaml /api-reference/openapi.yaml get /customers/{id}/balance
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.05.28-0001
  description: >-
    Unified API for moving money between crypto and fiat. Three ways to move
    money: Transactions (instant, wallet or card funded, including Cash-In for
    in-person cash deposits), Deposit Addresses (reusable crypto deposit
    configurations), and Virtual Accounts (dedicated bank accounts that
    auto-convert fiat to crypto). Standard transactions follow a two-step flow:
    create a Quote (pricing), then create a Transaction (execution). Cash-in
    codes generate a one-time deposit code for in-person cash deposits at retail
    locations.
  contact:
    name: Polygon OMS
    url: https://oms.polygon.technology
servers:
  - url: https://sandbox-api.polygon.technology/v0.9
    description: Sandbox
  - url: https://api.polygon.technology/v0.9
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication via FrontEgg
  - name: Customers
    description: Customer management and KYC
  - name: Customer
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: Webhook
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: Simulation
paths:
  /customers/{id}/balance:
    get:
      tags:
        - Customer
      summary: Get customer balance
      description: Get the aggregated estimated balance across all customer wallets/assets.
      operationId: getCustomerBalance
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: query
          name: estimatedBalanceCurrencyCode
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerBalanceAggregate'
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidCustomerIdErrorBody'
          description: The server could not understand the request due to invalid syntax.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorBody'
          description: Access is unauthorized.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerNotFoundErrorBody'
          description: The server cannot find the requested resource.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderUserAccountNotFoundErrorBody'
          description: Client error
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderErrorBody'
          description: Server error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderUnreachableErrorBody'
          description: Service unavailable.
components:
  schemas:
    CustomerBalanceAggregate:
      description: >-
        A customer's estimated total balance, aggregated across all of their
        wallets and assets.
      properties:
        data:
          properties:
            customerId:
              description: Public OMS customer ID, format `cst_<typeID>`.
              type: string
            estimatedBalanceCurrencyCode:
              description: Currency code used for `estimatedBalanceValue`.
              type: string
            estimatedBalanceValue:
              allOf:
                - $ref: '#/components/schemas/fixedDecimalString'
              description: >-
                Estimated total balance value across all customer
                wallets/assets, in
                        the currency requested via the `estimatedBalanceCurrencyCode` query
                        param. Defaults to USD when the query param is omitted. Decimal
                        string.
            updatedAt:
              description: >-
                Most recent provider balance timestamp included in the
                aggregate.
                        Omitted when no provider balance timestamps were available to
                        aggregate.
              format: date-time
              type: string
          required:
            - customerId
            - estimatedBalanceValue
            - estimatedBalanceCurrencyCode
          type: object
      required:
        - data
      type: object
    InvalidCustomerIdErrorBody:
      properties:
        error:
          enum:
            - invalid customer id
          type: string
      required:
        - error
      type: object
    UnauthorizedErrorBody:
      properties:
        error:
          enum:
            - unauthorized
          type: string
      required:
        - error
      type: object
    CustomerNotFoundErrorBody:
      properties:
        error:
          enum:
            - customer not found
          type: string
      required:
        - error
      type: object
    ProviderUserAccountNotFoundErrorBody:
      properties:
        code:
          enum:
            - provider_user_account_not_found
          type: string
        error:
          enum:
            - provider account not provisioned for this customer
          type: string
      required:
        - error
        - code
      type: object
    ProviderErrorBody:
      properties:
        code:
          enum:
            - provider_error
          type: string
        error:
          type: string
      required:
        - error
        - code
      type: object
    ProviderUnreachableErrorBody:
      properties:
        code:
          enum:
            - provider_unreachable
          type: string
        error:
          enum:
            - upstream provider unreachable
          type: string
      required:
        - error
        - code
      type: object
    fixedDecimalString:
      description: Wire-safe decimal string that preserves trailing zeros on the wire.
      type: string
      x-go-type: types.FixedDecimalString
      x-go-type-import:
        path: github.com/0xPolygon/bpn-api/types
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````