> ## 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 ленты изменений банковских транзакций: добавленные, изменённые, удалённые

> Эндпоинт Didit Sync Transactions возвращает изменения в транзакциях подключения с заданного курсора: добавленные, изменённые и удалённые.

Эндпоинт Sync Transactions в Didit возвращает изменения в транзакциях подключения с момента указанного курсора: `added`, `modified` и `removed`.
Пустой курсор возвращает все транзакции с `reset: true`.
Сохраняйте `next_cursor` только после ответа с `has_more: false`.
См. [Непрерывный банковский фид для бухгалтерии](https://docs.didit.me/ru/use-cases/bank-data-for-accounting.md).


## OpenAPI

````yaml ru/openapi-25.json GET /v3/bank/connections/{id}/transactions/sync/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API верификации личности. Аутентификация через заголовок x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, подключения, счета, балансы, транзакции, учреждения и покрытие.
      Банковские данные доступны для приложений в песочнице. Вызовы из
      приложения в продакшн-среде возвращают `404`, пока доступ к такой среде не
      объявлен. В песочнице ничего не списывается. Вызов, выполненный с
      API-ключом, требует ключа с разрешением на банковские данные
      (`bank-data`): read для чтения, write для операций, которые что-то меняют.
      Проверка счёта является исключением: для неё нужен доступ write к сессиям
      или полный доступ, а не разрешение на банковские данные. Банковские данные
      не входят в полный доступ: ключ с полным доступом отклоняется, и вызов
      возвращает `403 bank_data_access_denied`, пока вы не создадите ключ с этим
      разрешением. Необработанные банковские данные (счета, балансы, транзакции
      и лента изменений) также отклоняют запрос без API-ключа.


      Каждый отказ под `/v3/bank/`, кроме отказа проверки счёта, имеет одно и то
      же тело JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Путь, который не является операцией, идентификатор,
      который не является UUID, или неизвестный подресурс возвращают `404
      not_found` для любого метода, а любая непредвиденная ошибка возвращает
      `500 internal_error` с `request_id`. Там, где банковские данные
      недоступны, каждая операция возвращает стандартный `404` платформы, точно
      так же, как неизвестный маршрут.
paths:
  /v3/bank/connections/{id}/transactions/sync/:
    get:
      tags:
        - Bank Data
      summary: Синхронизация транзакций (лента изменений)
      description: >-
        Возвращает изменения в транзакциях подключения начиная с `cursor`:
        `added`, `modified` и `removed` (с `reason`) по всем его счетам. Пустой
        курсор возвращает все текущие транзакции как `added` и устанавливает
        `reset: true`: замените ими свою копию, а не добавляйте к ней.


        Первое чтение является точным снимком. Первое чтение (без курсора или
        чтение после `reset`) возвращает каждую транзакцию, которая была у
        подключения на момент начала чтения, ровно один раз как `added`, в её
        текущем состоянии, даже если синхронизация выполняется во время
        постраничного получения. Изменения, внесённые во время постраничного
        получения, придут в следующем чтении из `next_cursor`: транзакция,
        которую вы уже получили, придёт снова как `modified`, а новая как
        `added`. Применяйте `modified` как upsert по `id`, а идентификатор из
        `removed`, которого у вас нет, игнорируйте. Все страницы одного чтения
        отражают один и тот же момент времени. Продолжайте получать страницы с
        `page_token`, пока `has_more` равно `true`, и сохраняйте `next_cursor`
        только после ответа с `has_more: false`. Если получение страниц
        прервалось на середине, начните заново с курсора, который вы сохранили.


        Журнал изменений можно воспроизводить повторно в течение 90 дней. Более
        старый курсор возвращает `410 cursor_expired` с `bootstrap: true`:
        начните заново с пустого курсора. Сохранённая история не удаляется, пока
        существует подключение. Проведённая ожидающая транзакция появляется в
        `added`, а ожидающая версия в `removed` с `reason: pending_booked`.
        Webhook `bank.data.updated` сообщает, когда нужно вызвать запрос.


        Требуется API-ключ с разрешением Bank data (`bank-data`): чтение для
        этой операции. Ключ с полным доступом это разрешение не включает:
        выдайте его явно при создании ключа, иначе вызов вернёт `403
        bank_data_access_denied`. Приложение в sandbox читает свои данные Test
        Bank только с ключом. Запрос без API-ключа (client credentials) для
        сырых данных отклоняется с тем же `403`.
      operationId: syncBankTransactions
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Идентификатор подключения.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Сохранённый вами `next_cursor`. Если значение пустое или не
            передано, выборка начинается с начала.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: 'Размер страницы: от 1 до 500. По умолчанию 100.'
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: Продолжает то же чтение, пока `has_more` равно `true`.
      responses:
        '200':
          description: Страница изменений.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankTransactionChanges'
              examples:
                Changes:
                  summary: Ожидающая транзакция проведена, и добавлена новая
                  value:
                    added:
                      - id: 8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-19'
                        value_date: '2026-11-20'
                        transaction_date: null
                        effective_date: '2026-11-19'
                        amount: '-1210.00'
                        currency: EUR
                        direction: debit
                        description: RECIBO SEGURIDAD SOCIAL
                        counterparty:
                          name: ENTIDAD PUBLICA DE EJEMPLO
                          iban: ES0000000000000000005766
                          bic: null
                        remittance:
                          unstructured:
                            - RECIBO SEGURIDAD SOCIAL 10/2026
                          structured: null
                          reference: '0028123456789'
                        bank_transaction_code: PMNT-RDDT-ESDD
                        bank_reference: '2026111900012345'
                        identity_quality: bank_reference
                        end_to_end_id: NOTPROVIDED
                        mandate_id: ES-SS-000123
                        creditor_id: ES00ZZZ00000000
                        merchant_category_code: null
                        exchange: null
                        balance_after: '18250.34'
                        category: taxes_and_social_security
                        first_seen_at: '2026-11-20T06:00:12Z'
                        updated_at: '2026-11-20T06:00:12Z'
                    modified: []
                    removed:
                      - id: e5b1f8a3-0d47-4c92-a6e0-7f3c2d9b1845
                        reason: pending_booked
                    has_more: false
                    next_page_token: null
                    next_cursor: cur_01HZX9K4M2W7B3T8
                    reset: false
                Bootstrap:
                  summary: Чтение с пустого курсора
                  value:
                    added:
                      - id: 8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-19'
                        value_date: '2026-11-20'
                        transaction_date: null
                        effective_date: '2026-11-19'
                        amount: '-1210.00'
                        currency: EUR
                        direction: debit
                        description: RECIBO SEGURIDAD SOCIAL
                        counterparty:
                          name: ENTIDAD PUBLICA DE EJEMPLO
                          iban: ES0000000000000000005766
                          bic: null
                        remittance:
                          unstructured:
                            - RECIBO SEGURIDAD SOCIAL 10/2026
                          structured: null
                          reference: '0028123456789'
                        bank_transaction_code: PMNT-RDDT-ESDD
                        bank_reference: '2026111900012345'
                        identity_quality: bank_reference
                        end_to_end_id: NOTPROVIDED
                        mandate_id: ES-SS-000123
                        creditor_id: ES00ZZZ00000000
                        merchant_category_code: null
                        exchange: null
                        balance_after: '18250.34'
                        category: taxes_and_social_security
                        first_seen_at: '2026-11-20T06:00:12Z'
                        updated_at: '2026-11-20T06:00:12Z'
                      - id: 2c9e7a05-6b14-4d38-8f2a-b3d51e0c9a67
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-18'
                        value_date: '2026-11-18'
                        transaction_date: null
                        effective_date: '2026-11-18'
                        amount: '3450.00'
                        currency: EUR
                        direction: credit
                        description: TRANSFERENCIA FACTURA 2026-0418
                        counterparty:
                          name: CLIENTE DE EJEMPLO SL
                          iban: ES0000000000000000007891
                          bic: null
                        remittance:
                          unstructured:
                            - FRA 2026-0418
                          structured: null
                          reference: null
                        bank_transaction_code: PMNT-RCDT-ESCT
                        bank_reference: '2026111800009876'
                        identity_quality: bank_reference
                        end_to_end_id: 2026-0418
                        mandate_id: null
                        creditor_id: null
                        merchant_category_code: null
                        exchange: null
                        balance_after: '19460.34'
                        category: income
                        first_seen_at: '2026-11-19T06:00:10Z'
                        updated_at: '2026-11-19T06:00:10Z'
                    modified: []
                    removed: []
                    has_more: false
                    next_page_token: null
                    next_cursor: cur_01HZX9K4M2W7B3T8
                    reset: true
          headers:
            Cache-Control:
              description: '`no-store`.'
              schema:
                type: string
        '400':
          description: >-
            Курсор или токен страницы недействителен, либо параметр выходит за
            допустимый диапазон. В `field` указано, какой именно.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Недействительный курсор
                  value:
                    code: invalid_cursor
                    message: The cursor or page token is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: null
                    retry_after: null
                Token for another read:
                  summary: Токен для следующего чтения
                  value:
                    code: page_token_mismatch
                    message: >-
                      The page token belongs to a different read. Restart with
                      the same filters.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Недопустимый запрос
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: limit
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: Ресурс не существует в этом приложении и среде.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Не найдено
                  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: >-
            У подключения нет доступных данных: оно удалено или срок его
            хранения истёк (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Не активно
                  value:
                    code: connection_not_active
                    message: This connection is not active.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: create_link
                    retry_after: null
        '410':
          description: >-
            Курсор старше 90 дней, в течение которых хранится журнал изменений,
            или срок действия токена страницы истёк. Для `cursor_expired` тело
            ответа содержит `bootstrap: true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataCursorError'
              examples:
                Cursor expired:
                  summary: Начните заново с пустого курсора
                  value:
                    code: cursor_expired
                    message: >-
                      The cursor is older than the change log. Read again from
                      an empty cursor.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: restart_from_cursor
                    retry_after: null
                    bootstrap: true
                Page expired:
                  summary: Начать чтение заново с последнего сохранённого курсора
                  value:
                    code: page_expired
                    message: The page token expired. Restart the read.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: restart_read
                    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/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/transactions/sync/?cursor=cur_01HZX9K4M2W7B3T8'
            \
              -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.sync_transactions(
                "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.syncTransactions("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.SyncTransactions(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankSyncTransactionsParams{})\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().syncTransactions("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->syncTransactions('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.sync_transactions("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.SyncTransactionsAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankTransactionChanges:
      type: object
      description: >-
        Изменения транзакций подключения начиная с курсора. Пустой курсор
        возвращает все текущие транзакции как `added`. Все страницы одного
        чтения отражают один и тот же снимок; изменения, поступившие в это
        время, попадут в следующее чтение.
      properties:
        added:
          type: array
          items:
            $ref: '#/components/schemas/BankTransaction'
          description: >-
            Транзакции для добавления. При первом чтении (без курсора или после
            `reset`) здесь находится каждая транзакция, которая была у
            подключения на момент начала чтения, каждая ровно один раз и в её
            текущем состоянии, даже если синхронизация выполняется во время
            постраничного чтения. В последующих чтениях здесь находятся
            транзакции, появившиеся после вашего курсора, и проведённая
            транзакция, которая заменяет ожидающую.
        modified:
          type: array
          items:
            $ref: '#/components/schemas/BankTransaction'
          description: >-
            Транзакции, которые изменились после вашего курсора, в их текущем
            состоянии. Применяйте каждую как обновление или добавление по `id`:
            транзакция, которую вы уже получили при постраничном чтении первого
            запроса, придёт снова, если она изменилась в это время, и сюда же
            придёт исправление от банка.
        removed:
          type: array
          items:
            $ref: '#/components/schemas/BankRemovedTransaction'
          description: >-
            Транзакции, которых больше не существует, с полем `reason`.
            Игнорируйте `id`, которого у вас нет: транзакция, удалённая во время
            постраничного чтения при первом запросе, один раз была доставлена
            как `added` и придёт в следующем чтении.
        has_more:
          type: boolean
          description: >-
            `true`, пока есть следующие страницы. Сохраняйте `next_cursor`
            только после ответа с `has_more: false`; если пагинация прервалась
            на середине, начните заново с сохраненного курсора.
        next_page_token:
          type: string
          description: Продолжает это чтение, пока `has_more` равно `true`.
          nullable: true
        next_cursor:
          type: string
          description: >-
            Долговременная контрольная точка ленты, возвращается только на
            последней странице. Непрозрачна и привязана к приложению, среде и
            подключению. Может воспроизводиться в течение 90 дней. При первом
            чтении отмечает момент начала чтения, поэтому изменения,
            произошедшие за это время, придут в следующем чтении.
          nullable: true
        reset:
          type: boolean
          description: >-
            `true` при каждой первичной загрузке, то есть при каждом чтении с
            пустого курсора: замените свою копию результатом, а не добавляйте к
            ней.
      required:
        - added
        - modified
        - removed
        - has_more
        - next_page_token
        - next_cursor
        - reset
    BankDataError:
      type: object
      description: >-
        Тело ошибки для каждой операции с банковскими данными. Все поля всегда
        присутствуют.
      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: >-
            Машиночитаемый код ошибки. Ориентируйтесь на него в логике
            обработки, но никогда не на `message`.
        message:
          type: string
          description: >-
            Пояснение простым языком для разработчика. Формулировка может
            измениться; не разбирайте её программно.
        request_id:
          type: string
          description: Идентификатор этого запроса. Укажите его при обращении в поддержку.
        field:
          type: string
          description: >-
            Поле запроса, которое нужно исправить, если ошибка относится к
            одному полю. В остальных случаях `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: >-
            Какие действия выполнить дальше, чтобы клиент мог действовать без
            догадок. `null`, если стандартного следующего шага нет.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Количество секунд ожидания перед повторной попыткой. Задаётся при
            ошибках превышения лимита и при временных ошибках, иначе `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
    BankDataCursorError:
      allOf:
        - $ref: '#/components/schemas/BankDataError'
        - type: object
          properties:
            bootstrap:
              type: boolean
              description: >-
                Присутствует при `cursor_expired`, всегда `true`: начните заново
                с пустого `cursor` и замените вашу сохранённую копию
                результатом.
      description: >-
        Тело ответа `410` ленты изменений. При `cursor_expired` оно содержит
        `bootstrap: true`: прочитайте ленту заново с пустого курсора и замените
        свою копию транзакций подключения этим результатом, а не добавляйте к
        ней. При `page_expired` поля `bootstrap` нет: начните заново с
        последнего сохранённого курсора.
    BankTransaction:
      type: object
      description: >-
        Одно движение по счету. Любое поле, которое банк не передает, равно
        `null`; возможности банка показывают, какие поля, как известно, он
        передает.
      properties:
        id:
          type: string
          description: >-
            Идентификатор Didit, непрозрачный, сохраняется при первом
            обнаружении. Одна и та же операция сохраняет идентификатор при
            чтении, синхронизации и продлении. `identity_quality` показывает,
            насколько надёжна эта гарантия.
          format: uuid
        account_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - booked
            - pending
          description: >-
            У ожидающей транзакции есть собственный идентификатор. Когда банк
            проводит её, проведённая транзакция содержит `pending_id`, если банк
            связывает их, а ожидающая появляется в `removed` с `reason:
            pending_booked`.
        pending_id:
          type: string
          description: >-
            Ожидающая транзакция, которую заменила эта. Заполняется, только если
            банк связывает транзакции, и никогда не угадывается.
          format: uuid
          nullable: true
        reverses_id:
          type: string
          description: >-
            Транзакция, которую сторнирует данная, если банк их связывает.
            Сторнирующая транзакция является новой транзакцией.
          format: uuid
          nullable: true
        booking_date:
          type: string
          format: date
          nullable: true
        value_date:
          type: string
          format: date
          nullable: true
        transaction_date:
          type: string
          format: date
          nullable: true
        effective_date:
          type: string
          description: >-
            Дата, которую используют фильтры по датам, в том виде, в каком её
            передаёт банк, в его часовом поясе, без конвертации: для проведённой
            транзакции это дата проводки, иначе дата валютирования, иначе дата,
            когда транзакция впервые появилась; для ожидающей транзакции это
            дата транзакции, иначе дата, когда транзакция впервые появилась.
          format: date
        amount:
          type: string
          description: >-
            Сумма со знаком в виде десятичной строки. Отрицательное значение
            означает расход средств.
          pattern: ^-?\d+(\.\d+)?$
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Код валюты по ISO 4217.
        direction:
          type: string
          enum:
            - credit
            - debit
          description: Повторяет знак `amount`.
        description:
          type: string
          nullable: true
        counterparty:
          $ref: '#/components/schemas/BankTransactionCounterparty'
        remittance:
          $ref: '#/components/schemas/BankTransactionRemittance'
        bank_transaction_code:
          type: string
          nullable: true
        bank_reference:
          type: string
          description: >-
            Неизменяемый идентификатор записи в банке, если банк его передаёт.
            Иначе `null`; значение никогда не придумывается.
          nullable: true
        identity_quality:
          type: string
          enum:
            - bank_reference
            - route_id
            - derived
          description: >-
            Способ сопоставления `id`. `bank_reference` и `route_id` стабильны.
            `derived` сопоставляется по содержимому: он стабилен, пока банк
            сообщает о записи без изменений, а исправление со стороны банка
            может проявиться как одна `removed` и одна `added`.
        end_to_end_id:
          type: string
          nullable: true
        mandate_id:
          type: string
          nullable: true
        creditor_id:
          type: string
          nullable: true
        merchant_category_code:
          type: string
          nullable: true
        exchange:
          type: object
          nullable: true
          description: Детали обмена валюты, если банк их предоставляет.
          properties:
            source_amount:
              type: string
              pattern: ^-?\d+(\.\d+)?$
              nullable: true
            source_currency:
              type: string
              nullable: true
            rate:
              type: string
              pattern: ^-?\d+(\.\d+)?$
              nullable: true
        balance_after:
          type: string
          description: Баланс после транзакции, если банк его передаёт.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        category:
          type: string
          description: Собственная категория Didit, если она применима.
          nullable: true
        first_seen_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - account_id
        - status
        - pending_id
        - reverses_id
        - booking_date
        - value_date
        - transaction_date
        - effective_date
        - amount
        - currency
        - direction
        - description
        - counterparty
        - remittance
        - bank_transaction_code
        - bank_reference
        - identity_quality
        - end_to_end_id
        - mandate_id
        - creditor_id
        - merchant_category_code
        - exchange
        - balance_after
        - category
        - first_seen_at
        - updated_at
    BankRemovedTransaction:
      type: object
      properties:
        id:
          type: string
          description: Идентификатор транзакции, которая больше не актуальна.
          format: uuid
        reason:
          type: string
          enum:
            - pending_booked
            - pending_expired
            - bank_removed
            - access_removed
          description: >-
            `pending_booked`: банк провел транзакцию, и проведенная транзакция
            находится в `added`. `pending_expired`: ожидающая транзакция,
            которую банк перестал передавать. `bank_removed`: банк удалил ее.
            `access_removed`: счет был исключен из согласия.
      required:
        - id
        - reason
    RateLimitBudgetError:
      type: object
      description: >-
        Возвращается только при отказе middleware из-за исчерпания бюджета
        лимита запросов. Другие ошибки 429, включая конфликты идемпотентности и
        ограничения конкретного endpoint, не гарантируют эти поля метаданных.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Существующее понятное человеку сообщение об отказе по бюджету.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Непрозрачный идентификатор для службы поддержки: RL- и затем 32
            шестнадцатеричных символа UUID в нижнем регистре.
        limit:
          type: integer
          description: Бюджет области, в которой превышен лимит; равен X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Оставшийся бюджет, приведённый к нулю; совпадает с
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: Время сброса окна в секундах Unix; равно X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Длительность фиксированного окна в секундах, а не оставшееся время
            ожидания. Учитывайте Retry-After перед повторной попыткой.
      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
    BankTransactionCounterparty:
      type: object
      properties:
        name:
          type: string
          nullable: true
        iban:
          type: string
          nullable: true
        bic:
          type: string
          nullable: true
      required:
        - name
        - iban
        - bic
    BankTransactionRemittance:
      type: object
      properties:
        unstructured:
          type: array
          items:
            type: string
        structured:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
      required:
        - unstructured
        - structured
        - reference
  responses:
    Unauthorized:
      description: Не авторизован
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Недействительный API-ключ
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        API-ключ не имеет разрешения на доступ к банковским данным (`bank-data`)
        или, для необработанных банковских данных в продакшн-приложении,
        отключена настройка приложения «Bank data in the API». Банковские данные
        не входят в полный доступ: ключ с полным доступом, ключ с ограничением
        на другие ресурсы и запрос без API-ключа (client credentials, для
        необработанных данных) отклоняются с этим ответом, поэтому создайте ключ
        и выдайте разрешение явно. Отказ происходит до любого поиска, поэтому он
        ничего не говорит о том, существует ли объект.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Доступ к банковским данным не разрешён
              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: >-
        Превышен лимит чтения middleware. Соблюдайте Retry-After перед повторной
        попыткой.
      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: >-
        Что-то пошло не так на стороне Didit. Любая непредвиденная ошибка в
        `/v3/bank/` возвращается в формате ошибки Bank, а не в виде
        HTML-страницы: укажите `request_id` в обращении в поддержку.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Непредвиденная ошибка
              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: >-
        Секунды ожидания, округлённые вверх до следующего окна. Присутствует при
        отказах middleware из-за исчерпания бюджета.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Область, бюджет которой превышен. Присутствует при отказах middleware
        из-за исчерпания бюджета.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Бюджет области, в которой превышен лимит; равен лимиту в теле ответа.
        Присутствует при отказах по бюджету промежуточного ПО.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Оставшийся бюджет, приведённый к нулю; совпадает с remaining в теле
        ответа. Присутствует в отказах из-за бюджета middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Время сброса в секундах Unix; равно reset в теле ответа. Присутствует
        при отказах middleware из-за исчерпания бюджета.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения берётся в разделе Developers -> API keys в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        можно ограничить: доступ для каждого ресурса (нет доступа, только чтение
        или запись), ограничение некоторыми сценариями или одобренными сессиями,
        список IP-адресов и дата истечения срока. Ответ 401 означает, что ключ
        неверный, отозван или истёк. Ответ 403 означает, что ключ не передан, у
        ключа нет доступа к этому ресурсу или действию либо запрос пришёл с
        адреса вне его списка IP. Ответ 404 на маршруте сессии означает, что
        сессия находится вне сценариев или статусов, доступных ключу. Ключ без
        доступа к медиа получает URL изображений, видео и PDF как null, а ключ
        без права записи в сессии получает ссылки и токены сессий как null. См.
        https://docs.didit.me/console/api-keys.

````

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