> ## 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 Saldo Rekening Bank: Tercatat dan Tersedia

> Endpoint Get Account Balances dari Didit mengembalikan saldo bertipe suatu rekening beserta tanggal referensinya.

Endpoint Get Account Balances dari Didit mengembalikan saldo bertipe dari suatu akun beserta tanggal referensinya.
`type` bernilai `booked`, `available` atau `expected`.
Operasi baca tidak pernah dikenai biaya.


## OpenAPI

````yaml id/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 Verifikasi Identitas. Lakukan autentikasi dengan header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, koneksi, akun, saldo, transaksi, institusi, dan cakupan. Data
      bank tersedia untuk aplikasi sandbox. Panggilan dari aplikasi produksi
      mengembalikan `404` hingga akses live diumumkan. Tidak ada biaya yang
      dikenakan di sandbox. Panggilan yang dibuat dengan kunci API memerlukan
      kunci yang memiliki izin Bank data (`bank-data`): baca untuk operasi baca,
      tulis untuk operasi yang mengubah sesuatu. Pemeriksaan akun adalah
      pengecualian: memerlukan akses tulis ke sesi, atau akses penuh, dan bukan
      izin Bank data. Bank data bukan bagian dari akses penuh: kunci akses penuh
      ditolak, dan panggilan menjawab `403 bank_data_access_denied` hingga Anda
      membuat kunci yang memiliki izin tersebut. Data bank mentah (akun, saldo,
      transaksi, dan umpan perubahan) juga menolak permintaan yang tidak
      menyertakan kunci API.


      Setiap penolakan di bawah `/v3/bank/` kecuali milik pemeriksaan akun
      memiliki badan JSON yang sama (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Jalur yang bukan operasi, ID yang bukan
      UUID, atau sub-resource yang tidak dikenal menjawab `404 not_found` untuk
      semua metode, dan kesalahan tak terduga apa pun menjawab `500
      internal_error` dengan `request_id`. Jika Bank data tidak tersedia, setiap
      operasi menjawab `404` standar platform, sama seperti rute yang tidak
      dikenal.
paths:
  /v3/bank/accounts/{account_id}/balances/:
    get:
      tags:
        - Bank Data
      summary: Mendapatkan saldo akun
      description: >-
        Mengembalikan saldo berdasarkan jenisnya dari sebuah akun beserta
        tanggal referensinya. Saldo diganti pada setiap sinkronisasi.


        Membutuhkan kunci API dengan izin Bank data (`bank-data`): baca untuk
        operasi ini. Kunci dengan akses penuh tidak menyertakan izin ini:
        berikan secara eksplisit saat Anda membuat kunci, jika tidak panggilan
        akan menjawab `403 bank_data_access_denied`. Aplikasi sandbox membaca
        data Test Bank-nya hanya dengan kunci tersebut. Permintaan tanpa kunci
        API (kredensial klien) ditolak untuk data mentah dengan `403` yang sama.
      operationId: getBankAccountBalances
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID rekening.
      responses:
        '200':
          description: Saldo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankBalances'
              examples:
                Booked and available:
                  summary: Saldo yang dibukukan dan saldo yang tersedia
                  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: Sumber daya tidak ada dalam aplikasi dan lingkungan ini.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Tidak ditemukan
                  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: >-
            Orang tersebut tidak lagi membagikan rekening ini
            (`access_removed`), atau koneksi telah dihapus, atau datanya tidak
            lagi dapat dibaca (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Access removed:
                  summary: Akses dihapus
                  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: Saldo akun menurut jenisnya.
      properties:
        account_id:
          type: string
          format: uuid
        balances:
          type: array
          items:
            $ref: '#/components/schemas/BankBalance'
        last_synced_at:
          type: string
          description: Kapan saldo terakhir diambil dari bank.
          format: date-time
          nullable: true
      required:
        - account_id
        - balances
        - last_synced_at
    BankDataError:
      type: object
      description: Isi kesalahan dari setiap operasi Bank data. Setiap kolom selalu ada.
      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: >-
            Kode error yang dapat dibaca mesin. Tentukan percabangan berdasarkan
            kode ini, jangan berdasarkan `message`.
        message:
          type: string
          description: >-
            Penjelasan dalam bahasa sederhana untuk pengembang. Redaksinya dapat
            berubah; jangan diurai.
        request_id:
          type: string
          description: ID permintaan ini. Sertakan ID ini saat menghubungi dukungan.
        field:
          type: string
          description: >-
            Kolom permintaan yang perlu diperbaiki, jika error berkaitan dengan
            satu kolom. Jika tidak, bernilai `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: >-
            Apa langkah berikutnya, agar klien dapat bertindak tanpa menebak.
            `null` jika tidak ada langkah berikutnya yang standar.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Detik untuk menunggu sebelum mencoba lagi. Diisi pada error batas
            laju dan error sementara; jika tidak, `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` atau `expected`. `other` adalah saldo yang
            diberikan bank dalam format yang tidak dipetakan oleh Didit: saldo
            tersebut tetap disajikan, tidak pernah dibuang, dan `iso_type`
            memuat kode mentah dari bank.
        iso_type:
          type: string
          description: >-
            Kode jenis saldo milik bank, sebagaimana dikirim bank (kode ISO
            20022 jika bank memberikannya), atau `null` jika bank tidak
            mengirimkannya.
          nullable: true
        amount:
          type: string
          description: Jumlah sebagai string desimal.
          pattern: ^-?\d+(\.\d+)?$
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Kode mata uang 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: Apakah batas overdraf disertakan, jika bank menyatakannya.
      required:
        - type
        - iso_type
        - amount
        - currency
        - reference_date
        - last_change_at
        - credit_limit_included
    RateLimitBudgetError:
      type: object
      description: >-
        Hanya dikembalikan untuk penolakan anggaran batas laju middleware.
        Kesalahan 429 lainnya, termasuk konflik idempotensi dan batas khusus
        endpoint, tidak menjamin bidang metadata ini.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Pesan penolakan anggaran yang sudah ada dan mudah dibaca manusia.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referensi dukungan (tidak transparan): RL- diikuti 32 karakter
            heksadesimal UUID huruf kecil.
        limit:
          type: integer
          description: >-
            Anggaran untuk cakupan yang terlampaui; sama dengan
            X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Sisa anggaran, dibatasi hingga nol; sama dengan
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: Waktu reset jendela dalam detik Unix; sama dengan X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durasi jendela tetap dalam detik, bukan sisa waktu tunggu. Patuhi
            Retry-After sebelum mencoba lagi.
      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: Tidak diotorisasi
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Kunci API Tidak Valid
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        Kunci API tidak memiliki izin Bank data (`bank-data`), atau, untuk data
        bank mentah di aplikasi live, pengaturan aplikasi "Bank data in the API"
        dinonaktifkan. Data bank bukan bagian dari akses penuh: kunci akses
        penuh, kunci yang dibatasi pada sumber daya lain, dan permintaan yang
        diautentikasi tanpa kunci API (client credentials, untuk data mentah)
        semuanya ditolak dengan isi respons ini, jadi buat kunci dan berikan
        izin secara eksplisit. Penolakan terjadi sebelum pencarian apa pun,
        sehingga tidak memberi tahu apakah objek itu ada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Data bank tidak diizinkan
              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: >-
        Anggaran baca middleware terlampaui. Patuhi Retry-After sebelum mencoba
        lagi.
      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: >-
        Terjadi kesalahan di sisi Didit. Setiap error tak terduga di bawah
        `/v3/bank/` dijawab dalam format error Bank, tidak pernah berupa halaman
        HTML: sebutkan `request_id` saat menghubungi dukungan.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Kesalahan tak terduga
              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: >-
        Detik untuk menunggu, dibulatkan ke atas ke jendela berikutnya. Tersedia
        pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Cakupan yang anggarannya terlampaui. Tersedia pada penolakan anggaran
        middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Anggaran untuk cakupan yang terlampaui; sama dengan batas pada body.
        Hadir pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Sisa anggaran, dibatasi hingga nol; sama dengan remaining pada body. Ada
        pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Waktu reset dalam detik Unix; sama dengan reset di body. Tersedia pada
        penolakan anggaran middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Kunci API aplikasi Anda, dari Developers -> API keys di Business
        Console. Kunci utama memiliki akses penuh. Kunci bernama dapat dibatasi:
        tanpa akses, baca, atau tulis per sumber daya, dibatasi untuk beberapa
        alur kerja atau untuk sesi yang disetujui, ke daftar alamat IP tertentu,
        dan ke tanggal kedaluwarsa. 401 berarti kunci salah, dicabut, atau
        kedaluwarsa; 403 berarti tidak ada kunci yang dikirim, kunci tidak
        memiliki akses ke sumber daya atau tindakan ini, atau permintaan berasal
        dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi
        berada di luar alur kerja atau status yang diizinkan untuk kunci
        tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF
        sebagai null, dan kunci tanpa akses tulis sesi menerima tautan dan token
        sesi sebagai null. Lihat https://docs.didit.me/console/api-keys.

````

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