17 KiB
brokerage-accounts Specification
Purpose
Позволяет авторизованному пользователю просматривать поддерживаемые активные инвестиционные счета подключенного T-Bank и переходить к их деталям.
Requirements
Requirement: Список активных брокерских счетов
Система SHALL предоставлять авторизованному User GET /api/v1/brokerage-accounts, возвращающий массив открытых поддерживаемых инвестиционных счетов T-Bank, доступных через текущий T-Bank connection User, в порядке, полученном от T-Bank. Каждый элемент MUST содержать стабильный id, непустое name, нормализованный type (BROKERAGE, INDIVIDUAL_INVESTMENT, INVEST_BOX или MONEY_MARKET_FUND) и nullable openedOn в формате YYYY-MM-DD. Система MUST включать только счета T-Bank типов «брокерский счёт», «ИИС», «Инвесткопилка» и «фонд денежного рынка»; банковские и неизвестные типы MUST NOT возвращаться. Система MUST удалить внешние пробелы из имени и при пустом результате использовать непустое название соответствующего типа.
Каждый элемент MUST также содержать nullable portfolioSummary. Доступная сводка MUST содержать totalsByCurrency: точные Money-итоги Portfolio по исходным ISO-валютам, включающие стоимость позиций и Cash Balance в той же валюте. Она MUST NOT содержать FX-конвертированный или межвалютный итог и MUST NOT выдавать Cash Balance за самостоятельный второй итог. Если сводка Portfolio конкретного доступного счёта временно недоступна, portfolioSummary MUST быть null, не исключая этот счёт из списка и не делая список неуспешным. Пустой доступный Portfolio MUST передаваться доступной сводкой с пустым totalsByCurrency, а не null.
Список Brokerage Account и его сводки являются результатом наблюдения текущего брокерского подключения и MUST NOT создавать ожидание, что WealthLedger хранит долговременное право владения счётом или Portfolio независимо от T-Bank connection.
Scenario: Поддерживаемые счета возвращаются в upstream-порядке
- WHEN User с действующим T-Bank connection запрашивает список, а T-Bank возвращает открытые брокерский счёт, ИИС и неподдержанный дебетовый счёт
- THEN система отвечает
200массивом брокерского счёта и ИИС в исходном порядке T-Bank без дебетового счёта
Scenario: Пустой список поддерживаемых счетов
- WHEN User с действующим T-Bank connection не имеет открытых поддерживаемых инвестиционных счетов
- THEN система отвечает
200пустым массивом
Scenario: Пустое название получает fallback
- WHEN T-Bank возвращает поддерживаемый открытый счёт с пустым либо состоящим из пробелов именем
- THEN система отвечает этим счётом с непустым названием его нормализованного типа
Scenario: Дата открытия отсутствует
- WHEN T-Bank не возвращает дату открытия поддерживаемого открытого счёта
- THEN система отвечает этим счётом с
openedOn: null
Scenario: Мультивалютная сводка счёта
- WHEN доступный Portfolio счёта содержит итоги в RUB и USD, включая Cash Balance в USD
- THEN ответ содержит одну доступную
portfolioSummaryс отдельными Money-итогами RUB и USD без FX-конвертации, общего итога или отдельного итога Cash Balance
Scenario: Сводка одного счёта временно недоступна
- WHEN список доступных счетов получен, но Portfolio одного из них временно недоступен
- THEN система отвечает
200всеми счетами в исходном порядке, передаёт для этого счётаportfolioSummary: nullи не заменяет успешные сводки остальных счетов ошибкой списка
Scenario: Доступный Portfolio пуст
- WHEN доступный счёт не имеет ненулевых позиций и доступных денежных остатков
- THEN система передаёт доступную
portfolioSummaryс пустымtotalsByCurrency
Requirement: Состояния недоступности списка счетов
Система MUST NOT возвращать частичный или сохранённый ранее список счетов. При отсутствии T-Bank connection система MUST отвечать 409 Problem Details с code TBANK_NOT_CONNECTED. Если T-Bank отклоняет сохранённый token как неаутентифицированный или без прав, система MUST отвечать 400 Problem Details с code INVALID_TBANK_TOKEN и сохранять connection. При иной неуспешной попытке получить список из T-Bank система MUST отвечать 503 Problem Details с code TBANK_UNAVAILABLE.
Scenario: Подключение отсутствует
- WHEN User без сохранённого T-Bank connection запрашивает список
- THEN система не обращается к T-Bank и отвечает
409Problem Details с codeTBANK_NOT_CONNECTED
Scenario: Сохранённый token больше не действителен
- WHEN T-Bank отклоняет сохранённый token при запросе списка как неаутентифицированный или без прав
- THEN система отвечает
400Problem Details с codeINVALID_TBANK_TOKENи не удаляет connection
Scenario: T-Bank временно недоступен
- WHEN запрос списка не завершается из-за временной либо иной upstream-ошибки
- THEN система отвечает
503Problem Details с codeTBANK_UNAVAILABLEбез счетов
Requirement: Экран списка брокерских счетов
Клиент SHALL загружать список при открытии защищённого маршрута /accounts без ручного обновления и без автоматического refetch при возврате фокуса. Клиент MUST использовать успешный frontend-кэш списка в течение 60 секунд. После истечения этого срока клиент MUST запрашивать актуальный список; при уже имеющемся успешном списке он MUST сохранять последний успешный Client Cached Snapshot видимым во время фонового обновления и после его ошибки, ясно отделяя это состояние от свежего результата. При успешном непустом ответе клиент MUST отобразить адаптивный одноколоночный список широких интерактивных карточек счетов с локализованными типом и, если доступна, датой открытия без времени; каждая карточка MUST ясно показывать тип, имя, финансовую сводку, вторичные метаданные и заметное действие открытия счёта, вести на /accounts/:accountId по всей области и сохранять доступное клавиатурное состояние. После успешной замены или удаления T-Bank connection клиент MUST инвалидировать список счетов.
Для доступной portfolioSummary карточка MUST показывать не более двух Money-итогов в исходных валютах и обозначать наличие остальных валют, если они есть; она MUST NOT показывать или подразумевать FX-конвертацию, межвалютный агрегированный итог либо Cash Balance как отдельный второй итог. При portfolioSummary: null карточка MUST показывать локальное безопасное состояние временной недоступности сводки, сохраняя метаданные счёта и возможность открыть его. При доступной пустой сводке карточка MUST не выдавать отсутствие итогов за временную ошибку.
Scenario: Пользователь открывает счёт из списка
- WHEN клиент успешно загрузил непустой список и User выбирает карточку счёта
- THEN клиент переходит на
/accounts/:accountIdсidвыбранного счёта
Scenario: Список пуст
- WHEN клиент получает успешный пустой массив
- THEN клиент показывает штатное сообщение об отсутствии инвестиционных счетов T-Bank
Scenario: Список берётся из свежего frontend-кэша
- WHEN User повторно открывает список в течение 60 секунд после успешной загрузки
- THEN клиент показывает сохранённые счета без нового API-запроса
Scenario: Устаревший список загружается повторно
- WHEN User открывает список после истечения 60 секунд frontend-кэша и уже существует последний успешный список
- THEN клиент оставляет этот список видимым во время нового запроса и ясно обозначает фоновое обновление
Scenario: Ошибка фонового обновления не скрывает snapshot
- WHEN обновление устаревшего списка завершается ошибкой при наличии последнего успешного Client Cached Snapshot
- THEN клиент сохраняет snapshot видимым, безопасно сообщает о неуспешном обновлении и предоставляет применимое действие повторной загрузки
Scenario: Карточка ограничивает валютные итоги
- WHEN доступная сводка счёта содержит итоги в трёх или более валютах
- THEN карточка показывает не более двух исходных валютных итогов и обозначает наличие остальных без общего сконвертированного значения
Scenario: Недоступность сводки локальна карточке
- WHEN клиент получает список, в котором
portfolioSummaryодного счёта равнаnull - THEN он показывает временную недоступность только на этой карточке, не скрывает остальные карточки и сохраняет переход на детали недоступной сводки счёта
Scenario: Пустая сводка не является ошибкой
- WHEN клиент получает доступную
portfolioSummaryс пустымtotalsByCurrency - THEN он показывает нейтральное состояние отсутствия финансовых итогов, а не состояние временной недоступности
Requirement: Клиентские состояния ошибки списка счетов
Клиент MUST NOT автоматически повторять неуспешный запрос списка. При TBANK_NOT_CONNECTED клиент SHALL показать объяснение отсутствия подключения и действие «Открыть настройки T-Bank». При INVALID_TBANK_TOKEN клиент SHALL показать объяснение недействительного token и то же действие. При TBANK_UNAVAILABLE клиент SHALL показать безопасное объяснение временной недоступности, действие повторной загрузки и действие открытия настроек T-Bank. При иной ошибке клиент MUST показать общий безопасный error-state только с действием повторной загрузки. Если последний успешный Client Cached Snapshot отсутствует, эти состояния MUST NOT показывать список; если snapshot существует во время фонового обновления, клиент MUST сохранить его видимым и показать соответствующее безопасное предупреждение и только применимые действия.
Scenario: Подключение требуется
- WHEN клиент получает
TBANK_NOT_CONNECTED - THEN клиент не показывает список и предлагает открыть настройки T-Bank
Scenario: Известная ошибка не повторяется автоматически
- WHEN запрос списка завершается известной ошибкой
- THEN клиент не выполняет дополнительные запросы, пока User не выберет действие повторной загрузки
Scenario: Token требует внимания
- WHEN клиент получает
INVALID_TBANK_TOKEN - THEN клиент не показывает список и предлагает открыть настройки T-Bank
Scenario: Временная ошибка T-Bank
- WHEN клиент получает
TBANK_UNAVAILABLE - THEN клиент не показывает список и предлагает повторить загрузку либо открыть настройки T-Bank
Scenario: Неизвестная ошибка загрузки
- WHEN клиент получает ошибку без известного кода списка счетов
- THEN клиент не показывает список и предлагает только повторить загрузку
Scenario: Известная ошибка при сохранённом snapshot
- WHEN фоновое обновление списка с последним успешным Client Cached Snapshot получает
TBANK_UNAVAILABLE - THEN клиент сохраняет snapshot видимым, сообщает о временной недоступности и предлагает повторить загрузку либо открыть настройки T-Bank