Перейти к основному содержанию
POST
curl
Эндпоинт Didit Cancel a Bank Link отменяет незавершённую ссылку на подключение банка, поэтому её url и токен перестают работать. Используйте его, когда ваш пользователь прерывает процесс или когда вы создаёте новую ссылку для того же пользователя. Отмена завершённой ссылки ничего не меняет и возвращает 200 с неизменённой ссылкой: чтобы прекратить доступ, используйте отзыв доступа.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения берётся в разделе Developers -> API keys в Business Console. Основной ключ имеет полный доступ. Именованный ключ можно ограничить: доступ для каждого ресурса (нет доступа, только чтение или запись), ограничение некоторыми сценариями или одобренными сессиями, список IP-адресов и дата истечения срока. Ответ 401 означает, что ключ неверный, отозван или истёк. Ответ 403 означает, что ключ не передан, у ключа нет доступа к этому ресурсу или действию либо запрос пришёл с адреса вне его списка IP. Ответ 404 на маршруте сессии означает, что сессия находится вне сценариев или статусов, доступных ключу. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без права записи в сессии получает ссылки и токены сессий как null. См. https://docs.didit.me/console/api-keys.

Заголовки

Idempotency-Key
string

Необязательный ключ для безопасных повторных запросов, который вы выбираете для одной операции, до 255 символов (подойдёт UUID). Запрос, повторённый с тем же ключом, endpoint, параметрами запроса и телом, получает первый ответ с тем же статусом и тем же телом и не выполняется и не тарифицируется повторно. Тот же ключ с другим endpoint, параметрами запроса или телом возвращает 409 idempotency_key_reused, а пока первый запрос ещё выполняется, 409 idempotency_key_in_progress с Retry-After. Неудачный запрос (любой 4xx или 5xx) не сохраняется, поэтому его можно отправить повторно с тем же ключом. Ключи принадлежат вашему приложению, независимо от того, вызываете ли вы API с API-ключом или с токеном доступа. См. Повторные попытки и идемпотентность.

Required string length: 1 - 255

Параметры пути

id
string<uuid>
обязательно

Идентификатор ссылки.

Ответ

Ссылка, теперь в статусе cancelled, или без изменений, если она уже находилась в финальном статусе.

Один запуск Bank Link для одного пользователя: подключение банка или продление подключения. Подтверждайте ссылку сами с помощью get_link: никогда не доверяйте идентификатору, присланному браузером.

id
string<uuid>
обязательно

Идентификатор ссылки.

mode
enum<string>
обязательно
Доступные опции:
connect,
renew
access
enum<string>
обязательно
Доступные опции:
one_time,
ongoing
status
enum<string>
обязательно

Состояние ссылки. completed, cancelled, expired и failed являются конечными.

Доступные опции:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
обязательно

Размещённая страница верификации, на которую нужно направить пользователя. Возвращается только при создании ссылки; при последующих чтениях равна null, потому что токен не сохраняется.

client_token
string | null
обязательно

Токен для встроенного Bank Link от Didit, который пока не предоставляется: откройте url сегодня. Возвращается только при создании ссылки; при последующих чтениях значение null. Имеет одно назначение и короткий срок жизни. Не содержит персональных данных. Никогда не записывайте его в журнал.

expires_at
string<date-time>
обязательно

Когда перестаёт работать неиспользованная ссылка.

connection_id
string<uuid> | null
обязательно

Подключение, которое создала или продлила эта ссылка, когда status принимает значение completed.

check_id
string<uuid> | null
обязательно

Результат проверки владения по этой ссылке, если запрошено ownership.compare со значением, отличным от none.

reused
boolean
обязательно

true, когда ссылка завершилась как продление существующего подключения, потому что человек уже делится именно этими счетами (duplicates: reuse). Повторное списание не производится.

error
object | null
обязательно

Почему ссылка не сработала, когда status равен failed. Иначе null.

quote
object
обязательно

Стоимость ссылки, зафиксированная при её создании. Списывается стоимость из котировки. Чтения не тарифицируются.

vendor_data
string | null
обязательно

Ваш референс из запроса.

Последнее изменение 22 ноября 2026 г.