Загрузка данных
Импорт платежек в формате 1С (бета версия)
Метод в API
https://api.modulbank.ru/v1/operation-upload/1c
Описание
Публичное апи позволяет загружать в личный кабинет платежные поручения в формате 1С (http://v8.1c.ru/edi/edi_stnd/100/101.htm). Все загруженные платежные поручения имеют статус «Черновик». Подписание поручений возможно только внутри личного кабинета.
Требуемые права токена
operation-upload
Пример вызова
POST /v1/operation-upload/1c
Host: api.modulbank.ru
Content-Type: application/json
Authorization: Bearer aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2
{
"document":"1CClientBankExchange
ВерсияФормата=1.03
Кодировка=Windows
ДатаСоздания=23.08.2016
ВремяСоздания=09:50:53
ДатаНачала=24.07.2016
ДатаКонца=23.08.2016
РасчСчет=40802810670010011008
СекцияДокумент=Платежное поручение
Номер=994720
Дата=11.08.2016
Сумма=100.00
НазначениеПлатежа=Для теста
Плательщик1=Индивидуальный предприниматель Александров Александр Александрович
ПлательщикИНН=770400372208
ПлательщикСчет=40802810670010011008
ПлательщикКПП=0
ПолучательКПП=771543001
ПоказательКБК=
ОКАТО=
ПоказательОснования=
ПоказательПериода=
ПоказательНомера=
ПоказательДаты=
ПоказательТипа=
ПлательщикБанк1=МОСКОВСКИЙ ФИЛИАЛ АО КБ \"МОДУЛЬБАНК\"
ПлательщикБИК=044525092
ПлательщикКорсчет=30101810645250000092
Получатель1=МОСКОВСКИЙ ФИЛИАЛ АО КБ \"МОДУЛЬБАНК\"
ПолучательИНН=2204000595
ПолучательСчет=30102810675250000092
ВидОплаты=01
СрокПлатежа=
Очередность=5
ВидПлатежа=
КодНазПлатежа=1
ДатаСписано=12.08.2016
ПолучательБанк1=МОСКОВСКИЙ ФИЛИАЛ АО КБ \"МОДУЛЬБАНК\"
ПолучательБИК=044525092
ПолучательКорсчет=30102810675250000092
Код=
КонецДокумента
КонецФайла"
}
Входные параметры
Список параметров:
Поле | Как передается | Описание |
---|---|---|
document | В теле запроса | Обязательный. Платежные поручения в формате 1С |
Возвращает
Возвращает количество загруженных платежных поручений, ошибки по незагруженным платежным поручениям, а также список идентификаторов созданных платежей в соответствии с переданными номерами
Пример ответа сервера
{
totalLoaded: 2,
errors: ["Документ 11 от 11.08.2016 на сумму 15000 рублей . Ошибка: Неверное значение поля ПлательщикБИК"],
"transactions": {
"994720": "273213a6-738d-4b06-bdc8-10896bc5c25e",
"994721": "e58cedc8-7978-4d1c-a9ff-88b88ed1ae3c"
}
}
Подписание платежей
Описание протокола
https://api.modulbank.ru/v1/operation-upload/sign
Позволяет подписывать платежи квалифицированной электронной подписью. После подписания платежи отправляются в банк и проводятся.
Требуемые права токена
operation-upload
Пример вызова
POST /v1/operation-upload/sign
Host: api.modulbank.ru
Content-Type: application/json
Authorization: Bearer aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2
{
"Operations": [
"fa74a744-6aa9-436f-8f3c-e29a058999c0",
"9c6f2638-e556-4fa3-b59d-fbb1ff2a8f6c"
],
"SignBase64": "dGVzdHNpZ24="
}
Описание параметров
Параметры | Описание |
---|---|
Operations | список id подписываемых транзакций |
SignBase64 | подпись транзакции |
Формирование подписи
Для подписания составляем строку из id платежей отсортированных по алфавиту, без кавычек разделенных запятой, без пробелов. Для примера выше это:
9c6f2638-e556-4fa3-b59d-fbb1ff2a8f6c,fa74a744-6aa9-436f-8f3c-e29a058999c0
Подписываем её через КриптоПро подписью компании которой они принадлежат. Полученную подпись переводим в Base64.
Ответ сервера
В случае успешного выполнения метода (код 200) возвращается статус подписания по каждому переданному платежу.
{
"SignedResults": [
{
"Id": "7872b839-8b0d-4d83-83ee-0697292f5eee",
"Status": "Signed",
"Message": "OK"
},
{
"Id": "36f99f92-e45f-4e88-b374-c5aa471856b7",
"Status": "Error",
"Message": "NotFound"
}
]
}
В случае ошибки вернётся код ответа ответа отличный от 200.
Например для некорректных параметров запроса вернётся код ответа 400 с описанием ошибки по формату
{
"Message": "Список операций для подписания пуст",
"ExceptionType": "EmptyOperatons"
}