# Модульбанк API: Получить счета, баланс и овердрафт

Сценарий из mcp-everything. Актуально на 2026-10-13.

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

1. Получи токен с правом `account-info`.
2. Запроси компании и счета: POST /account-info.
3. Возьми `bankAccounts[].id` нужного счёта из ответа и используй его как `accountId`.
4. Получи `Balance` и `Overdraft`: POST /account-info/balance-details/{accountId}.

```bash
curl -X POST 'https://api.modulbank.ru/v1/account-info' \
  -H 'Authorization: Bearer <access_token>'

curl -X POST 'https://api.modulbank.ru/v1/account-info/balance-details/<accountId>' \
  -H 'Authorization: Bearer <access_token>'
```

## Базовые URL

- Боевой: `https://api.modulbank.ru/v1/`
- Песочница: `https://api.modulbank.ru/v1/`

## Авторизация

Тип: Bearer-токен

Для работы только со своей учётной записью сгенерируй токен в личном кабинете через пункт «Подключиться к API». Передавай его в каждом запросе в заголовке `Authorization: Bearer <access_token>` и не передавай третьим лицам.

Для приложения других пользователей зарегистрируй приложение через `api@modulbank.ru` и получи `clientId` и `clientSecret`. Отправь пользователя на GET /oauth/authorize с `clientId`, `redirectUri`, `scope` и `state`, затем немедленно обменяй одноразовый `code` через POST /oauth/token. Доступные права `scope`: `account-info`, `operation-history`, `operation-upload`.

В песочнице используй `clientId: sandboxapp`, `clientSecret: sandboxappsecret` и `Authorization: Bearer sandboxtoken`; реальные идентификаторы и токены там запрещены.

## Методы сценария

### POST /account-info — Получение информации о компаниях пользователя

Возвращает компании пользователя и их банковские счета. Системный идентификатор счёта находится в `bankAccounts[].id`, номер — в `bankAccounts[].number`; требуется право `account-info`.

Документация: https://api.modulbank.ru/#tag/Poluchenie-dannykh/paths/~1account-info/post

### POST /account-info/balance-details/{accountId} — Получение баланса и овердрафта по счету

Возвращает `Balance` и `Overdraft` выбранного счёта. Требуется право `account-info`.

Документация: https://api.modulbank.ru/#tag/Poluchenie-dannykh/paths/~1account-info~1balance-details~1%7BaccountId%7D/post

| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
| `accountId` | path | string<uuid> | да | Системный идентификатор счёта |

Пример ответа:

```json
{
  "Balance": 0,
  "Overdraft": 0
}
```

## Нюансы

- Параметры запроса API передаются в теле; поддерживаются `application/json` и `x-www-form-urlencoded`. Все сетевые взаимодействия должны идти по HTTPS с проверкой SSL-сертификата.
- В истории новая операция не обязательно появляется в начале. Если данные меняются между запросами, пагинация через `skip` и `records` может дать повторы или пропуски.
- В поле вебхука `operation.category` документация задаёт `Debet` для входящей и `Credit` для исходящей операции. Не подменяй эти значения привычной банковской трактовкой.
- Вебхуки отправляются только по HTTPS. Тестировать их в песочнице нельзя.
- Если вебхуки не приходят, разреши в фаерволе адреса `185.137.76.36`, `185.137.76.37`, `185.137.76.38`, `185.137.76.39` и проверь срок токена.
- Ключ идемпотентности для POST /operation-upload необязателен, но при повторе с тем же UUID сервер возвращает текущий `Id` ранее созданной операции.
- Если `parameters.targetStatus` не передан в POST /operation-upload, платёж создаётся как черновик.
- В песочнице реальные данные и идентификаторы запрещены. Для POST /operation-history/{accountId} там работают только фильтры `records` и `skip`; QR Pay в песочнице недоступен.
- Даты проведения и создания платежа указываются по московскому времени.

## Другие сценарии

- [Получить историю операций](https://mcp-everything.ru/integrations/modulbank/scenarios/poluchit-istoriyu-operatsiy.md)
- [Загрузить платёж на подпись](https://mcp-everything.ru/integrations/modulbank/scenarios/zagruzit-platezh-na-podpis.md)
- [Принять оплату по динамическому QR-коду СБП](https://mcp-everything.ru/integrations/modulbank/scenarios/prinyat-oplatu-po-dinamicheskomu-qr-kodu.md)
- [Вернуть оплату по динамическому QR-коду СБП](https://mcp-everything.ru/integrations/modulbank/scenarios/vernut-oplatu-po-dinamicheskomu-qr-kodu.md)
- [Получать уведомления о транзакциях](https://mcp-everything.ru/integrations/modulbank/scenarios/poluchat-uvedomleniya-o-tranzaktsiyah.md)

---

Если этого недостаточно — официальная документация: https://api.modulbank.ru/
Вся интеграция одним документом: https://mcp-everything.ru/integrations/modulbank.md