Модульбанк API

API QR Pay (PortalAPI/SBP) Режим песочницы недоступен для методов QR Pay. Рекомендуется проводить тестирование на бою малыми суммами. По динамическим QR кодам возможен возврат платежа. Базовый адрес https://api.modulbank.ru/v1/ Авторизация Смотрите раздел получение данных Требуемые права токена account info, operation upload Типы перечислений Тип ТСП Значение Описание QRPay Стандартная точка продаж СБП InternetAcquiring Интернет эквайринг ModulKassa МодульКасса Статус регистрации ТСП Значение Описание New Новый запрос Processing В обработке Registered Зарегестрирован в СБП Rejected Отклонен Blocked Заблокирован (приостановка от фрод мониторинга) Error Ошибка при регистрации RejectedFBR Отклонен фрод мониторингом NotRegistered Заявка не зарегистрирована, ожидает начала регистрации Тип QR кода Значение Описание QRS Статический (QR наклейка) QRD Динамический (QR на кассе) Статусы QR кода Значение Описание NotStarted Операции по QR коду не существует Received Операция в обработке InProgress Операция в обработке Accepted Операция завершена успешно Rejected Операция отклонена TimedOut Время ожидания операции превышено

Владелец номинального счета ежедневно не позднее 23:00 МСК отправляет данные бенефициарных владельцев (бенефициаров). Для этого используется публичное API Модульбанка. В массиве данных должна содержаться информация обо всех бенефициарах, чьи деньги находятся на номинальном счете на момент отправки массива, а также о бенефициарах, по которым были движения средств за прошедшие сутки. Система Модульбанка обрабатывает полученные данные, и на их основе формирует Отчет о бенефициарных владельцах на текущую дату и Анкеты бенефициарных владельцев по форме, которая соответствует требованиям 115 ФЗ. Если клиент не прислал массив, то мы отправляем в его личный кабинет уведомление о том, что данные нужно отправить. Отчет и Анкеты размещаются в личном кабинете Модульбанка владельца номинального счета. Туда же отправляется уведомление о необходимости подписания файлов. Владелец номинального счета на следующий день после отправки массива подписывает Отчёт и Анкеты. Это делается или через личный кабинет или через API Модульбанка. В первом случае владелец входит в кабинет и подписывает Отчет простой электронной подписью, а Анкеты усиленной квалифицированной электронной подписью (УКЭП). Способ подписания через API описан ниже. Подписанные отчет и анкеты сохраняются в системе Модульбанка. Подписание Отчёта по бенефициарам через API Здесь и ниже: при получении ошибок попытайтесь выполнить рекомендации из сообщения об ошибке. Если это не поможет напишите в поддержку банка. Есть два метода подписания отчетов по бенефициарам: v1 и v2. Метод v2 реализован позже и отличается тем, что сначала нужно получить и подписать PDF всех ранее неподписанных отчётов, а не только последнего. На текущий момент работают обе версии, но мы настоятельно рекомендуем использовать метод v2, так как в скором времени v1 будет отключён. Описание метода v1: 1. По номеру номинального счёта получите PDF с последним отчётом о бенефициарах – метод "Получить файл отчёта". 2. Полученный отчёт подпишите с помощью УКЭП и передайте в банк отсоединённую подпись в формате Base64 – метод "Проверить и передать в банк подписанный отчёт". Описание метода v2: 1. По номеру номинального счёта получите список всех ID отчетов, которые ранее не были подписаны – "Метод получения информации о не подписанных отчетов". 2. По полученным ID с помощью "Метода получения файла отчета" получите PDF файлы отчетов. 3. Полученные файлы подпишите с помощью УКЭП и передайте в банк отсоединённую подпись в формате Base64 – метод "Проверить и передать в банк подписанный отчёт". Пример того, как можно подписать данные см. ниже. Подписание Анкет бенефициаров через API 1. Методом "Получить список анкет по бенефициарам" получите id частей анкет (Guid). В случае, когда бенефициаров немного, каждая анкета будет иметь одну часть, но возможно и большее количество. 2. Вызовите метод "Получить файл с частью конкретной анкеты" для получения zip архива. 3. Используйте метод "Проверить и передать в банк подписанную часть анкеты" для загрузки отсоединённой подписи в формате Base64. Пример того как можно подписать данные см. ниже. Подписание строки и получение отсоединённой электронной подписи в формате Base64. Скачать приложение cryptcp от компании КриптоПро и выполнить запрос: cryptcp.x64.exe sign f dn " " detached pin Например: cryptcp.x64.exe sign f cert2.cer dn "7840473679" detached pin password123 test.txt

Методы для получения информации по счетам и операциям.

Получить токен авторизации можно двумя способами: сгенерировать его в ЛК Модульбанка или получить по протоколу OAuth 2 . Генерация токена в ЛК Если вы хотите получать от API данные исключительно по свой учетной записи в Модульбанке, воспользуйтесь механизмом получения токена в Личном кабинете. Выберите пункт «Подключиться к API» в меню действий ЛК и следуйте дальнейшим инструкциям. Важно!Полученный токен привязан к вашей учетной записи в ЛК и не должен передаваться третьим лицам! После генерации токена вы можете сразу начать его использование для получения данных в API. OAuth 2. Общая схема работы Если вы разрабатываете приложение (бот для телеграма, плагин для общедоступной CRM и т.д.), которое может быть полезно для любого пользователя Модульбанка, вы можете авторизовывать пользователей через сервер авторизации Модульбанка по OAuth подобному протоколу. Схема авторизации пользователей идентична протоколу OAuth 2.0, за небольшим исключением что сервер авторизации Модульбанка кроме формата x www form urlencoded также поддерживает формат json в теле запроса. Для того чтобы стороннее приложение могло совершать запросы к API от лица конкретного пользователя, приложению необходимо получить токен авторизации, подтверждающий что пользователь предоставил приложению права на выполнение тех или иных действий. Важно!Если вы хотите авторизовывать пользователей Модульбанка по протоколу OAuth, ваше приложение должно быть зарегистрировано у нас. Для регистрации приложения напишите нам письмо на api@modulbank.ru. В ответ мы вышлем вам clientId и clientSecret — уникальные для каждого приложения идентификатор и секретное слово (необходимые параметры для взаимодействия с сервером авторизации Модульбанка). Схема получения токена авторизации пользователя сторонним приложением.  Пользователь инициирует авторизацию стороннего приложения. Приложение отправляет запрос Authorization Request на сервер авторизации Модульбанка. Сервер авторизации Модульбанка перенаправляет пользователя на страницу авторизации. Пользователь вводит свой логин и пароль, просматривает список запрашиваемых прав и подтверждает, либо отклоняет запрос авторизации. Приложение получает ответ Authorization Response в виде HTTP Redirect со временным токеном для получения доступа или кодом ошибки. Приложение, используя полученный временный токен доступа, отправляет запрос на получение токена авторизации. Ответ содержит токен авторизации ( access token ). Права на выполнение операций При запросе авторизации стороннее приложение должно явно указывать в параметре scope набор прав, необходимых приложению для работы. Список возможных прав: Название права Описание account info Получение информации о компаниях пользователя (один и тот же клиент Модульбанка может быть сотрудником нескольких компаний) и счетах компаний пользователя operation history Просмотр истории операций operation upload Загрузка операций в ЛК

Методы по созданию и подписанию платежей. Идемпотентность платежей Ключ идемпотентности опционален к заполнению, можно указывать в запросе в виде query параметра, например: https://api.modulbank.ru/v1/operation upload?idempotency key= или в header параметрах: Idempotency Key Валидации: при указании ключ идемпотентности не должен быть пустым, может содержать до 256 символов латиница, цифры, дефис При получении запроса operation upload с Idempotency Key, сервис проверит, была ли ранее создана операция с таким UUID. Если операция была создана, сервер вернет ответ с текущим Id этой операции. Если операции с таким UUID не найдено, сервис начнет ее выполнение