> ## 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 для отмены привязки банка завершает незавершённую привязку, после чего её URL и token перестают работать.

Эндпоинт Didit Cancel a Bank Link отменяет незавершённую ссылку на подключение банка, поэтому её `url` и токен перестают работать.
Используйте его, когда ваш пользователь прерывает процесс или когда вы создаёте новую ссылку для того же пользователя.
Отмена завершённой ссылки ничего не меняет и возвращает `200` с неизменённой ссылкой: чтобы прекратить доступ, используйте [отзыв доступа](https://docs.didit.me/ru/standalone-apis/bank-connection-revoke.md).


## OpenAPI

````yaml ru/openapi-25.json POST /v3/bank/links/{id}/cancel/
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/links/{id}/cancel/:
    post:
      tags:
        - Bank Data
      summary: Отмена банковской ссылки
      description: >-
        Отменяет ссылку, которая ещё не завершена; её url и token перестают
        работать. Отмена уже отменённой, истёкшей, завершившейся с ошибкой или
        завершённой ссылки возвращает `200` и саму ссылку без изменений, поэтому
        повторять запрос безопасно. Завершённая ссылка сохраняет своё
        подключение.
      operationId: cancelBankLink
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Идентификатор ссылки.
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: >-
            Ссылка, теперь в статусе `cancelled`, или без изменений, если она
            уже находилась в финальном статусе.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Cancelled:
                  summary: Отменённая ссылка
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: cancelled
                    url: null
                    client_token: null
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: null
                    check_id: null
                    reused: false
                    error: null
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
        '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/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/cancel/'
            \
              -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.cancel_link(
                "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.cancelLink("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.CancelLink(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankCancelLinkParams{})\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().cancelLink("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->cancelLink('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.cancel_link("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.CancelLinkAsync("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:
    BankLink:
      type: object
      description: >-
        Один запуск Bank Link для одного пользователя: подключение банка или
        продление подключения. Подтверждайте ссылку сами с помощью `get_link`:
        никогда не доверяйте идентификатору, присланному браузером.
      properties:
        id:
          type: string
          description: Идентификатор ссылки.
          format: uuid
        mode:
          type: string
          enum:
            - connect
            - renew
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - created
            - opened
            - connecting
            - completed
            - cancelled
            - expired
            - failed
          description: >-
            Состояние ссылки. `completed`, `cancelled`, `expired` и `failed`
            являются конечными.
        url:
          type: string
          description: >-
            Размещённая страница верификации, на которую нужно направить
            пользователя. Возвращается только при создании ссылки; при
            последующих чтениях равна `null`, потому что токен не сохраняется.
          nullable: true
          format: uri
        client_token:
          type: string
          description: >-
            Токен для встроенного Bank Link от Didit, который пока не
            предоставляется: откройте `url` сегодня. Возвращается только при
            создании ссылки; при последующих чтениях значение `null`. Имеет одно
            назначение и короткий срок жизни. Не содержит персональных данных.
            Никогда не записывайте его в журнал.
          nullable: true
        expires_at:
          type: string
          description: Когда перестаёт работать неиспользованная ссылка.
          format: date-time
        connection_id:
          type: string
          description: >-
            Подключение, которое создала или продлила эта ссылка, когда `status`
            принимает значение `completed`.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            Результат проверки владения по этой ссылке, если запрошено
            `ownership.compare` со значением, отличным от `none`.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `true`, когда ссылка завершилась как продление существующего
            подключения, потому что человек уже делится именно этими счетами
            (`duplicates: reuse`). Повторное списание не производится.
        error:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            Почему ссылка не сработала, когда `status` равен `failed`. Иначе
            `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: Ваш референс из запроса.
          nullable: true
      required:
        - id
        - mode
        - access
        - status
        - url
        - client_token
        - expires_at
        - connection_id
        - check_id
        - reused
        - error
        - quote
        - vendor_data
    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
    BankLinkError:
      type: object
      description: >-
        Причина, по которой ссылка завершилась со статусом `failed`. Ничего не
        было опубликовано и не списано.
      properties:
        code:
          type: string
          enum:
            - duplicate_conflict
            - renewal_login_mismatch
            - reduced_grant
            - corporate_approval_not_supported
            - ongoing_access_not_available
            - bank_unavailable
            - bank_cancelled
            - consent_declined
            - read_limit
            - renewal_not_needed
            - renewal_window_expired
            - first_sync_failed
          description: >-
            Почему ссылка не сработала. Неудачная ссылка не является
            HTTP-ошибкой: ссылка возвращается с `status: failed` и этим
            объектом. Ссылка на продление, подключение по которой тем временем
            изменилось, возвращает `renewal_not_needed` или
            `renewal_window_expired`.
        message:
          type: string
          description: Пояснение простым языком для разработчика.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            Для `duplicate_conflict`: идентификаторы активных подключений,
            которые пересекаются. Продлите одно из них или создайте ссылку
            заново с `duplicates: allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        Стоимость ссылки, зафиксированная при её создании. Списывается стоимость
        из котировки. Чтения не тарифицируются.
      properties:
        id:
          type: string
          description: Идентификатор котировки.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Тарифные позиции, за которые взимается плата по этой ссылке, за
            запрошенные области данных.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Стоимость разового запасного чтения, которая указывается только если
            ссылка создана с `allow_one_time_fallback`. Отображается в ответе на
            создание и в остальных случаях равна `null`. Разовое чтение с
            данными может стоить дороже первого месяца постоянного доступа.
        total_usd:
          type: string
          description: >-
            Итог по `lines` в USD. Итог может только уменьшаться: при уменьшении
            предоставленного объёма или когда пользователь выбирает страну с
            более низкой ценой.
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            Котировка закреплена за ссылкой и действует в течение всего срока её
            жизни, поэтому совпадает со значением `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Данные определяют, к чему относятся цены котировки.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    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
    BankLinkQuoteLine:
      type: object
      description: Одна строка с ценой в ценовом предложении
      properties:
        meter:
          type: string
          description: >-
            Что тарифицируется, например `bank_data_connection_month`,
            `bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            Что представляет собой одна единица, например `connection_month` или
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: >-
            Цена одной единицы в USD, десятичная строка с 4 знаками после
            запятой. Суммы в примерах иллюстративные; цена для страны указана на
            странице цен.
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  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.