> ## 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 per obtenir saldos de comptes bancaris: comptable i disponible

> L'endpoint Get Account Balances de Didit retorna els saldos tipificats d'un compte amb les seves dates de referència.

L'endpoint Get Account Balances de Didit retorna els saldos classificats per tipus d'un compte amb les seves dates de referència.
`type` és `booked`, `available` o `expected`.
Les lectures no es facturen mai.


## OpenAPI

````yaml ca/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ó d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, connexions, comptes, saldos, transaccions, entitats i
      cobertura. Les dades bancàries estan disponibles per a aplicacions en
      sandbox. Les crides d'una aplicació en producció responen `404` fins que
      s'anunciï l'accés en producció. No es cobra res en sandbox. Una crida feta
      amb una clau d'API necessita una clau que tingui el permís Bank data
      (`bank-data`): lectura per a les lectures, escriptura per a les operacions
      que canvien alguna cosa. La comprovació de comptes n'és l'excepció:
      necessita accés d'escriptura a sessions, o accés complet, i no el permís
      Bank data. Bank data no forma part de l'accés complet: una clau amb accés
      complet es rebutja, i la crida respon `403 bank_data_access_denied` fins
      que creïs una clau que tingui el permís. Les dades bancàries en brut
      (comptes, saldos, transaccions i el feed de canvis) també rebutgen una
      sol·licitud que no porti cap clau d'API.


      Cada rebuig sota `/v3/bank/` excepte el de la comprovació de comptes té el
      mateix cos JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Un camí que no és una operació, un identificador que no és
      un UUID o un subrecurs desconegut respon `404 not_found` per a qualsevol
      mètode, i qualsevol error inesperat respon `500 internal_error` amb un
      `request_id`. Quan les dades bancàries no estan disponibles, cada operació
      respon el `404` estàndard de la plataforma, exactament com ho fa una ruta
      desconeguda.
paths:
  /v3/bank/accounts/{account_id}/balances/:
    get:
      tags:
        - Bank Data
      summary: Obtén els saldos dels comptes
      description: >-
        Retorna els saldos tipificats d'un compte amb les seves dates de
        referència. Els saldos es reemplacen en cada sincronització.


        Cal una clau d'API amb el permís de dades bancàries (`bank-data`):
        lectura per a aquesta operació. Una clau amb accés complet no l'inclou:
        concedeix-lo explícitament en crear la clau, o la crida respon `403
        bank_data_access_denied`. Una aplicació de sandbox llegeix les dades de
        Test Bank només amb la clau. Una sol·licitud sense clau d'API
        (credencials de client) es rebutja en dades en brut amb el mateix `403`.
      operationId: getBankAccountBalances
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: L'id del compte.
      responses:
        '200':
          description: Els saldos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankBalances'
              examples:
                Booked and available:
                  summary: Saldo comptabilitzat i saldo 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 recurs no existeix en aquesta aplicació ni en aquest entorn.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: No trobat
                  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 ja no comparteix aquest compte (`access_removed`), o la
            connexió s'ha eliminat o les seves dades ja no es poden llegir
            (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Access removed:
                  summary: Accés eliminat
                  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 tipificats d'un compte.
      properties:
        account_id:
          type: string
          format: uuid
        balances:
          type: array
          items:
            $ref: '#/components/schemas/BankBalance'
        last_synced_at:
          type: string
          description: Quan es van obtenir per última vegada del banc els saldos.
          format: date-time
          nullable: true
      required:
        - account_id
        - balances
        - last_synced_at
    BankDataError:
      type: object
      description: >-
        Cos de l'error de cada operació de dades bancàries. Tots els camps hi
        són sempre presents.
      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: >-
            Codi d'error llegible per màquina. Decideix a partir d'aquest codi,
            mai a partir de `message`.
        message:
          type: string
          description: >-
            Explicació en llenguatge senzill per a un desenvolupador. La
            redacció pot canviar; no l'analitzis.
        request_id:
          type: string
          description: >-
            Identificador d'aquesta sol·licitud. Indica'l quan contactis amb el
            suport.
        field:
          type: string
          description: >-
            El camp de la sol·licitud que cal corregir, quan l'error fa
            referència a un sol camp. Altrament, `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è cal fer a continuació, perquè un client pugui actuar sense
            endevinar. `null` quan no hi ha un pas següent estàndard.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segons a esperar abans de reintentar. S'estableix en els errors de
            límit de freqüència i en els errors temporals; en cas contrari,
            `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` és un saldo que el banc
            introdueix d'una manera que Didit no mapeja: es retorna, mai no es
            descarta, i `iso_type` conté el codi original del banc.
        iso_type:
          type: string
          description: >-
            El codi de tipus de saldo propi del banc, tal com l'ha enviat el
            banc (un codi ISO 20022 quan en proporciona un), o `null` quan el
            banc no n'ha enviat cap.
          nullable: true
        amount:
          type: string
          description: Import com a cadena decimal.
          pattern: ^-?\d+(\.\d+)?$
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Codi 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 s'inclou un límit de descobert, segons el que indica el banc.
      required:
        - type
        - iso_type
        - amount
        - currency
        - reference_date
        - last_change_at
        - credit_limit_included
    RateLimitBudgetError:
      type: object
      description: >-
        Només es retorna en un rebuig del pressupost del middleware de límit de
        freqüència. Altres errors 429, inclosos conflictes d'idempotència i
        límits específics de l'endpoint, no garanteixen aquests camps de
        metadades.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: >-
            Missatge de denegació de pressupost existent, comprensible per a
            humans.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referència de suport opaca: RL- seguit de 32 caràcters hexadecimals
            en minúscula d'un UUID.
        limit:
          type: integer
          description: Pressupost de l'àmbit superat; és igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Pressupost restant, amb un mínim de zero; és igual que
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Temps de reinici de la finestra en segons Unix; és igual que
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durada de la finestra fixa en segons, no l'espera restant. Respecta
            Retry-After abans 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 autoritzat
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Clau d'API no vàlida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La clau d'API no té el permís Bank data (`bank-data`) o, per a dades
        bancàries sense processar en una aplicació de producció, la configuració
        de l'aplicació "Bank data in the API" està desactivada. Les dades
        bancàries no formen part de l'accés complet: una clau amb accés complet,
        una clau restringida a altres recursos i una sol·licitud autenticada
        sense clau d'API (credencials de client, sobre dades sense processar)
        són rebutjades amb aquest cos, així que crea una clau i concedeix-lo
        explícitament. El rebuig es produeix abans de cap cerca, de manera que
        no diu res sobre si un objecte existeix.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Dades bancàries no permeses
              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: >-
        S'ha superat el pressupost de lectura del middleware. Respecta
        Retry-After abans 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: >-
        Hi ha hagut un error per part de Didit. Qualsevol error inesperat sota
        `/v3/bank/` respon amb el format d'error de Bank, mai amb una pàgina
        HTML: cita el `request_id` quan contactis amb el servei de suport.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Un error inesperat
              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: >-
        Nombre de segons que cal esperar, arrodonit fins a la finestra següent.
        Present en els rebutjos del pressupost del middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        L'àmbit que ha superat el seu pressupost. Present en els rebutjos del
        pressupost del middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Pressupost de l'àmbit superat; és igual al límit del cos. Hi és present
        en les denegacions de pressupost del middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Pressupost restant, amb un mínim de zero; és igual que remaining del
        cos. Hi és present a les denegacions del pressupost del middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Temps de reinici en segons Unix; és igual que reset del cos. Present en
        els rebutjos del pressupost del middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau principal té accés complet. Una clau amb nom
        es pot limitar: cap, lectura o escriptura per recurs, limitada a alguns
        fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a
        una data de caducitat. 401 vol dir que la clau és incorrecta, revocada o
        caducada; 403 vol dir que no s'ha enviat cap clau, que la clau no té
        accés a aquest recurs o acció, o que la sol·licitud ve d'una adreça fora
        de la seva llista d'adreces IP; 404 en una ruta de sessió vol dir que la
        sessió queda fora dels fluxos de treball o estats de la clau. Una clau
        sense accés a multimèdia rep les URL d'imatges, vídeos i PDF com a null,
        i una clau sense escriptura de sessions rep els enllaços i els tokens de
        sessió com a null. Vegeu https://docs.didit.me/console/api-keys.

````

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