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

# API para obtener saldos de cuentas bancarias: contable y disponible

> El endpoint Get Account Balances de Didit devuelve los saldos tipados de una cuenta con sus fechas de referencia.

El endpoint Get Account Balances de Didit devuelve los saldos por tipo de una cuenta, con sus fechas de referencia.
`type` es `booked`, `available` o `expected`.
Las lecturas nunca se facturan.


## OpenAPI

````yaml es/openapi-25.json GET /v3/bank/accounts/{account_id}/balances/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, conexiones, cuentas, saldos, transacciones, instituciones y
      cobertura. Los datos bancarios están disponibles para aplicaciones de
      sandbox. Las llamadas de una aplicación de producción responden `404`
      hasta que se anuncie el acceso en producción. En sandbox no se cobra nada.
      Una llamada hecha con una clave de API necesita una clave que tenga el
      permiso de datos bancarios (`bank-data`): lectura para las consultas,
      escritura para las operaciones que cambian algo. La verificación de cuenta
      es la excepción: necesita acceso de escritura a las sesiones, o acceso
      completo, y no el permiso de datos bancarios. Los datos bancarios no
      forman parte del acceso completo: una clave con acceso completo es
      rechazada, y la llamada responde `403 bank_data_access_denied` hasta que
      crees una clave que tenga el permiso. Los datos bancarios sin procesar
      (cuentas, saldos, transacciones y el flujo de cambios) también rechazan
      una solicitud que no incluya una clave de API.


      Cualquier rechazo bajo `/v3/bank/`, salvo el de la verificación de cuenta,
      tiene el mismo cuerpo JSON (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Una ruta que no es una operación, un ID que
      no es un UUID o un subrecurso desconocido responde `404 not_found` para
      todos los métodos, y cualquier error inesperado responde `500
      internal_error` con un `request_id`. Cuando los datos bancarios no están
      disponibles, todas las operaciones responden el `404` estándar de la
      plataforma, igual que lo hace una ruta desconocida.
paths:
  /v3/bank/accounts/{account_id}/balances/:
    get:
      tags:
        - Bank Data
      summary: Obtener saldos de cuentas
      description: >-
        Devuelve los saldos tipados de una cuenta con sus fechas de referencia.
        Los saldos se reemplazan en cada sincronización.


        Necesita una clave de API con el permiso Datos bancarios (`bank-data`):
        lectura para esta operación. Una clave con acceso completo no lo
        incluye: concédelo explícitamente al crear la clave, o la llamada
        responde `403 bank_data_access_denied`. Una aplicación sandbox lee sus
        datos de Test Bank solo con la clave. Una solicitud sin clave de API
        (credenciales de cliente) se rechaza con el mismo `403` en los datos sin
        procesar.
      operationId: getBankAccountBalances
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: El id de la cuenta.
      responses:
        '200':
          description: Los saldos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankBalances'
              examples:
                Booked and available:
                  summary: Saldo contable y disponible
                  value:
                    account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                    balances:
                      - type: booked
                        iso_type: CLBD
                        amount: '18250.34'
                        currency: EUR
                        reference_date: '2026-11-20'
                        last_change_at: '2026-11-20T22:10:00Z'
                        credit_limit_included: false
                      - type: available
                        iso_type: ITAV
                        amount: '17990.34'
                        currency: EUR
                        reference_date: '2026-11-21'
                        last_change_at: '2026-11-21T11:58:00Z'
                        credit_limit_included: false
                    last_synced_at: '2026-11-21T12:04:40Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: El recurso no existe en esta aplicación ni en este entorno.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: No encontrado
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '409':
          description: >-
            La persona ya no comparte esta cuenta (`access_removed`), o la
            conexión se eliminó o sus datos ya no se pueden leer
            (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Access removed:
                  summary: Acceso eliminado
                  value:
                    code: access_removed
                    message: The person no longer shares this account.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/accounts/a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10/balances/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.get_balances(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.bank.getBalances("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.GetBalances(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().getBalances("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->bank->getBalances('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.bank.get_balances("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Bank.GetBalancesAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankBalances:
      type: object
      description: Saldos tipados de una cuenta.
      properties:
        account_id:
          type: string
          format: uuid
        balances:
          type: array
          items:
            $ref: '#/components/schemas/BankBalance'
        last_synced_at:
          type: string
          description: Cuándo se obtuvieron por última vez del banco los saldos.
          format: date-time
          nullable: true
      required:
        - account_id
        - balances
        - last_synced_at
    BankDataError:
      type: object
      description: >-
        Cuerpo de error de cada operación de datos bancarios. Todos los campos
        están siempre presentes.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Código de error legible por máquina. Decide según este valor, nunca
            según `message`.
        message:
          type: string
          description: >-
            Explicación en lenguaje sencillo para un desarrollador. La redacción
            puede cambiar; no la analices.
        request_id:
          type: string
          description: >-
            Identificador de esta solicitud. Cítalo cuando contactes con
            soporte.
        field:
          type: string
          description: >-
            El campo de la solicitud que hay que corregir, cuando el error se
            refiere a un solo campo. En caso contrario, `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            Qué hacer a continuación, para que un cliente pueda actuar sin
            adivinar. `null` cuando no hay un siguiente paso estándar.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos que esperar antes de reintentar. Se establece en errores de
            límite de solicitudes y errores temporales; en otros casos, `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankBalance:
      type: object
      properties:
        type:
          type: string
          enum:
            - booked
            - available
            - expected
            - other
          description: >-
            `booked`, `available` o `expected`. `other` es un saldo que el banco
            registra de una forma que Didit no asigna: se devuelve, nunca se
            descarta, y `iso_type` contiene el código original del banco.
        iso_type:
          type: string
          description: >-
            El código de tipo de saldo propio del banco, tal como lo envió (un
            código ISO 20022 cuando el banco lo proporciona), o `null` si el
            banco no envió ninguno.
          nullable: true
        amount:
          type: string
          description: Importe como cadena decimal.
          pattern: ^-?\d+(\.\d+)?$
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Código de moneda ISO 4217.
        reference_date:
          type: string
          format: date
          nullable: true
        last_change_at:
          type: string
          format: date-time
          nullable: true
        credit_limit_included:
          type: boolean
          nullable: true
          description: Si se incluye un límite de descubierto, cuando el banco lo indica.
      required:
        - type
        - iso_type
        - amount
        - currency
        - reference_date
        - last_change_at
        - credit_limit_included
    RateLimitBudgetError:
      type: object
      description: >-
        Se devuelve solo en un rechazo del middleware por exceder el límite de
        solicitudes. Otros errores 429, incluidos los conflictos de idempotencia
        y los límites específicos de cada endpoint, no garantizan estos campos
        de metadatos.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensaje de rechazo por presupuesto existente y legible para humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referencia de soporte opaca: RL- seguido de 32 caracteres
            hexadecimales en minúscula de un UUID.
        limit:
          type: integer
          description: Presupuesto del ámbito superado; es igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Presupuesto restante, ajustado a cero; es igual a
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reinicio de la ventana en segundos Unix; es igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duración de la ventana fija en segundos, no el tiempo restante de
            espera. Respete Retry-After antes de reintentar.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
  responses:
    Unauthorized:
      description: No autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Clave de API no válida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La clave de API no tiene el permiso de datos bancarios (`bank-data`) o,
        para datos bancarios sin procesar en una aplicación de producción, el
        ajuste de la aplicación "Bank data in the API" está desactivado. Los
        datos bancarios no forman parte del acceso completo: una clave con
        acceso completo, una clave restringida a otros recursos y una solicitud
        autenticada sin clave de API (credenciales de cliente, sobre datos sin
        procesar) se rechazan todas con este cuerpo, así que crea una clave y
        concédela explícitamente. El rechazo se produce antes de cualquier
        búsqueda, por lo que no indica si un objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Datos bancarios no permitidos
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        Se superó el presupuesto de lectura del middleware. Respete el
        encabezado Retry-After antes de reintentar.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Algo ha fallado por parte de Didit. Cualquier error inesperado en
        `/v3/bank/` responde con el formato de error de Bank, nunca con una
        página HTML: incluye `request_id` en tu consulta al soporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Un error inesperado
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos de espera, redondeados al alza hasta la siguiente ventana.
        Presente en los rechazos por cuota del middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        El ámbito cuya cuota se superó. Presente en los rechazos por cuota del
        middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Presupuesto del ámbito superado; es igual al límite del cuerpo. Presente
        en los rechazos por presupuesto del middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Presupuesto restante, ajustado a cero; es igual a remaining del cuerpo.
        Está presente en los rechazos por presupuesto del middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Tiempo de reinicio en segundos Unix; es igual a reset del cuerpo.
        Presente en los rechazos por cuota del middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, desde Developers -> API keys en la
        Business Console. La clave principal tiene acceso completo. Una clave
        con nombre puede tener permisos limitados: ninguno, lectura o escritura
        por recurso, restringida a algunos flujos o solo a sesiones aprobadas, a
        una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, está revocada o ha caducado; 403 significa
        que no se envió ninguna clave, que la clave no tiene acceso a este
        recurso o acción, o que la solicitud procede de una dirección fuera de
        su lista de IP; 404 en una ruta de sesión significa que la sesión está
        fuera de los flujos o estados de la clave. Una clave sin acceso a
        contenido multimedia recibe las URL de imágenes, vídeos y PDF como null,
        y una clave sin permiso de escritura en sesiones recibe los enlaces y
        tokens de sesión como null. Consulta
        https://docs.didit.me/console/api-keys.

````

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