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

# Aggregated card accounts balance

> Get aggregated card accounts balance for all card accounts.



## OpenAPI

````yaml /issuing/api-reference/openapi.yaml get /cardaccounts/aggregate-balance
openapi: 3.1.0
info:
  title: API Reference
  version: '1.0'
servers:
  - url: https://access.utgl.io/v1
  - url: https://sandbox.access.utgl.io/v1
security:
  - Basic: []
  - Bearer: []
tags:
  - name: Accounts
  - name: Transactions
  - name: Card Accounts
  - name: Card Products
  - name: Cards
  - name: Digital Custody
  - name: Fee
  - name: Payout
paths:
  /cardaccounts/aggregate-balance:
    get:
      tags:
        - Card Accounts
      summary: Aggregated card accounts balance
      description: Get aggregated card accounts balance for all card accounts.
      parameters:
        - name: groupKey
          in: query
          description: >-
            The key specified in card account metadata, which is used to group
            the card accounts by. If not specified, the aggregation includes all
            card accounts.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  cardaccounts:
                    type: array
                    items:
                      type: object
                      properties:
                        group:
                          type: string
                          description: >-
                            The card accounts group, only return when groupKey
                            is specified.
                        currency:
                          type: string
                          description: Currency of the card account to aggregate by
                          enum:
                            - USD
                            - HKD
                        balance:
                          description: >-
                            The aggregated balance reflecting the combined total
                            across all card accounts, expressed in the account's
                            default currency. When the balance is positive, it
                            signifies the amount the cardholder is obligated to
                            pay to the card issuer. Conversely, a negative
                            balance denotes a credit position, suggesting that
                            the card issuer is in debt to the cardholder, a
                            situation that can arise from transactions such as
                            account refunds or instances of the cardholder
                            paying more than the owed amount.
                          type: number
                        value:
                          description: The aggregated balance in USD equivalent
                          type: number
components:
  securitySchemes:
    Basic:
      type: http
      scheme: basic
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````