Информация о продукте
Банковская выписка — это документ, содержащий список всех операций по счету за определенный период (неделю, месяц, квартал). Она отражает состояние счета на начало и конец периода, приход и расход средств, а также адресатов и отправителей платежей.
Выписка нужна для того, чтобы видеть, когда и сколько денег переводили со счета и получали на счет, а также общее количество поступлений и списаний за период. Это помогает анализировать траты и поступления, корректировать деятельность и планировать финансы.
Варианты реализации
Ниже будут приведены примеры реализации. Сценарии могут быть для вас отправной точкой и идеей для финального способа реализации функциональности.
Сценарии описали общие, для более легкого восприятия информации описания работы с продуктом Выписки по счету в Sber API.
Можно использовать разные триггеры запуска того или иного сценария - действия пользователя, регламентный запуск по времени, наступление определенных событий и другие варианты.
Получение выписки по счету
Шаги
- Получить информацию по счетам
- Запросить выписку
- Отразить выписку Пользователю
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках Платформы
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Пользователь имеет пользовательский профиль в СберБизнес своей компании
- Пользователь находится в пространстве Платформы
- Пользователь прошел авторизацию с помощью СберБизнес ID
Постусловия
- Пользователь получил выписку по счету в рамках UI Платформы
Используемые ресурсы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 |  | /ic/sso/api/v2/oauth/user-info | Получение информации | openid | 1. Получить информацию по счетам |
| 2 | | /fintech/api/v2/statement/transactions | Получить выписку по счету | GET_STATEMENT_ACCOUNT | 2. Запросить выписку |
| 3 |  | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 2. Запросить выписку |
Получение реквизитов операции
Шаги
- Получить реквизиты операции
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках Платформы
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Успешно выполнен сценарий "Получение выписки по счету"
- В сценарии "Получение выписки по счету" Платформа сохранила идентификаторы операций из выписки (operationId) в своей БД
Постусловия
- Пользователь получил информацию по операции
Используемые ресурсы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /fintech/api/v2/statement/transactionId | Получить информацию из выписки по одной операции | GET_STATEMENT_ACCOUNT | 1. Получить реквизиты операции |
| 2 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить реквизиты операции |
Получение печатной формы операции
Шаги
- Запросить печатную форму
- Декодировать файл
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках Платформы
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Успешно выполнен сценарий "Получение выписки по счету"
- В сценарии "Получение выписки по счету" Платформа сохранила идентификаторы операций из выписки (operationId) в своей БД
Постусловия
- Пользователь получил печатную форму по операции
Используемые ресурсы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /fintech/api/v2/statement/transactionId/print | Получить операцию из выписки в печатном формате файла | GET_STATEMENT_TRANSACTION | 1. Получить реквизиты операции |
| 2 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить реквизиты операции |
Получение информации по оборотам
Шаги
- Получить информацию по счетам
- Запросить информацию по оборотам
- Отразить информацию Пользователю
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках Платформы
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Пользователь имеет пользовательский профиль в СберБизнес своей компании
- Пользователь находится в пространстве Платформы
- Пользователь прошел авторизацию с помощью СберБизнес ID
Постусловия
- Пользователь получил информацию по оборотам счета в рамках UI Платформы
Используемые ресурсы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /ic/sso/api/v2/oauth/user-info | Получение информации | openid | 1. Получить информацию по счетам |
| 1 | | /fintech/api/v2/statement/summary | Получить информацию по оборотам счета | GET_STATEMENT_ACCOUNT | 2. Запросить информацию по оборотам |
| 2 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить информацию по счетам |
Получение печатной формы выписки по счету
Шаги
- Получить информацию по счетам
- Запросить печатную форму выписки
- Скачать и отразить выписку в UI
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках Платформы
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Пользователь имеет пользовательский профиль в СберБизнес своей компании
- Пользователь находится в пространстве Платформы
- Пользователь прошел авторизацию с помощью СберБизнес ID
Постусловия
- Пользователь получил печатную форму выписки по счету
Используемые ресурсы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /ic/sso/api/v2/oauth/user-info | Получение информации | openid | 1. Получить информацию по счетам |
| 2 | | /fintech/api/v1/statement/print | Получить выписку в печатном формате файла | GET_STATEMENT_ACCOUNT | 2. Запросить печатную форму выписки |
| 3 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 2. Запросить печатную форму выписки |
| 4 | | /v1/files/tasks-for-download/{taskId} | Получение ссылки для загрузки печатной формы | FILES | 3. Скачать и отразить выписку в UI |
Выгрузка для экспорта в другие системы
Шаги
- Получить информацию по счетам
- Запросить файл выписки для экспорта
- Скачать и отразить выписку в UI
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках Платформы
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Пользователь имеет пользовательский профиль в СберБизнес своей компании
- Пользователь находится в пространстве Платформы
- Пользователь прошел авторизацию с помощью СберБизнес ID
Постусловия
- Пользователь получил печатную форму выписки по счету
Используемые ресурсы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /ic/sso/api/v2/oauth/user-info | Получение информации | openid | 1. Получить информацию по счетам |
| 2 | | /fintech/api/v1/statement/files | Запросить выписку для экспорта в другие системы | GET_STATEMENT_ACCOUNT | 2. Запросить печатную форму выписки |
| 3 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 2. Запросить печатную форму выписки |
| 4 | | /v1/files/tasks-for-download/{taskId} | Получение ссылки для загрузки печатной формы | FILES | 3. Скачать и отразить выписку в UI |