Управление идентификаторами – «Заявки»
Версия 1.0.0
Авторские права © 2025 ПАО Московская Биржа
Содержание
Метод POST /lk/lku/{orgId}/login/management/external/orders
Метод GET /lk/lku/{orgId}/login/management/external/orders/{orderId}
Метод POST /lk/lku/{orgId}/login/management/external/orders/{orderFormType}
Метод POST /lk/lku/{orgId}/login/management/external/orders/send/{orderFormType}/{orderId}
Настоящий документ описывает методы управления идентификаторами для получения заявок на присвоение, изменение и аннулирование ИТД/ИСД на рынках Московской биржи, таких как Фондовый рынок (ФР), Рынок депозитов (РД), Рынок кредитов (РК), Валютный рынок (ВР), Срочный рынок (СР) и Денежный рынок (ДР). Основные методы включают получение списка всех заявок, получение детализированной информации по одной заявке, создание новой заявки и ее отправку на рассмотрение. Для каждого метода подробно описаны все атрибуты и параметры, такие как тип данных, обязательность и примеры использования. Также приведены схемы ответов на запросы, включая примеры данных, которые могут быть получены в результате вызова соответствующих методов.
Описание кодов ответов HTTP
Статус код | Тип | Сообщение | Описание |
---|---|---|---|
2xx - Успешные | |||
200 | ОК | Успешно | Операция выполнена успешно. Например, GET: Запрошенный ресурс был найден и передан в теле ответа. Указывает на успешное выполнение запроса. Это означает, что сервер получил и обработал запрос корректно, и клиент может ожидать получения запрошенных данных или выполнения действия. |
201 | CREATED | Запрос успешно выполнен, и в результате был создан ресурс. | При создании ресурса в ответе может быть включен заголовок Location, который указывает URL нового ресурса. Это позволяет клиенту сразу узнать, где он может получить доступ к созданному ресурсу. В теле ответа содержится информация о созданном ресурсе, такая как его уникальный идентификатор. |
204 | NO CONTENT | Нет содержимого для ответа на запрос. | Сервер успешно обработал запрос, но в ответе были переданы только заголовки без тела сообщения. Клиент не должен обновлять содержимое документа, но может применить к нему полученные метаданные. |
4xx - Клиентские ошибки | |||
400 | BAD REQUEST | Некорректный запрос. Убедитесь, что адрес указан верно и попробуйте еще раз. | Не были переданы обязательные входные параметры или во входных параметрах были переданы не валидные данные. |
401 | UNAUTHORIZED | Ошибка авторизации. Для доступа к запрашиваемому ресурсу требуется аутентификация. | Если данные для аутентификации не переданы или недействительны, а также при неуспешной валидации токена. |
5xx - Серверные ошибки | |||
500 | INTERNAL SERVER ERROR | Внутренняя ошибка сервера. Подождите несколько минут и попробуйте снова. | Ошибка на стороне сервера. Сервер обнаружил неожиданное условие, которое он не знает как обработать. |
502 | Bad Gateway | Плохой, ошибочный шлюз. | Сервер, действующий как шлюз или прокси-сервер, столкнулся с проблемой при попытке установить связь с вышестоящим сервером. Это ошибка на стороне сервера, и клиент обычно не может устранить ее напрямую. |
Выходные параметры при ошибке
Параметр | Тип данных JSON | Обязательность | Описание параметра |
---|---|---|---|
statuscode | integer | да | Код состояния HTTP |
exception | string | да | Сообщение об ошибке |
response | string | да | Описание ошибки |
{
"statuscode": "integer",
"exception ": "string",
"response": "string"
}
Получение списка всех документов (заявок) для просмотра заявлений на присвоение, изменение и аннулирование ИТД/ИСД, зарегистрированного на любом из рынков ФР, РД, РК, ВР, СР, ДР (без ИСД), созданных на собственном ПО с использованием API Биржи.
Параметр | Принадлежность | Тип данных | Обязательность | Наименование | Комментарий |
---|---|---|---|---|---|
page | query | integer | Да | Страница | |
size | query | integer | Да | Количество элементов на странице | |
orgId | path | string | Да | Идентификатор организации | Значение orgId из ответа метода /lk/shared/permissions/scopes |
ClientRequestId | header | - | Нет | Идентификатор клиентского запроса | Идентификатор запроса, который используется для логирования на
стороне биржи. Этот атрибут может генерироваться системой автоматически,
но в таком случае нам будет тяжело отследить выполненный запрос при
разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением. |
Bearer | header | JWT токен | Да | Токен авторизации | Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token |
data | body | object | Да | Данные для получения списка заявок | |
orderState | body | string | Нет | Статус документа (заявки) | Параметр для фильтрации. В зависимости от указанного статуса в ответе возвращаются соответствующие заявки. Может принимать следующие значения:
|
orderType | body | string | Нет | Тип документа (заявки) | Параметр для фильтрации. В зависимости от указанного типа документа в ответе возвращаются соответствующие заявки. Может принимать следующие значения: ORDER_ASSIGNING_SM_LOGIN — Заявка на присвоение идентификатора (ФР, РД, РК) ORDER_CHANGE_SM_LOGIN — Заявка на изменение полномочий идентификатора (ФР, РД, РК) ORDER_CANCEL_SM_LOGIN — Заявка на аннулирование идентификатора (ФР, РД, РК) ORDER_ASSIGNING_SM_LOGIN_ISD — Заявка на присвоение ИСД идентификатора (ФР) ORDER_CHANGE_SM_LOGIN_ISD — Заявка на изменение ИСД идентификатора (ФР) ORDER_ASSIGNING_FX_LOGIN — Заявка на присвоение идентификатора (ВР) ORDER_CHANGE_FX_LOGIN — Заявка на изменение идентификатора (ВР) ORDER_CANCEL_FX_LOGIN — Заявка на аннулирование идентификатора (ВР) ORDER_ASSIGNING_FX_LOGIN_ISD — Заявка на присвоение ИСД (ВР) ORDER_CHANGE_FX_LOGIN_ISD — Заявка на изменение ИСД (ВР) ORDER_PASSWORD_RESET_ONLINE — Сбросить пароль для идентификаторов ORDER_ASSIGNING_FO_LOGIN — Заявка на присвоение идентификатора (СР) ORDER_CHANGE_FO_LOGIN — Заявка на изменение идентификатора (СР) ORDER_CANCEL_FO_LOGIN — Заявка на аннулирование идентификатора (СР) ORDER_ASSIGNING_FO_LOGIN_ISD — Заявка на присвоение ИСД (СР) |
ORDER_CHANGE_FO_LOGIN_ISD — Заявка на изменение ИСД (СР) ORDER_ASSIGNING_MO_LOGIN — Заявка на присвоение идентификатора (ДР) ORDER_CHANGE_MO_LOGIN — Заявка на изменение идентификатора (ДР) ORDER_CANCEL_MO_LOGIN — Заявка на аннулирование Значение code из справочника OrderType в ответе GET /lk/lku/{orgId}/login/management/external/dictionaries/logins Получить справочники сервиса заявок Может быть null |
|||||
beginDate | body | string (date) | Нет | Дата начала отправки документа (заявки) | Формат даты YYYY-MM-DD Пример значения: "2024-11-02" может быть null |
endDate | body | string (date) | Нет | Дата окончания отправки документа (заявки) | Формат даты YYYY-MM-DD Пример значения: "2024-11-02" может быть null |
sort | body | object | Нет | Объект с параметрами сортировки | |
key | body | string | Нет | Название свойства, по которому будет осуществляться сортировка | Может быть null |
direction | body | integer/string | Нет | Направление сортировки | Может принимать следующие значения: ASC - сортирует от меньших значений к большим |
search | body | string | Нет | Поиск по названию | Может быть null |
{
"data": {
"orderType": "ORDER_ASSIGNING_SM_LOGIN",
"orderState": "InWork",
"beginDate": "2024-11-02",
"endDate": "2024-11-02",
"search": "1234",
"sort": {
"key": "updatedDate",
"direction": "DESC"
}
}
}
Параметр | Тип данных | Обязательность | Может быть null | Наименование | Пример значения |
---|---|---|---|---|---|
data | array | Нет | Да | Данные для получения списка заявок (ответ) | |
id | string (uuid) | Нет | Нет | Идентификатор | |
startDate | string | Нет | Да | Дата отправки документа | "06.12.2024 17:14:23" |
orderNumber | string | Нет | Да | Номер заявки | "orderNumber": "4588" |
contactNumber | string | Нет | Да | Номер контактного лица | |
contactName | string | Нет | Да | Контактное лицо, ФИО | "contactName": "Иванов Иван Иванович" |
contactPhone | string | Нет | Да | Номер телефона контактного лица | "contactPhone": "+79661111111" |
contactEmail | string | Нет | Да | Email контактного лица | "contactEmail": "test@test.ts" |
attachments | array [object] | Нет | Да | Загружаемые файлы в NUXEO | |
nuxeoId | string (uuid) | Нет | Нет | UUID файла в NUXEO | "nuxeoId": "2eeed15d-ce3f-476e-bbe5-7e26d1372bfe" |
fileName | string | Нет | Да | Наименование файла | "fileName": "OrderLogins_2024-12-17_19:09:12.json.p7s" |
isSigned | boolean | Нет | Нет | Признак подписания документа | "isSigned": true |
surname | string | Нет | Да | Фамилия представителя - Участника торгов/клиринга | "surname": "Иванов" |
firstName | string | Нет | Да | Имя представителя - Участника торгов/клиринга | "firstName": "Иван" |
patronymicName | string | Нет | Да | Отчество представителя - Участника торгов/клиринга | "patronymicName": "Иванович" |
numberLogins | integer | Нет | Да | Количество идентификаторов | "numberLogins": 5 |
login | object | Нет | Нет | Идентификатор | |
.id | string | Нет | Да | "id"-Уникальный идентификатор записи в таблице AGENT | "id": "f2a1f045-7bba-4171-9a39-cbe3592e4c0f" |
.tsid | string | Нет | Да | Идентификатор технического доступа | "tsid": "MO008950265C" |
logins | array [object] | Нет | Да | Список идентификаторов | |
id | string | Нет | Да | "id"-Уникальный идентификатор записи в таблице AGENT | "id": "f2a1f045-7bba-4171-9a39-cbe3592e4c0f" |
tsid | string | Нет | Да | Идентификатор технического доступа | "tsid": "MO008950265C" |
stRestrOnGetBillPos | boolean | Нет | Да | Получение информации о позициях по счетам | "stRestrOnGetBillPos": true |
stRestrOnGetFirmResp | boolean | Нет | Да | Получение информации об обязательствах фирмы | "stRestrOnGetFirmResp": true |
groupNameAction | string | Нет | Да | Действие над полем "Наименование группы" | "groupNameAction": "ADD" |
groupName | string | Нет | Да | Наименование группы | "groupName": "TRADE_17" |
ipCltTechnicalCenter | array [string] | Нет | Да | IP-адрес CLT 1/CLT 2 сегмента | "ipCLTTechnicalCenter": "11.111.111.11", "22.222.222.22",
"33.333.333.33" |
actionIpCltTechnicalCenter | string | Нет | Да | Подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge | "actionIpCLTTechnicalCenter": "ADD" |
oooMBIp | array [string] | Нет | Да | IP-адрес VPN | "oooMBIp": "44.444.4.44" |
oooMBaction | string | Нет | Да | Действие для атрибута "VPN доступ" | "oooMBaction": "ADD" |
ipCltClosedNetwork | array [string] | Нет | Да | IP-адрес шлюза CLT 1 / CLT 2 сегмента или IP-адрес сегмента сети POP | "ipCLTClosedNetwork": "11.111.111.11", "22.222.222.22", "33.333.333.33" |
actionCltClosedNetwork | string | Нет | Да | Действие для атрибута "подключение терминала через Hosted ASTSBridge (Выделенный канал) /POP" | "actionCLTClosedNetwork": "ADD" |
ipAddrServerApp | array [string] | Нет | Да | IP-адрес машины, на которой установлено серверное приложение. | "ipAddrServerApp": "192.0.2.0/24", "198.51.100.0/24", "203.0.113.0/24" |
actionAddrServerApp | string | Нет | Да | Действие с IP-адресом машины, на которой установлено серверное приложение. | "actionAddrServerApp": "DELETE" |
actionAddrClientApp | string | Нет | Да | Действие с IP-адресом клиентского приложения | "actionAddrClientApp": "CHANGE" |
ipAddrClientApp | array [string] | Нет | Да | IP-адрес клиентского приложения | "ipAddrClientApp": "88.88.888.18", "88.88.888.19" |
orderTypeName | string | Нет | Да | Тип документа | "orderTypeName": "ORDER_ASSIGNING_SM_LOGIN" |
market | object | Нет | Рынок | ||
.id | integer | Нет | Нет | Идентификатор | "id": 22 |
.mnemocode | string | Нет | Да | Мнемокод | "mnemocode": "MRKT_MONEY_MARKET" |
isOnStockMarket | boolean | Нет | Да | Подключение к фондовому рынку | "isOnStockMarket": true |
isOnDepositMarket | boolean | Нет | Да | Подключение к рынку депозитов | "isOnDepositMarket": true |
signatory | string | Нет | Да | Подписант | "signatory": "Сотрудник 20" |
isCandidate | boolean | Нет | Да | Если участник – "Кандидат" | "isCandidate": false |
isOnCreditMarket | boolean | Нет | Да | Подключение к рынку кредитов | "isOnCreditMarket": true |
isOnMoneyCbrDepositMarket | boolean | Нет | Да | Депозиты Банка России | "isOnMoneyCbrDepositMarket": true |
isOnMoneyFtDepositMarket | boolean | Нет | Да | Депозиты ФК | "isOnMoneyFtDepositMarket": true |
isOnMDepositMarket | boolean | Нет | Да | М-Депозиты | " isOnMDepositMarket": true |
isOnMoneyFtRepoMarket | boolean | Нет | Да | РЕПО с ФК | "isOnMoneyFtRepoMarket": true |
nuxeoId | string (uuid) | Нет | Да | UUID файла в NUXEO | "nuxeoId": "2eeed15d-ce3f-476e-bbe5-7e26d1372bfe" |
docTypeMnemocode | string | Нет | Да | Мнемокод типа документа в Автобазе | "docTypeMnemocode": "DOCUMENT_TYPE_ID_COMMON" |
ldapName | object | Нет | Нет | Криптоимя сертификата | |
.id | integer | Нет | Нет | Идентификатор в ЕКБД | "id": 17044 |
.subject | string | Нет | Да | Криптоимя, содержащее различные атрибуты сертификата. | "subject": "INN=000000000000,OGRN=1111111111111,SNILS=22222222222,T=Специалист,CN=Сотрудник 69,OU=Департамент ИТ,O=ООО Торговая Компания,L=Москва,ST=77 г.Москва,C=RU" |
loginType | string | Нет | Да | Тип идентификатора | "loginType": "TRADING_30" |
clearingName | string | Нет | Да | Тип клиринговых полномочий | "clearingName": "OPERATOR_30" |
actionClearingName | string | Нет | Да | Изменение клиринговых полномочий | "actionClearingName": "ADD" |
masterLogin1 | object | Нет | Master-login (основной) | ||
.id | string | Нет | Да | "id"-Уникальный идентификатор | "id": "ffb685cf-b042-49ad-ac3a-7fa1a28d6255" |
.tsid | string | Нет | Да | Идентификатор технического доступа | "tsid": "MU0089549720" |
masterLogin2 | object | Нет | Master-login (резервный) | ||
.id | string | Нет | Да | "id"-Уникальный идентификатор | "id": "ff3b7418-0ad7-4d4c-81d7-c0d872be8018" |
.tsid | string | Нет | Да | Идентификатор технического доступа | "tsid": "MU008954347C" |
masterLogin2Action | string | Нет | Да | Действие над полем "Master-login (резервный)" | "masterLogin2Action": "DELETE" |
cancelOnDisconnect | boolean | Нет | Да | Сancel on disconnect | "cancelOnDisconnect": true |
cancelOnDropCopyDisconnect | boolean | Нет | Да | Сancel on Drop-Copy disconnect | "cancelOnDropCopyDisconnect": true |
hasRestrOnTradeMode | string | Нет | Да | Ограничение по режимам торгов на ФР | "hasRestrOnTradeMode": "HROTM_NONE" |
tcaRestrictionUseAll | string | Нет | Да | Ограничения по ТКС | "tcaRestrictionUseAll": "USE_ALL" |
tcaList | array [string] | Нет | Да | Перечень ТКС | "tcaList": "NB0253906230", "NB0253906228" |
stRestrOnGetAdrRequest | boolean | Нет | Да | Получение информации об адресных заявках для идентификаторов, ограничения по ТКС | "stRestrOnGetAdrRequest": true |
interfaceLanguage | string | Нет | Да | Язык интерфейса | "interfaceLanguage": "RUS" |
isIsdAdmin | boolean | Нет | Да | Администратор для ИСД | "isIsdAdmin": true |
expirationPassword | boolean | Нет | Да | Экспирация пароля | "expirationPassword": true |
connectionType | string | Нет | Да | Тип терминала | "connectionType": "VPTS" |
ctInternetAction | string | Нет | Да | Действие над "Прямое подключение терминала через Интернет" | "ctInternetAction": "CHANGE" |
ctInternet | boolean | Нет | Да | Способ подключения – прямое подключение терминала через Интернет | "ctInternet": true |
ctColocationDedicatedChannel | boolean | Нет | Да | Способ подключения – прямое подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge | "ctColocationDedicatedChannel": true |
ctVpn | boolean | Нет | Да | Способ подключения – VPN | "ctVPN": true |
ctDedicatedChannel | boolean | Нет | Да | Способ подключения – подключение терминала через Hosted ASTSBridge (Выделенный канал/POP) | "ctDedicatedChannel": true |
serverAppConnectVpts | string | Нет | Да | Серверное приложение для подключения ВПТС к ПТК Биржи | "serverAppConnectVPTS": "PERSONAL_ASTS_BRIDGE" |
actualAddrServerApp | string | Нет | Да | Адрес установки серверного приложения | "actualAddrServerApp": " Челябинск, 451930, ул. Домодедовская, д. 7" |
selectVpts | string | Нет | Да | ВПТС | "selectVPTS": "FAST_TRADE_NON_PUBLIC" |
alias | string | Нет | Да | Псевдоним | "alias": "Тест" |
aliasAction | string | Нет | Да | Действие над полем "Псевдоним" | "aliasAction": "DELETE" |
clientCodes | array [string] | Нет | Да | Перечень кодов клиентов, присвоенный брокером (ККК). | "clientCodes": "MD0033333160", "MD0022222160" |
newPasswordNeeded | boolean | Нет | Да | Сгенерировать новый пароль | "newPasswordNeeded": true |
idpUser | string | Нет | Да | IDP пользователь | "idpUser": "testmailaddress1111@test.ru" |
token | string | Нет | Да | Токен доступа | "token": "SAS1963" |
certificate | object | Нет | СКПЭП для КМП | ||
.id | integer | Нет | Нет | Идентификатор | "id": 16671 |
.subject | string | Нет | Да | Криптоимя, содержащее атрибуты сертификата. | "subject": "INN=333333333333,OGRN=0000000000000,SNILS=22222222222,T=Генеральный директор,CN=Сергеев Сергей Сергеевич,OU=Директорат,O=ООО \"Коммерческая Организация\",L=г.Москва,ST=77 г.Москва,C=RU,xxx=zzz" |
createdDate | string (date-time) | Нет | Нет | Дата создания заявки | "createdDate": "2024-11-02T09:24:27.35859" |
updatedDate | string | Нет | Да | Дата обновления | "updatedDate": "02.11.2024" |
state | string | Нет | Да | Статус заявки | "state": "ORDER_AUTHORITY_CONFIRMED_AWAITING" |
commentPs | string | Нет | Да | Комментарий к статусу заявки | |
endDate | string | Нет | Да | Дата исполнения заявки | "endDate": "24.12.2024" |
formType | string | Нет | Да | Признак/тип сохраняемой формы, используется в формах при "Присвоение ИСД ФР" / "Изменение ИСД ФР". | "formType": "extended" |
ntproInfo | object | Нет | Параметры для подключения к торговому FIX серверу "FIX-коннект" | ||
.senderCompId | string | Да | Нет | SenderCompID для подключения к торговому FIX серверу "FIX-коннект" | "senderCompId": "" |
.targetCompId | string | Да | Нет | TargetCompID для подключения к торговому FIX серверу "FIX-коннект" | "targetCompId": "" |
.password | string | Да | Нет | Пароль | "password": "password280424" |
.host | string | Да | Нет | Адрес подключения сервиса принципиала, ip-адрес сервера | "host": "111.111.111.11" pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b |
.port | integer | Да | Нет | Адрес подключения сервиса принципиала, номер порта | "port": 8080 |
allowGetClient | boolean | Нет | Да | Получение информации о клиентах | "allowGetClient": true |
allowGetCommission | boolean | Нет | Да | Получение информации о комиссиях | "allowGetCommission": true |
allowViewConsolidPositions | boolean | Нет | Да | Получение информации о консолидированных позициях | "allowViewConsolidPositions": true |
allowLpForRfsCu | string | Нет | Да | Полномочия Внебиржевых сделок на аукционе RFS | "allowLpForRfsCu": "PRODUCER" |
tradeConditions | array [object] | Нет | Да | Условия по режимам торгов и инструментам | |
boardGroupCode | string | Нет | Да | Код режима торгов | "boardGroupCode": "CETSN" |
deniedOnTradeMode | string | Нет | Да | Ограничения по режимам торгов | "deniedTradeMode": "SOME" |
allowedOnTradeMode | string | Нет | Да | Полномочия по режимам торгов | "allowedTradeMode": "CLOSE_MODE" |
instruments | array [object] | Нет | Да | Инструменты валютного рынка | |
.code | string | Нет | Да | Код инструмента | "code": "UCDEURTDTM" |
.baseCurrency | string | Да | Нет | Код валюты расчета инструмента | "baseCurrency": "UCD" |
.quoteCurrency | string | Нет | Да | Код сопряженной валюты расчета инструмента | "quoteCurrency": "EUR" |
.settlementCode | string | Да | Нет | Код исполнения (расчета) | "settlementCode": "T0T1" |
.settlementDate | string | Да | Нет | Дата расчетов по сделке или первой части сделки своп | "settlementDate": "2024-12-14" |
.farLegSettlementDate | string | Нет | Да | Дата расчетов второй части сделки своп | "farLegSettlementDate": "2024-12-15" |
.type | string | Да | Нет | Вид инструмента | "type": "SWAP" |
connectionTerminal | string | Нет | Да | Способ подключения: варианты прямого подключения, варианты подключения с использованием Hosted ASTSBridge |
"connectionTerminal": { "value": "DIRECT_CONNECT_OPTIONS", "name": "варианты прямого подключения" } |
nameVpts | string | Нет | Да | Название ВПТС | "nameVpts": { "value": "molot" } |
nameAuthorVpts | string | Нет | Да | Название компании разработчика ВПТС | "nameAuthorVpts": { "code": "MOLOT_NOT_PUBLIC" } |
allowLimitManage | boolean | Нет | Да | Управление лимитами брокерских фирм | "allowLimitManage": true |
allowClientRestrictions | boolean | Нет | Да | Управление ограничениями по клиентам | "allowClientRestrictions": true |
allowClientLimit | boolean | Нет | Да | Управление клиентскими лимитами | "allowClientLimit": true |
allowBidManage | boolean | Нет | Да | Управление заявками | "allowBidManage": true |
levelLogin | string | Нет | Да | Уровень | "levelLogin": "BASIC" |
performance | integer | Нет | Да | Производительность | "performance": 2 |
codeRf | string | Нет | Да | Код РФ (Идентификатор УК) | "codeRf": "U1" |
registerCode | string | Нет | Да | Ограничения по разделам | "registerCode": "u311000" |
ukUtForm | string | Нет | Да | Форма УК-УТ | "ukUtForm": "UT" |
allowedDealsAndOrders | string | Нет | Да | Потоки | "allowedDealsAndOrders": "TRANSACTIONS" |
ordersLog | boolean | Нет | Да | Получать полный журнал заявок | "ordersLog": true |
receiveAggRequestStreams | boolean | Нет | Да | Получать поток агрегированных заявок | "receiveAggRequestStreams": true |
allowBlockBrokerFee | boolean | Нет | Да | Управление блокировкой брокерской части клиентского сбора | "allowBlockBrokerFee": true |
allowDontCheckClientFunds | boolean | Нет | Да | Не проверять средства клиента | "allowDontCheckClientFunds": true |
ipFo | array [string] | Нет | Да | IP-адрес СР | "ipFo": "88.88.888.18", "88.88.888.19" |
ctIpFo | boolean | Нет | Да | Выбран один из способов подключения к Срочному рынку | "ctIpFo": true |
ipFoAction | string | Нет | Да | Действие над "Выбран один из способов подключения к Срочному рынку" | "ipFoAction": "ADD" |
packageOrderInfo | object | Нет | Объект, содержащий информацию о пакетах. | ||
.code | string | Нет | Да | Уникальный публичный идентификатор Пакета услуг | "packageOrderInfo.code": "1" |
.action | string | Нет | Да | Действие с идентификатором в пакете | "packageOrderInfo.action": "ADD" |
incomingNumber | string | Нет | Да | Входящий номер заявки | "incomingNumber": "000044" |
stateName | string | Нет | Да | Наименование статуса | "stateName": "В работе" |
cmpLoginOrderInfo | object | Нет | Объект, содержащий информацию "Действие с КМП" (ответ). | ||
surname | string | Нет | Да | Фамилия представителя - Участника торгов/клиринга | "surname": "Иванов" |
firstName | string | Нет | Да | Имя представителя - Участника торгов/клиринга | "firstName": "Иван" |
patronymicName | string | Нет | Да | Отчество представителя - Участника торгов/клиринга | "patronymicName": "Иванович" |
isOnStockMarket | boolean | Нет | Да | Подключение к фондовому рынку | "isOnStockMarket": true |
isOnDepositMarket | boolean | Нет | Да | Подключение к рынку депозитов | "isOnDepositMarket": true |
isOnCreditMarket | boolean | Нет | Да | Подключение к рынку кредитов | "isOnCreditMarket": true |
cmpAction | string | Нет | Да | Действие с КМП | "cmpAction": "ADD" |
idpUser | string | Нет | Да | IDP пользователь | "idpUser": " iii@company.ru " |
token | string | Нет | Да | Токен доступа | "token": "SAS1963" |
certificate | object | Нет | СКПЭП для КМП | ||
.id | integer | Нет | Нет | Идентификатор | "id": 15272 |
.subject | string | Нет | Да | Криптоимя, содержащее атрибуты сертификата. | "subject":"INN=444444444444,OGRN=7777777777777,SNILS=33333333333,T=Бухгалтер по ценным бумагам,CN=Алексеев Алексей Алексеевич,OU=Отдел финансового учета торговых операций,O=ООО \"Коммерческая Организация\",L=г.Москва,ST=77 г.Москва,C=RU" |
login | object | Нет | Идентификатор | ||
.id | string | Нет | Да | "id"-Уникальный идентификатор | "id": "f2a1f045-7bba-4171-9a39-cbe3592e4c0f" |
.tsid | string | Нет | Да | Идентификатор технического доступа | "tsid": "MO008950265C" |
paging | object | Нет | Информация о количестве записей и страниц с результатами поиска | ||
pageSize | integer | Нет | Размер страницы | ||
pageIndex | integer | Нет | Индекс страницы | ||
totalRecords | integer | Нет | Общее количество записей | ||
totalPages | integer | Нет | Всего страниц |
Получение документа (заявки) по уникальному идентификатору для просмотра данных по одной заявке.
Параметр |
Принадлежность |
Тип |
Обязательность |
Наименование |
Комментарий |
---|---|---|---|---|---|
orderId |
path |
string |
Да |
Идентификатор документа (заявки) |
Значение orderId из ответа метода /lk/lku/{orgId}/login/management/external/organizations/orders-linked/{loginId} |
orgId |
path |
string |
Да |
Идентификатор организации |
Значение orgId из ответа метода /lk/shared/permissions/scopes |
ClientRequestId |
header |
- |
Нет |
Идентификатор клиентского запроса |
Идентификатор запроса, который используется для логирования на
стороне биржи. |
Bearer |
header |
JWT токен |
Да |
Токен авторизации |
Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token |
Параметр | Тип данных | Обязательность | Может быть null | Наименование | Пример значения |
---|---|---|---|---|---|
data | object | нет | |||
id | string (uuid) | нет | нет | Идентификатор заявки | |
startDate | string | нет | да | Дата поступления документа | "startDate": "06.12.2024 17:14:23" |
orderNumber | string | нет | да | Номер заявки | "orderNumber": "4588" |
contactName | string | нет | да | Имя контактного лица | "contactName": "Иванов Иван Иванович" |
contactPhone | string | нет | да | Номер телефона контактного лица | "contactPhone": "+79661111111" |
contactEmail | string | нет | да | Email контактного лица | "contactEmail": "test@test.ts" |
attachments | array [object] | нет | да | Загружаемые файлы из ПС в NUXEO | |
nuxeoId | string (uuid) | нет | нет | Идентификатор файла nuxeo | "nuxeoId": "2eeed15d-ce3f-476e-bbe5-7e26d1372bfe" |
fileName | string | нет | да | Наименование файла | "fileName":"OrderLogins_2024-12-17_19:09:12.json.p7s" |
isSigned | boolean | нет | нет | Признак подписания документа | "isSigned": true |
surname | string | нет | да | Фамилия | "surname": "Иванов" |
firstName | string | нет | да | Имя | "firstName": "Иван" |
patronymicName | string | нет | да | Отчество | "patronymicName": "Иванович" |
numberLogins | integer | нет | да | Количество идентификаторов в заявке | "numberLogins": 5 |
login | object | нет | нет | Идентификатор | |
.id | string | нет | да | Уникальный идентификатор | "id": "f3f4db4f-2135-4bf5-b775-baa8b6cd3bdf" |
.tsid | string | нет | да | Идентификатор технического доступа | "tsid": "MU0089549277" |
logins | array [object] | нет | Список идентификаторов | ||
.id | string | нет | да | Уникальный идентификатор | "id": "f3f4db4f-2135-4bf5-b775-baa8b6cd3bdf" |
.tsid | string | нет | да | Идентификатор технического доступа | "tsid": "MU0089549277" |
stateName | string | нет | да | Наименование статуса | "stateName": "В работе" |
cmpLoginOrderInfo | object | нет | Объект, содержащий информацию "Действие с КМП". | ||
surname | string | нет | да | Фамилия представителя - Участника торгов/клиринга | "surname": "Иванов" |
firstName | string | нет | да | Имя представителя - Участника торгов/клиринга | "firstName": "Иван" |
patronymicName | string | нет | да | Отчество представителя - Участника торгов/клиринга | "patronymicName": "Иванович" |
isOnStockMarket | boolean | нет | да | Подключение к фондовому рынку | "isOnStockMarket": true |
isOnDepositMarket | boolean | нет | да | Подключение к рынку депозитов | "isOnDepositMarket": true |
isOnCreditMarket | boolean | нет | да | Подключение к рынку кредитов. | "isOnCreditMarket": true |
cmpAction | string | нет | да | Действие с КМП | "cmpAction": "ADD" |
idpUser | string | нет | да | IDP пользователь | "idpUser": "testmailaddress1111@test.ru" |
token | string | нет | да | Токен доступа | "token":"SAS1963" |
certificate | object | нет | СКПЭП для КМП | ||
.id | integer | нет | нет | Идентификатор | "id": 15272 |
.subject | string | нет | да | Криптоимя, содержащее атрибуты сертификата. | "subject": "INN=444444444444,OGRN=7777777777777,SNILS=33333333333,T=Бухгалтер по ценным бумагам,CN=Алексеев Алексей Алексеевич,OU=Отдел финансового учета торговых операций,O=ООО \"Коммерческая Организация\",L=г.Москва,ST=77 г.Москва,C=RU" |
stRestrOnGetBillPos | boolean | нет | да | Получение информации о позициях по счетам | "stRestrOnGetBillPos": true |
stRestrOnGetFirmResp | boolean | нет | да | Получение информации об обязательствах фирмы | "stRestrOnGetFirmResp": true |
groupNameAction | string | нет | да | Действие над полем "Наименование группы" | "groupNameAction": "ADD" |
groupName | string | нет | да | Наименование группы | "groupName": "TRADE_17" |
ipCltTechnicalCenter | array [string] | нет | да | IP-адрес CLT 1/CLT 2 сегмента | "ipCLTTechnicalCenter": "11.111.111.11", "22.222.222.22", "33.333.333.33" |
actionIpCltTechnicalCenter | string | нет | да | Подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge | "actionIpCLTTechnicalCenter": "ADD" |
oooMBIp | array [string] | нет | да | IP-адрес VPN | "oooMBIp": "44.444.4.44 |
oooMBaction | string | нет | да | Действие для атрибута "VPN доступ" | "oooMBaction": "ADD" |
ipCltClosedNetwork | array [string] | нет | да | IP-адрес шлюза CLT 1 / CLT 2 сегмента или IP адрес сегмента сети POP | "ipCLTClosedNetwork": "11.111.111.11", "22.222.222.22", "33.333.333.33" |
actionCltClosedNetwork | string | нет | да | Действие для атрибута "подключение терминала через Hosted ASTSBridge (Выделенный канал) /POP" | "actionCLTClosedNetwork": "ADD" |
ipAddrServerApp | array [string] | нет | да | IP-адрес машины, на которой установлено серверное приложение. | "ipAddrServerApp": "192.0.2.0/24", "198.51.100.0/24", "203.0.113.0/24" |
actionAddrServerApp | string | нет | да | Действие с IP-адресом машины, на которой установлено серверное приложение. | "actionAddrServerApp": "DELETE" |
actionAddrClientApp | string | нет | да | Действие с IP-адресом клиентского приложения | "actionAddrClientApp": "CHANGE" |
ipAddrClientApp | array [string] | нет | да | IP-адрес клиентского приложения | "ipAddrClientApp": "88.88.888.18", "88.88.888.19" |
orderTypeName | string | нет | да | Тип документа | "orderTypeName": "ORDER_ASSIGNING_FX_LOGIN" |
market | object | нет | Рынок | ||
.id | integer | нет | нет | Идентификатор | "id": 22 |
.mnemocode | string | нет | да | Мнемокод | "mnemocode": "MRKT_MONEY_MARKET" |
isOnStockMarket | boolean | нет | да | Подключение к фондовому рынку | "isOnStockMarket": true |
isOnDepositMarket | boolean | нет | да | Подключение к рынку депозитов | "isOnDepositMarket": true |
signatory | string | нет | да | Подписант | "signatory": "Сотрудник 20" |
isCandidate | boolean | нет | да | Если участник - "Кандидат" | "isCandidate": false |
isOnCreditMarket | boolean | нет | да | Подключение к рынку кредитов | "isOnCreditMarket": true |
isOnMoneyCbrDepositMarket | boolean | нет | да | Депозиты Банка России | "isOnMoneyCbrDepositMarket": true |
isOnMoneyFtDepositMarket | boolean | нет | да | Депозиты ФК | "isOnMoneyFtDepositMarket": true |
isOnMDepositMarket | boolean | нет | да | М-Депозиты | "isOnMDepositMarket": true |
isOnMoneyFtRepoMarket | boolean | нет | да | РЕПО с ФК | "isOnMoneyFtRepoMarket": true |
nuxeoId | string (uuid) | нет | да | uuid файла в системе NUXEO | "nuxeoId": "5e7a5a4a-b09f-4db0-9f95-3684a11183ca" |
docTypeMnemocode | string | нет | да | Мнемокод типа документа в Автобазе | "docTypeMnemocode": "DOCUMENT_TYPE_ID_COMMON" |
ldapName | object | нет | Криптоимя сертификата | ||
.id | integer | нет | нет | Идентификатор | "id": 17044 |
.subject | string | нет | да | Криптоимя, содержащее различные атрибуты сертификата. | "subject": "INN=000000000000,OGRN=1111111111111,SNILS=22222222222,T=Специалист,CN=Сотрудник 69,OU=Департамент ИТ,O=ООО Торговая Компания ,L=Москва,ST=77 г.Москва,C=RU" |
loginType | string | нет | да | Тип идентификатора | "loginType": "VIEWING_2" |
clearingName | string | нет | да | Тип клиринговых полномочий | "clearingName": "OPERATOR_1" |
actionClearingName | string | нет | да | Изменение клиринговых полномочий | "actionClearingName": "ADD" |
masterLogin1 | object | нет | Master-login (основной) | ||
.id | string | нет | да | "id"-Уникальный идентификатор | "id": "ffb685cf-b042-49ad-ac3a-7fa1a28d6255" |
.tsid | string | нет | да | Идентификатор технического доступа | "tsid": "MU0089549720" |
masterLogin2 | object | нет | Master-login (резервный) | ||
.id | string | нет | да | "id"-Уникальный идентификатор | "id": "ff3b7418-0ad7-4d4c-81d7-c0d872be8018" |
.tsid | string | нет | да | Идентификатор технического доступа | "tsid": "MU008954347C" |
masterLogin2Action | string | нет | да | Действие над полем Master-login (резервный) | "masterLogin2Action": "DELETE" |
cancelOnDisconnect | boolean | нет | да | Сancel on disconnect | "cancelOnDisconnect": true |
cancelOnDropCopyDisconnect | boolean | нет | да | Сancel on Drop-Copy disconnect | "cancelOnDropCopyDisconnect": true |
hasRestrOnTradeMode | string | нет | да | Ограничение по режимам торгов на ФР | "hasRestrOnTradeMode": "HROTM_NONE" |
tcaRestrictionUseAll | string | нет | да | Ограничения по ТКС | "tcaRestrictionUseAll": "USE_ALL" |
tcaList | array [string] | нет | да | Перечень ТКС | "tcaList": "L01x00000F31", "L01x00000F38" |
stRestrOnGetAdrRequest | boolean | нет | да | Получение информации об адресных заявках для идентификатора, ограничения по ТКС | "stRestrOnGetAdrRequest": true |
interfaceLanguage | string | нет | да | Язык интерфейса | "interfaceLanguage": "RUS" |
isIsdAdmin | boolean | нет | да | Администратор для ИСД | "isIsdAdmin": true |
expirationPassword | boolean | нет | да | Экспирация пароля | "expirationPassword": true |
connectionType | string | нет | да | Тип терминала | "connectionType": "VPTS" |
ctInternetAction | string | нет | да | Действие над "Прямое подключение терминала через Интернет" | "ctInternetAction": "CHANGE" |
ctInternet | boolean | нет | да | Способ подключения – прямое подключение терминала через Интернет |
"ctInternet": true |
ctColocationDedicatedChannel | boolean | нет | да | Способ подключения – прямое подключение через Выделенный канал, Colocation, шлюз Personal ASTSBridge | "ctColocationDedicatedChannel": true |
ctVpn | boolean | нет | да | Способ подключения – VPN | "ctVPN": true |
ctDedicatedChannel | boolean | нет | да | Способ подключения – подключение терминала через Hosted ASTSBridge (Выделенный канал/POP) | "ctDedicatedChannel": true |
serverAppConnectVpts | string | нет | да | Серверное приложение для подключения ВПТС к ПТК Биржи | "serverAppConnectVPTS": "PERSONAL_ASTS_BRIDGE" |
actualAddrServerApp | string | нет | да | Адрес установки серверного приложения | "actualAddrServerApp": "Челябинск, 451930, ул. Домодедовская, д. 7 " |
selectVpts | string | нет | да | ВПТС | "selectVPTS": "FAST_TRADE_NON_PUBLIC" |
alias | string | нет | да | Псевдоним | "alias": "Тест" |
aliasAction | string | нет | да | Действие над полем "Псевдоним" | "aliasAction": "DELETE" |
clientCodes | array [string] | нет | да | Код клиента, присвоенный брокером (ККК). | "clientCodes": "MD0033333160", "MD0022222160" |
newPasswordNeeded | boolean | нет | да | Сгенерировать новый пароль | "newPasswordNeeded": true |
idpUser | string | нет | да | IDP пользователь | "idpUser": "testmailaddress1111@test.ru" |
token | string | нет | да | Токен доступа | "token":"SAS1963" |
certificate | object | нет | СКПЭП для КМП | ||
.id | integer | нет | нет | Идентификатор | "id": 16671 |
.subject | string | нет | да | Криптоимя, содержащее атрибуты сертификата. | "subject": "INN=333333333333,OGRN=0000000000000,SNILS=22222222222,T=Генеральный директор,CN=Сергеев Сергей Сергеевич,OU=Директорат,O=ООО \"Коммерческая Организация\",L=г.Москва,ST=77 г.Москва,C=RU,xxx=zzz" |
createdDate | string (date-time) | нет | нет | Дата создания заявки | "createdDate": "2024-11-02T09:24:27.35859" |
updatedDate | string | нет | да | Дата обновления | "updatedDate": "02.11.2024" |
state | string | нет | да | Статус заявки | "state": "ORDER_AUTHORITY_CONFIRMED_AWAITING" |
commentPs | string | нет | да | Комментарий к статусу заявки | |
endDate | string | нет | да | Дата исполнения заявки | "endDate": "24.12.2024" |
formType | string | нет | да | Признак/тип сохраняемой формы, используется в формах при "Присвоение ИСД ФР" / "Изменение ИСД ФР". | "formType": "standart" |
ntproInfo | object | нет | Параметры для подключения к торговому FIX серверу "FIX-коннект" | ||
senderCompId | string | да | нет | SenderCompID для подключения к торговому FIX серверу "FIX-коннект" | "senderCompId": "" |
targetCompId | string | да | нет | TargetCompID для подключения к торговому FIX серверу "FIX-коннект" | "targetCompId": "" |
password | string | да | нет | Пароль | "password": "password280424" |
host | string | да | нет | Адрес подключения сервиса принципиала, ip-адрес сервера | "host": "111.111.111.11" pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b |
port | integer | да | нет | Адрес подключения сервиса принципиала, номер порта | "port": 8080 |
allowGetClient | boolean | нет | да | Получение информации о клиентах | "allowGetClient ": true |
allowGetCommission | boolean | нет | да | Получение информации о комиссиях | "allowGetCommission": true |
allowViewConsolidPositions | boolean | нет | да | Получение информации о консолидированных позициях | "allowViewConsolidPositions": true |
allowLpForRfsCu | string | нет | да | Полномочия Внебиржевых сделок на аукционе RFS | "allowLpForRfsCu": "PRODUCER" |
tradeConditions | array [object] | нет | да | Условия по режимам торгов и инструментам | |
boardGroupCode | string | нет | да | Код режима торгов | "boardGroupCode": "CETSN" |
deniedOnTradeMode | string | нет | да | Ограничения по режимам торгов | "deniedTradeMode": "SOME" |
allowedOnTradeMode | string | нет | да | Полномочия по режимам торгов | "allowedTradeMode": "CLOSE_MODE" |
instruments | array [object] | нет | да | Инструменты валютного рынка | |
code | string | нет | да | Код инструмента | "code": "UCDEURTDTM" |
baseCurrency | string | да | нет | Код валюты расчета инструмента | "baseCurrency": "UCD" |
quoteCurrency | string | нет | да | Код сопряженной валюты расчета инструмента | "quoteCurrency": "EUR" |
settlementCode | string | да | нет | Код исполнения (расчета) | "settlementCode": "T0T1" |
settlementDate | string | да | нет | Дата расчетов по сделке или первой части сделки своп | "settlementDate": "2024-12-14" |
farLegSettlementDate | string | нет | да | Дата расчетов второй части сделки своп | "farLegSettlementDate": "2024-12-15" |
type | string | да | нет | Вид инструмента | "type": "SWAP" |
connectionTerminal | string | нет | да | Способ подключения: варианты прямого подключения, варианты подключения с использованием Hosted ASTSBridge |
"connectionTerminal": { "value": "DIRECT_CONNECT_OPTIONS", "name": "варианты прямого подключения" } |
nameVpts | string | нет | да | Название ВПТС | "nameVpts": { "value":"molot" } |
nameAuthorVpts | string | нет | да | Название компании разработчика ВПТС | "nameAuthorVpts": { "code":"MOLOT_NOT_PUBLIC" } |
allowLimitManage | boolean | нет | да | Управление лимитами брокерских фирм | "allowLimitManage": true |
allowClientRestrictions | boolean | нет | да | Управление ограничениями по клиентам | "allowClientRestrictions": true |
allowClientLimit | boolean | нет | да | Управление клиентскими лимитами | "allowClientLimit": true |
allowBidManage | boolean | нет | да | Управление заявками | "allowBidManage": true |
levelLogin | string | нет | да | Уровень | "levelLogin": "BASIC" |
performance | integer | нет | да | Производительность | "performance": 2 |
codeRf | string | нет | да | Код РФ (Идентификатор УК) | "codeRf": "U1" |
registerCode | string | нет | да | Ограничения по разделам | "registerCode": " u311000" |
ukUtForm | string | нет | да | Форма УК-УТ | "ukUtForm": "UT" |
allowedDealsAndOrders | string | нет | да | Потоки | "allowedDealsAndOrders": "TRANSACTIONS" |
ordersLog | boolean | нет | да | Получать полный журнал заявок | "ordersLog": true |
receiveAggRequestStreams | boolean | нет | да | Получать поток агрегированных заявок | "receiveAggRequestStreams": true |
allowBlockBrokerFee | boolean | нет | да | Управление блокировкой брокерской части клиентского сбора | "allowBlockBrokerFee": true |
allowDontCheckClientFunds | boolean | нет | да | Не проверять средства клиента | "allowDontCheckClientFunds": true |
ipFo | array [string] | нет | да | IP-адрес СР | "ipFo": "88.88.888.18", "88.88.888.19" |
ctIpFo | boolean | нет | да | Выбран один из способов подключения в Срочному рынку | "ctIpFo": true |
ipFoAction | string | нет | да | Действие над "Выбран один из способов подключения в Срочному рынку " | "ipFoAction": "ADD" |
packageOrderInfo | object | нет | Объект, содержащий информацию о пакетах | ||
code | string | нет | да | Уникальный публичный идентификатор Пакета услуг | "packageOrderInfo.code": "1" |
action | string | нет | да | Действие с идентификатором в пакете | "packageOrderInfo.action": "ADD" |
incomingNumber | string | нет | да | Входящий номер заявки | "incomingNumber": "000044" |
Создание документа (заявки) на различные действия с идентификаторами, его проверка и получение на подпись: Как заполнить заявку методом POST.
Подписание и отправка документа (заявки), отрабатывает после метода POST /lk/lku/{orgId}/login/management/external/orders/{orderFormType}.
Параметр | Принадлежность | Тип | Обязательность | Наименование | Комментарий |
---|---|---|---|---|---|
orgId | path | string | Да | Идентификатор организации | Значение orgId из ответа метода /lk/shared/permissions/scopes |
ClientRequestId | header | - | Нет | Идентификатор клиентского запроса | Идентификатор запроса, который используется для логирования на
стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением. |
Bearer | header | JWT токен | Да | Токен авторизации | Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token |
data | body | object | да | Подписать и отправить документ (заявку) | |
file | Body | string | да | Подписанный файл Строка подписанного файла (Base64) |
"file":"MIIRkQYJKoZIhvcNAQcCoIIRgjCCEX4CAQExDjAMBggqhQMHAQECAgUAMIIFfAYPiBdCj4+CnN0YXJ0eHJlZgoxMDcyNjYKJSVFT0Y=" |
algorithmType | body | string | да | Тип алгоритма криптографии (GOST / RSA) | Тип сертификата электронной подписи gost = 1, (ГОСТ) rsa = 2 (RSA) |
requestId | body | string (uuid) | да | Идентификатор запроса для защиты от подмены | "requestId": "ea692f35-f47f-4bb3-bbc2-528c6333ff4c" |
Нет.