> ## 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 для отзыва банковского подключения закрывает доступ к банку: запросы данных прекращаются сразу после вызова.

Эндпоинт Didit «Отозвать подключение к банку» закрывает доступ к банку, и запросы данных из банка прекращаются в момент вашего вызова.
Отзыв ничего не удаляет: для этого используйте [удалить](https://docs.didit.me/ru/standalone-apis/bank-connection-delete.md).
Статус согласия сначала становится `revocation_pending`, а затем `revoked`, когда банк подтверждает отзыв.


## OpenAPI

````yaml ru/openapi-25.json POST /v3/bank/connections/{id}/revoke/
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}/revoke/:
    post:
      tags:
        - Bank Data
      summary: Отозвать банковское подключение
      description: >-
        Прекращает доступ к банку. Запросы к банку прекращаются сразу после
        вашего запроса, даже пока банк подтверждает отзыв: согласие получает
        статус `revocation_pending`, затем `revoked`, когда банк подтвердит, что
        доступ прекращён, или `revocation_failed`, пока вызов повторяется
        автоматически. `consent.ended_by` имеет значение `customer`.


        Отзыв ничего не удаляет: сохранённые счета, балансы и транзакции
        остаются доступными для чтения до `consent.retain_until`, то есть срока
        хранения, заданного в настройках вашего приложения, и плата не
        взимается. Чтобы удалить их сейчас, вызовите `delete_connection`.
        Повторный вызов возвращает текущее состояние.


        Нужен API-ключ с разрешением на доступ к банковским данным
        (`bank-data`): для этой операции требуется разрешение на запись, так как
        она что-то меняет. Ключ с полным доступом это разрешение не включает:
        выдайте его явно при создании ключа, иначе вызов вернёт `403
        bank_data_access_denied`.


        Отзыв удалённого подключения возвращает `200` с удалённым подключением,
        поэтому повторный вызов безопасен.
      operationId: revokeBankConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Идентификатор подключения.
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: Подключение со статусом отзыва.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnection'
              examples:
                Revocation pending:
                  summary: Запрошено прекращение доступа
                  value:
                    id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    environment: live
                    access: ongoing
                    status: active
                    status_reason: null
                    institution:
                      id: es-banco-norte
                      name: Banco Norte
                      country: ESP
                      logo_url: https://static.example.com/banks/es-banco-norte.png
                    segment: business
                    data:
                      - accounts
                      - balances
                      - transactions
                    consent:
                      status: revocation_pending
                      version: 1
                      granted_at: '2026-11-21T12:04:11Z'
                      expires_at: '2027-05-20T12:04:11Z'
                      days_granted: 180
                      renewed_count: 0
                      scopes_requested:
                        - accounts
                        - balances
                        - transactions
                      scopes_granted:
                        - accounts
                        - balances
                        - transactions
                      accounts_granted:
                        - a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        - c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                      renewal_action: bank_auth
                      renew_by: '2027-05-20T12:04:11Z'
                      reconfirm_by: null
                      renewable_until: '2026-12-21T15:10:00Z'
                      retain_until: '2026-12-21T15:10:00Z'
                      ended_at: '2026-11-21T15:10:00Z'
                      ended_by: customer
                    sync:
                      status: ok
                      initial_status: succeeded
                      initial_complete: true
                      history_complete: true
                      last_synced_at: '2026-11-21T12:04:40Z'
                      next_sync_at: '2026-11-22T06:00:00Z'
                      budgets:
                        - scope: connection
                          resource: all
                          limit: 4
                          remaining: 3
                          resets_at: '2026-11-22T00:00:00Z'
                      last_error: null
                      frequency_per_day: 1
                      live_syncs_left_today: 3
                    accounts:
                      - id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        name: Cuenta negocio
                        type: current
                        usage: business
                        currency: EUR
                        iban_last4: '1332'
                        status: open
                      - id: c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                        name: Cuenta de ahorro
                        type: savings
                        usage: business
                        currency: EUR
                        iban_last4: '7708'
                        status: open
                    ownership:
                      compare: none
                      match: null
                      check_id: null
                      result: null
                    end_user:
                      reference: client-7731
                    manage_url: null
                    billing:
                      unit: connection_month
                      price_usd: '0.9000'
                      billed_through: '2026-11-30'
                    possible_duplicate_of: null
                    erasure: null
                    vendor_data: client-7731
                    created_at: '2026-11-21T12:03:02Z'
                    updated_at: '2026-11-21T12:04:40Z'
        '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
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/revoke/'
            \
              -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.revoke_connection(
                "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.revokeConnection("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.RevokeConnection(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankRevokeConnectionParams{})\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().revokeConnection("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->revokeConnection('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.revoke_connection("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.RevokeConnectionAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Необязательный ключ для безопасных повторных запросов, который вы
        выбираете для одной операции, до 255 символов (подойдёт UUID). Запрос,
        повторённый с тем же ключом, endpoint, параметрами запроса и телом,
        получает первый ответ с тем же статусом и тем же телом и не выполняется
        и не тарифицируется повторно. Тот же ключ с другим endpoint, параметрами
        запроса или телом возвращает `409` `idempotency_key_reused`, а пока
        первый запрос ещё выполняется, `409` `idempotency_key_in_progress` с
        `Retry-After`. Неудачный запрос (любой `4xx` или `5xx`) не сохраняется,
        поэтому его можно отправить повторно с тем же ключом. Ключи принадлежат
        вашему приложению, независимо от того, вызываете ли вы API с API-ключом
        или с токеном доступа. См. [Повторные попытки и
        идемпотентность](/ru/integration/api-errors#повторные-попытки-и-идемпотентность).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankConnection:
      type: object
      description: >-
        Разрешение пользователя вашему приложению на чтение данных одного банка.
        При продлении сохраняются идентификатор подключения и идентификаторы
        всех счетов. У удалённого подключения в ответе присутствуют только `id`,
        `status`, `status_reason`, `created_at` и `erasure`, а все остальные
        поля отсутствуют: данные о банке, пользователе и счетах в нём не
        остаются.
      properties:
        id:
          type: string
          description: Идентификатор подключения.
          format: uuid
        environment:
          type: string
          enum:
            - live
            - sandbox
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - pending
            - active
            - renewal_required
            - paused
            - revoked
            - deleted
            - failed
          description: >-
            `pending`: выполняется первая синхронизация. `active`: согласие
            действует. `renewal_required`: согласие закончилось или банк
            требует, чтобы пользователь снова вошел; данные доступны для чтения
            в состоянии последней синхронизации, плата не взимается. `paused`:
            баланс слишком низкий для месячного списания. `revoked`: доступ
            остановлен пользователем, банком или вами. `deleted`: остаются
            только `id`, `status`, `status_reason`, `created_at` и `erasure`.
            `failed`: первая синхронизация так и не завершилась успешно.
        status_reason:
          type: string
          enum:
            - collection_complete
            - consent_expired
            - consent_lapsed
            - bank_requires_sign_in
            - revoked_by_end_user
            - revoked_by_bank
            - revoked_by_customer
            - insufficient_balance
            - paused_by_customer
            - first_sync_failed
            - deleted_by_customer
            - retention_elapsed
            - application_deleted
            - null
          description: >-
            Почему подключение находится в этом статусе. `paused_by_customer`
            зарезервирован. Для подключения со статусом `deleted`:
            `deleted_by_customer`, `consent_lapsed`, `retention_elapsed` или
            `application_deleted`.
          nullable: true
        institution:
          $ref: '#/components/schemas/BankInstitutionSummary'
        segment:
          type: string
          enum:
            - personal
            - business
            - null
          nullable: true
        data:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Области доступа, которые принял пользователь.
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: >-
            Сводка по каждому счёту в подключении. Чтобы прочитать счёт целиком,
            используйте `get_account`.
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: Ваш идентификатор физического или юридического лица.
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: >-
            Страница доступа пользователя. Значение `null`, пока страница
            доступа недоступна.
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            Задаётся, когда это подключение может дублировать другое активное,
            но ни один `end_user.reference` не позволил однозначно установить
            совпадение.
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: Задаётся после `delete_connection`; иначе `null`.
        vendor_data:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - status
        - status_reason
        - created_at
        - erasure
    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
    BankInstitutionSummary:
      type: object
      description: Банк, для которого создано подключение или ссылка.
      properties:
        id:
          type: string
          description: >-
            Идентификатор банка в Didit, стабильный слаг. Используйте его как
            `institution_id`.
          example: es-banco-norte
        name:
          type: string
          description: Название банка.
          example: Banco Norte
        country:
          type: string
          description: Страна банка, ISO 3166-1 alpha-3.
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: Логотип банка или `null`.
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: Согласие пользователя на это подключение.
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending` сохраняется, пока банк не подтвердит
            прекращение согласия, после чего статус становится `revoked`. При
            `revocation_failed` отзыв повторяется автоматически. Запросы к банку
            прекращаются сразу после того, как запрошен отзыв.
        version:
          type: integer
          description: >-
            Версия согласия. При продлении создаётся следующая версия в том же
            подключении.
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            Когда заканчивается согласие банка. Срок задаёт банк, до
            `consent_days`.
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: Срок действия согласия в днях, предоставленный банком.
          nullable: true
        renewed_count:
          type: integer
          description: Сколько раз было продлено согласие.
        scopes_requested:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        scopes_granted:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        accounts_granted:
          type: array
          items:
            type: string
            format: uuid
          description: Идентификаторы счетов, которыми пользователь делится.
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            Как проходит продление: `reconfirm` означает, что пользователь
            подтверждает действие на экране Didit без входа в банк, там где это
            разрешают банк и правила страны. `bank_auth` означает вход в банк.
          nullable: true
        renew_by:
          type: string
          description: >-
            Дата окончания согласия: продлите его до этого момента, чтобы не
            было перерыва.
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            Задаётся, когда `renewal_action` равно `reconfirm`: крайний момент
            для повторного подтверждения.
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            Последний момент, когда можно восстановить то же подключение после
            окончания согласия. После этого пользователь подключается заново.
            Совпадает с `retain_until`.
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            Задаётся, когда доступ завершён: срок, в течение которого
            сохранённые данные остаются доступными, определяется настройкой
            хранения вашего приложения.
          format: date-time
          nullable: true
        ended_at:
          type: string
          format: date-time
          nullable: true
        ended_by:
          type: string
          enum:
            - end_user
            - bank
            - customer
            - unknown
            - null
          description: >-
            Кто прекратил доступ; значение определяется на основе имеющихся
            данных. `unknown`, если ни банк, ни синхронизация этого не
            указывают.
          nullable: true
      required:
        - status
        - version
        - granted_at
        - expires_at
        - days_granted
        - renewed_count
        - scopes_requested
        - scopes_granted
        - accounts_granted
        - renewal_action
        - renew_by
        - reconfirm_by
        - renewable_until
        - retain_until
        - ended_at
        - ended_by
    BankConnectionSync:
      type: object
      description: Состояние синхронизации подключения.
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            `failing` после 24 часов неудачных попыток, которые повторяются с
            задержкой. Если банк просит пользователя войти снова, подключение
            вместо этого получает `renewal_required`.
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            Результат первой синхронизации. Подключение переходит в статус
            `active` при `succeeded` или `partial`, а в статус `failed`, если ни
            один счёт не был синхронизирован успешно.
        initial_complete:
          type: boolean
          description: >-
            `true` только тогда, когда `initial_status` равен `succeeded`:
            счета, балансы и последние транзакции доступны для чтения.
        history_complete:
          type: boolean
          description: >-
            `true`, когда догрузка истории завершилась по любой причине.
            Диапазоны, которые не удалось получить, перечислены в
            `history_coverage.missing_ranges` каждого счета.
        last_synced_at:
          type: string
          description: >-
            Когда данные в последний раз были получены от банка, а не когда вы
            их последний раз читали.
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            Когда запланирована следующая автоматическая синхронизация.
            Автоматическая синхронизация выполняется от одного до четырёх раз в
            день в зависимости от банка (см. `frequency_per_day`).
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: Ограничения банка на запросы данных без участия пользователя.
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: Последняя ошибка синхронизации или `null`.
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            Сколько раз в день выполняется автоматическая синхронизация для
            этого подключения: от одного до четырёх в зависимости от банка. Если
            банк разрешает больше чтений без участия пользователя, всегда
            остаются как минимум две в день для живых синхронизаций.
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            Сколько синхронизаций в реальном времени (`refresh_connection`)
            осталось сегодня в пределах лимита банка: значение `remaining`
            самого жёсткого бюджета. `null`, если банк не устанавливает лимит.
            Синхронизации в реальном времени входят в месячную цену.
          nullable: true
      required:
        - status
        - initial_status
        - initial_complete
        - history_complete
        - last_synced_at
        - next_sync_at
        - budgets
        - last_error
        - frequency_per_day
        - live_syncs_left_today
    BankConnectionAccountSummary:
      type: object
      description: Краткая форма счёта внутри подключения.
      properties:
        id:
          type: string
          description: >-
            Идентификатор счёта. Стабилен на протяжении всего срока жизни
            подключения, включая продления.
          format: uuid
        name:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - current
            - savings
            - card
            - loan
            - investment
            - other
        usage:
          type: string
          enum:
            - personal
            - business
            - unknown
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Код валюты по ISO 4217.
        iban_last4:
          type: string
          description: Последние четыре символа IBAN, если у счета он есть.
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
      required:
        - id
        - name
        - type
        - usage
        - currency
        - iban_last4
        - status
    BankConnectionOwnership:
      type: object
      description: >-
        Необязательное сравнение владельца счёта с физическим лицом или
        компанией.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
        match:
          type: string
          enum:
            - any_holder
            - all_holders
            - null
          nullable: true
        check_id:
          type: string
          description: >-
            Идентификатор результата проверки владения, если запрашивалось
            сравнение.
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            Вердикт. `unknown` во всех случаях, когда отсутствующие данные о
            владельце могут его изменить, а также когда банк не передаёт данные
            о владельце.
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: Сколько стоит это подключение. В песочнице оплата никогда не взимается.
      properties:
        unit:
          type: string
          description: >-
            Единица тарификации: `connection_month` для постоянного доступа,
            `one_time` в остальных случаях.
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            Ваша цена за месячный счетчик на сегодня для вашего приложения и
            страны, в USD, десятичная строка с 4 знаками после запятой.
            Подключение оплачивается за месяц только тогда, когда каждая
            принятая область данных опубликовала данные хотя бы по одному счету
            в этом месяце. `null` для одноразовых подключений и в песочнице.
            Постоянный доступ оплачивается за каждое активное подключение в
            месяц; текущая цена указана на странице цен
            (https://docs.didit.me/getting-started/pricing). Суммы в примерах
            приведены для иллюстрации; цена для страны указана на странице цен.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: Последний уже закрытый конец месяца.
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: Ход удаления, которое вы запросили.
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            `pending`, пока выполняется удаление, `erased`, когда не осталось ни
            сохранённой копии, ни доступа к данным в банке, `failed`, если
            удаление не удалось подтвердить в течение 24 часов. Неуспешное
            удаление оставляет данные подключения закрытыми, повторяется, и
            Didit получает оповещение.
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: Когда завершилось удаление. `null`, пока `status` не равен `erased`.
      required:
        - status
        - requested_at
        - erased_at
    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
    BankSyncBudget:
      type: object
      description: >-
        Один сегмент лимита банка на получение данных без присутствия
        пользователя.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Относительно чего банк учитывает бюджет.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: Счёт, если `scope` равен `account`.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Сколько раз в день Didit может запрашивать данные у банка без
            участия пользователя, как это определяет банк. Это потолок,
            установленный банком, а не гарантия.
        remaining:
          type: integer
          description: >-
            Оставшиеся запросы на обновление данных в текущем окне. Чтения,
            зарезервированные для автоматической синхронизации, уже вычтены, и
            автоматическая синхронизация никогда не забирает последние два
            чтения за день, поэтому два обновления по запросу всегда остаются
            доступны.
        resets_at:
          type: string
          description: Когда окно сбрасывается.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: Почему не удалась синхронизация.
      properties:
        code:
          type: string
          description: Код ошибки Didit.
        message:
          type: string
          description: Пояснение простым языком.
        at:
          type: string
          description: Когда это произошло. `null` для результата по отдельному счёту.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  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
    RateLimitedWrite:
      description: >-
        Превышен общий лимит записи: 300 запросов в минуту на один API-ключ.
        Перед повторной попыткой учитывайте `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          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
      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'
    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.