Перейти к основному содержанию
GET
curl
Эндпоинт получения банковского подключения от Didit возвращает одно подключение с его статусом, датами согласия, состоянием синхронизации, сводками по счетам и стоимостью. sync.initial_status показывает, когда первые данные становятся доступны для чтения, consent.expires_at показывает, когда нужно продлить согласие, а sync.budgets показывает, сколько обновлений банк ещё допускает. См. Подключения.

Авторизации

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.

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

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

Идентификатор подключения.

Ответ

Подключение.

Разрешение пользователя вашему приложению на чтение данных одного банка. При продлении сохраняются идентификатор подключения и идентификаторы всех счетов. У удалённого подключения в ответе присутствуют только id, status, status_reason, created_at и erasure, а все остальные поля отсутствуют: данные о банке, пользователе и счетах в нём не остаются.

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

Идентификатор подключения.

status
enum<string>
обязательно

pending: выполняется первая синхронизация. active: согласие действует. renewal_required: согласие закончилось или банк требует, чтобы пользователь снова вошел; данные доступны для чтения в состоянии последней синхронизации, плата не взимается. paused: баланс слишком низкий для месячного списания. revoked: доступ остановлен пользователем, банком или вами. deleted: остаются только id, status, status_reason, created_at и erasure. failed: первая синхронизация так и не завершилась успешно.

Доступные опции:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
обязательно

Почему подключение находится в этом статусе. paused_by_customer зарезервирован. Для подключения со статусом deleted: deleted_by_customer, consent_lapsed, retention_elapsed или application_deleted.

Доступные опции:
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
erasure
object | null
обязательно

Задаётся после delete_connection; иначе null.

created_at
string<date-time>
обязательно
environment
enum<string>
Доступные опции:
live,
sandbox
access
enum<string>
Доступные опции:
one_time,
ongoing
institution
object

Банк, для которого создано подключение или ссылка.

segment
enum<string> | null
Доступные опции:
personal,
business,
null
data
enum<string>[]

Области доступа, которые принял пользователь.

Доступные опции:
accounts,
balances,
transactions

Согласие пользователя на это подключение.

sync
object

Состояние синхронизации подключения.

accounts
object[]

Сводка по каждому счёту в подключении. Чтобы прочитать счёт целиком, используйте get_account.

ownership
object

Необязательное сравнение владельца счёта с физическим лицом или компанией.

end_user
object
manage_url
string<uri> | null

Страница доступа пользователя. Значение null, пока страница доступа недоступна.

billing
object

Сколько стоит это подключение. В песочнице оплата никогда не взимается.

possible_duplicate_of
string<uuid> | null

Задаётся, когда это подключение может дублировать другое активное, но ни один end_user.reference не позволил однозначно установить совпадение.

vendor_data
string | null
updated_at
string<date-time>
Последнее изменение 22 ноября 2026 г.