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

# Filtrelenmiş hesapların bakiye özetini getirir

> Filtreye uyan banka hesaplarının bakiye özetini döndürür; para birimleri ayrı tutulur. Bakiyesi bilinen hesap yoksa (knownAccountCount 0) balance null olur; bilinen bakiyelerin toplamı sıfırsa 0.00 döner. Bakiyesi bilinmeyen hesap sayısı unknownAccountCount ile gösterilir.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/bank-accounts/summary
openapi: 3.0.3
info:
  title: BankaPro API
  version: 1.0.0
  description: >-
    BankaPro'nun sunucudan sunucuya kullanılan, tek firmalı REST API'sidir.
    Kimlik doğrulama HTTP Basic ile yapılır: kullanıcı adı anahtar kimliği,
    parola secret key değeridir. Firma anahtarın kendisinden belirlenir;
    companies, companiesId, companyIds veya scope adlı sorgu parametresi ya da
    başlık kabul edilmez. Tarayıcı kaynaklı (Origin başlığı taşıyan) istekler
    reddedilir. Anahtarın IP kısıtı doluysa istek yalnız listedeki adreslerden
    kabul edilir. Uçlar baAccounts, baTransactions, baOperations veya baSync
    yetkisiyle korunur; karşı taraf IBAN ve TCKN/VKN değerlerini açık görmek
    için baPii ayrıca atanmalıdır. Başarı yanıtı success/data/meta, hata yanıtı
    success:false/error/traceId biçimindedir. Tüm yanıtlarda x-request-id ve
    Cache-Control: no-store bulunur. Zamanlar UTC ISO-8601, parasal değerler iki
    ondalıklı metindir; farklı para birimleri tek toplamda birleştirilmez.
    Bilinmeyen bakiye null, bankanın bildirdiği gerçek sıfır 0.00 olarak döner.
    Bu sözleşme banka hesabı, banka hareketi ve manuel banka sorgusu uçlarını
    kapsar.
servers:
  - url: https://api.banka.pro
    description: BankaPro canlı API
security:
  - BasicAuth: []
tags:
  - name: Accounts
    description: >-
      Credential firmasının banka hesapları, bakiye özetleri ve doğrulanmış
      bakiye geçmişi
  - name: Transactions
    description: Credential firmasının banka hareketleri, özetleri ve izinli operasyonları
  - name: Queries
    description: >-
      Credential firmasının banka hesaplarında mevcut sorgu motoruyla manuel
      yenileme
paths:
  /v1/bank-accounts/summary:
    parameters:
      - $ref: '#/components/parameters/RequestIdInput'
      - $ref: '#/components/parameters/Search'
      - $ref: '#/components/parameters/Currency'
      - $ref: '#/components/parameters/BankCode'
      - $ref: '#/components/parameters/Archived'
      - $ref: '#/components/parameters/IsApi'
    get:
      tags:
        - Accounts
      summary: Filtrelenmiş hesapların bakiye özetini getirir
      description: >-
        Filtreye uyan banka hesaplarının bakiye özetini döndürür; para birimleri
        ayrı tutulur. Bakiyesi bilinen hesap yoksa (knownAccountCount 0) balance
        null olur; bilinen bakiyelerin toplamı sıfırsa 0.00 döner. Bakiyesi
        bilinmeyen hesap sayısı unknownAccountCount ile gösterilir.
      operationId: summarizeBankAccounts
      responses:
        '200':
          description: Para birimi, banka ve firma bazlı hesap özeti
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
            Cache-Control:
              $ref: '#/components/headers/NoStore'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountSummaryResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    RequestIdInput:
      name: x-request-id
      in: header
      required: false
      description: >-
        Opsiyonel izleme kimliği. Değer 1-100 karakter ve yalnız harf, rakam,
        nokta, alt çizgi, iki nokta veya tire içeriyorsa korunur; aksi halde
        sunucu yeni bir UUID üretir.
      schema:
        type: string
        minLength: 1
        maxLength: 100
        pattern: ^[A-Za-z0-9._:-]{1,100}$
      example: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
    Search:
      name: q
      in: query
      required: false
      description: >-
        Büyük/küçük harf ve Türkçe karakter farkına duyarsız arama. Hesaplarda
        ad, banka adı/kodu, hesap kodu ve IBAN aranır. Hareket araması karşı
        taraf adında ve açıklamanın normalize edilmiş kelime belirteçlerinde
        çalışır; baPii varsa ayrıca IBAN ve kimlik numarasında da çalışır. İşlem
        kodu ve alt hesap hareket aramasının kapsamı dışındadır. Açıklama
        belirteçleri en az üç karakterli kelimelerden üretilir; daha kısa
        terimler yalnız karşı taraf adında aranır. IBAN veya kimlik numarası
        niteliğindeki hareket aramaları baPii gerektirir.
      schema:
        type: string
        minLength: 2
        maxLength: 100
      example: müşteri ödemesi
    Currency:
      name: currency
      in: query
      required: false
      description: >-
        Para birimi filtresi. Sabit destek listesi yoktur; tüm üç harfli kodlar
        kabul edilir. TL, ERU ve GPD sırasıyla TRY, EUR ve GBP olarak normalize
        edilir. TRY filtresi eksik, null veya boş saklanmış para birimi
        değerlerini de kapsar.
      schema:
        $ref: '#/components/schemas/CurrencyInput'
    BankCode:
      name: bankCode
      in: query
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 30
        example: '00010'
    Archived:
      name: archived
      in: query
      required: false
      description: Gönderilmezse arşivlenmemiş hesaplar listelenir.
      schema:
        type: boolean
    IsApi:
      name: isApi
      in: query
      required: false
      schema:
        type: boolean
  headers:
    RequestId:
      description: >-
        İsteğin izleme kimliği. İstemcinin gönderdiği değer 1-100 karakter ve
        yalnız harf, rakam, nokta, alt çizgi, iki nokta veya tire içeriyorsa
        korunur; aksi halde sunucu tarafından UUID üretilir.
      schema:
        type: string
        maxLength: 100
        pattern: ^[A-Za-z0-9._:-]{1,100}$
        example: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
    NoStore:
      description: Banka verisinin istemci veya ara katmanda saklanmamasını belirtir.
      schema:
        type: string
        enum:
          - no-store
    WwwAuthenticate:
      description: HTTP Basic kimlik doğrulama challenge değeri.
      schema:
        type: string
        example: Basic realm="BankaPro API", charset="UTF-8"
    RetryAfter:
      description: İsteğin kaç saniye sonra yeniden denenebileceğini belirtir.
      schema:
        type: integer
        minimum: 0
    RateLimit:
      description: >-
        Geçerli oran sınırı ve kalan kota bilgisini standart RateLimit biçiminde
        taşır.
      schema:
        type: string
  schemas:
    AccountSummaryResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - type: object
          required:
            - data
          properties:
            data:
              $ref: '#/components/schemas/AccountSummaryData'
    CurrencyInput:
      type: string
      pattern: ^(?:[A-Za-z]{3}|[Tt][Ll])$
      description: >-
        Sabit bir liste olmadan herhangi bir üç harfli para/kıymet kodu veya TL.
        Girdi büyük harfe çevrilir; TL, ERU ve GPD sırasıyla TRY, EUR ve GBP
        olarak normalize edilir.
      example: TRY
    SuccessBase:
      type: object
      required:
        - success
        - meta
      properties:
        success:
          type: boolean
          enum:
            - true
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    AccountSummaryData:
      type: object
      required:
        - totalAccounts
        - currencies
        - banks
        - companies
        - freshness
      properties:
        totalAccounts:
          type: integer
          minimum: 0
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyAccountSummary'
        banks:
          type: array
          items:
            $ref: '#/components/schemas/AccountBankSummary'
        companies:
          type: array
          items:
            $ref: '#/components/schemas/AccountCompanySummary'
        freshness:
          type: object
          required:
            - latestCheckedAt
            - oldestCheckedAt
          properties:
            latestCheckedAt:
              type: string
              format: date-time
              nullable: true
            oldestCheckedAt:
              type: string
              format: date-time
              nullable: true
    ErrorEnvelope:
      type: object
      required:
        - success
        - error
        - traceId
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              example: VALIDATION_FAILED
            message:
              type: string
              example: İstek doğrulanamadı.
            details:
              type: array
              items:
                $ref: '#/components/schemas/ValidationDetail'
        traceId:
          type: string
          nullable: true
          example: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
    ResponseMeta:
      type: object
      required:
        - requestId
        - timestamp
      properties:
        requestId:
          type: string
          example: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
        timestamp:
          $ref: '#/components/schemas/UtcTimestamp'
        partial:
          type: boolean
          description: Yanıtın kontrollü fallback veya eksik veri içerdiğini belirtir.
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/ApiWarning'
    CurrencyAccountSummary:
      type: object
      required:
        - currency
        - accountCount
        - knownAccountCount
        - unknownAccountCount
        - balance
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        accountCount:
          type: integer
          minimum: 0
        knownAccountCount:
          type: integer
          minimum: 0
        unknownAccountCount:
          type: integer
          minimum: 0
        balance:
          $ref: '#/components/schemas/KnownAggregateMoney'
    AccountBankSummary:
      type: object
      required:
        - bankCode
        - bankName
        - currencies
      properties:
        bankCode:
          type: string
          nullable: true
        bankName:
          type: string
          nullable: true
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyAccountSummary'
    AccountCompanySummary:
      type: object
      required:
        - id
        - title
        - logo
        - currencies
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        title:
          type: string
          nullable: true
        logo:
          type: string
          nullable: true
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyAccountSummary'
      description: >-
        API tek firmalıdır; bu şema yalnız credential firmasının özetini temsil
        eder.
    ValidationDetail:
      type: object
      required:
        - field
        - rule
      properties:
        field:
          type: string
          example: pageSize
        rule:
          type: string
          example: min:1,max:100
    UtcTimestamp:
      type: string
      format: date-time
      description: UTC ISO-8601 zamanı.
      example: '2026-09-08T20:00:00.000Z'
    ApiWarning:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          enum:
            - TODAY_BALANCE_SNAPSHOT_FALLBACK
            - BALANCE_HISTORY_MISSING
            - BALANCE_HISTORY_PARTIAL
            - BALANCE_CURRENCY_MISMATCH
            - BALANCE_VALUE_UNKNOWN
            - BALANCE_VALUE_STALE
            - INVALID_ACCOUNT_CURRENCY
        message:
          type: string
        date:
          type: string
          format: date
          example: '2026-09-07'
        accountCount:
          type: integer
          minimum: 0
    CurrencyCode:
      type: string
      pattern: ^[A-Z]{3}$
      description: >-
        Sabit bir allowlist ile sınırlanmayan, normalize edilmiş üç harfli para
        veya kıymet kodu.
      example: TRY
    KnownAggregateMoney:
      type: string
      pattern: ^-?[0-9]+\.[0-9]{2}$
      nullable: true
      description: >-
        knownAccountCount 0 ise null; en az bir bilinen bakiye varsa gerçek
        toplam iki ondalıklı metindir ve sıfır toplam 0.00 olarak döner.
      example: '0.00'
    ObjectId:
      type: string
      pattern: ^[a-fA-F0-9]{24}$
      example: 64f000000000000000000001
  responses:
    BadRequest:
      description: İstek doğrulama hatası
      headers:
        x-request-id:
          $ref: '#/components/headers/RequestId'
        Cache-Control:
          $ref: '#/components/headers/NoStore'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: VALIDATION_FAILED
              message: pageSize 1-100 araliginda olmalidir.
              details:
                - field: pageSize
                  rule: min:1,max:100
            traceId: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
    Unauthorized:
      description: HTTP Basic credential yok, geçersiz, iptal edilmiş veya süresi geçmiş
      headers:
        x-request-id:
          $ref: '#/components/headers/RequestId'
        Cache-Control:
          $ref: '#/components/headers/NoStore'
        WWW-Authenticate:
          $ref: '#/components/headers/WwwAuthenticate'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        Credential firması banka ürününe uygun değil, zorunlu ürün/endpoint
        yetkisi bulunmuyor veya yapılandırılmış IP allowlist bağlantının
        güvenilir istemci IP'siyle eşleşmiyor
      headers:
        x-request-id:
          $ref: '#/components/headers/RequestId'
        Cache-Control:
          $ref: '#/components/headers/NoStore'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: FORBIDDEN
              message: Bu islem icin yetkiniz bulunmuyor.
              details: []
            traceId: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
    TooManyRequests:
      description: İstek limiti aşıldı
      headers:
        x-request-id:
          $ref: '#/components/headers/RequestId'
        Cache-Control:
          $ref: '#/components/headers/NoStore'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            error:
              code: RATE_LIMITED
              message: Istek limiti asildi. Daha sonra tekrar deneyin.
              details: []
            traceId: 9cc0d3d1-1e63-4c90-b08f-90b6332e70ca
    InternalError:
      description: Beklenmeyen sunucu hatası
      headers:
        x-request-id:
          $ref: '#/components/headers/RequestId'
        Cache-Control:
          $ref: '#/components/headers/NoStore'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Kullanıcı adı anahtar kimliği, parola secret key değeridir. Anahtar
        aktif olmalı, erişim bitiş tarihi geçmemiş olmalı ve BankaPro erişimine
        sahip olmalıdır. Firma anahtardan sunucu tarafında belirlenir;
        istemciden firma kimliği alınmaz. Anahtarın IP kısıtı doluysa istek
        yalnız listedeki adreslerden kabul edilir. Kimlik bilgileri yalnız HTTPS
        üzerinden gönderilmelidir.

````

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