# Listar saldos de moneda virtual

> Devuelve el saldo actual de cada moneda virtual para un perfil. Si la aplicación no tiene monedas virtuales, `data` es un array vacío.

## OpenAPI

```yaml
/api-specs/adapty-api.yaml get /api/v2/server-side-api/vc/balances/
openapi: 3.1.0
info:
  title: API del servidor de Adapty
  version: 1.0.0
servers:
  - url: https://api.adapty.io
    description: Servidor de producción
paths:
  /api/v2/server-side-api/vc/balances/:
    get:
      summary: Listar saldos de moneda virtual
      description: |
        Devuelve el saldo actual de cada moneda virtual para un perfil. Si la aplicación no tiene monedas virtuales, `data` es un array vacío.
      operationId: listVirtualCurrencyBalances
      tags:
        - Virtual Currency
      security:
        - apikeyAuth: []
      parameters:
        - name: adapty-customer-user-id
          in: header
          required: false
          schema:
            type: string
          description: El ID único del cliente en tu sistema. Se requiere `adapty-customer-user-id` o `adapty-profile-id`.
        - name: adapty-profile-id
          in: header
          required: false
          schema:
            type: string
          description: El ID único del perfil en tu sistema. Es la mejor opción si trabajas con perfiles anónimos. Se requiere `adapty-customer-user-id` o `adapty-profile-id`.
      responses:
        "200":
          description: Saldos devueltos correctamente
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VirtualCurrencyBalanceListResponse"
              example:
                response_created_at: 1779791400000
                data:
                  - code: COINS
                    name: Gold Coins
                    balance: 12450
                    held: 0
                    available: 12450
                  - code: GEMS
                    name: Gems
                    balance: 3280
                    held: 0
                    available: 3280
                  - code: ENERGY
                    name: Energy
                    balance: 840
                    held: 0
                    available: 840
        "400":
          description: Solicitud incorrecta.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: No autorizado. La clave de API falta o no es válida.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Prohibido. La API de servidor para monedas virtuales no está habilitada para esta aplicación.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Perfil no encontrado.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "500":
          description: Error interno del servidor
components:
  schemas:
    VirtualCurrencyBalanceListResponse:
      type: object
      description: Saldos actuales de todas las monedas virtuales de un perfil.
      properties:
        response_created_at:
          type: integer
          format: int64
          description: Momento en que se generó la respuesta, como marca de tiempo Unix en milisegundos.
        data:
          type: array
          items:
            $ref: "#/components/schemas/VirtualCurrencyProfileBalanceItem"
      required:
        - response_created_at
        - data
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
                nullable: true
                description: Fuente del error
              errors:
                type: array
                items:
                  type: string
                description: Array de mensajes de error
        error_code:
          type: string
          description: Nombre corto del error
        status_code:
          type: integer
          description: Código de estado HTTP
      required:
        - errors
        - error_code
        - status_code
    VirtualCurrencyProfileBalanceItem:
      type: object
      properties:
        code:
          type: string
          description: Código único de moneda virtual dentro de la app. Letras ASCII, dígitos y guion bajo.
        name:
          type: string
          description: Nombre de visualización de la moneda virtual.
        balance:
          type: integer
          format: int32
          minimum: 0
          description: Saldo total, incluidas las cantidades retenidas actualmente.
        held:
          type: integer
          format: int32
          minimum: 0
          description: Suma de todas las retenciones activas (importes reservados). Actualmente siempre es 0.
        available:
          type: integer
          format: int32
          description: Saldo disponible para gastar, calculado como `balance - held`.
      required:
        - code
        - name
        - balance
        - held
        - available
  securitySchemes:
    apikeyAuth:
      type: apiKey
      name: Authorization
      in: header
      default: Api-Key {Your secret API key}
      description: |
        Las solicitudes a la API deben autenticarse con tu clave de API secreta como encabezado **Authorization**
        con el valor `Api-Key {your_secret_api_key}`, por ejemplo,
        `Api-Key secret_live_...`. Encuentra esta clave en el Adapty Dashboard ->
        **App Settings** -> pestaña **General** -> sección **API keys**.
```