В документе приведены примеры запросов и ответов по получению информации об инвестиционной организации и её продуктах (вызовы GET /investment-organizations, GET /investment-branches, GET /investment-products и GET /investment-products/{investmentProductId}).
Содержание:
Конечная точка позволяет получить список всех подразделений, принадлежащих инвестиционной организации.
Пример запроса
(Для первого запроса заголовок If-None-Match будет отсутствовать, поскольку ETag для этого ресурса ещё не создан.
Для остальных запросов можно использовать заголовки If-Modified-Since и If-None-Match совместно или раздельно.
В данном примере допускаем, что произошло обновление данных. ETag в ответе не совпадает с заголовком If-None-Match).
GET /investment-organizations HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-fapi-customer-ip-address: 104.25.212.99
x-customer-user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36
if-modified-since: 2023-08-23T12:34:56Z
if-none-match: 34dc78d2-12ab-4567-89cd-ef1234567890
Accept: application/json
Пример ответа
HTTP/1.1 200 OK
ETag: 7b6f56e9-3ac2-4bfe-9f1b-4a5c6d123456
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
x-jws-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
{
"Data": {
"InvestmentOrganization": [
{
"investmentOrganizationId": "538dde51-7e38-47f4-beae-338b4169254e",
"investmentName": "Публичное акционерное общество «МояИнвестиционная организация России»",
"investmentNameEng": "Public Joint Stock Company «MyInvestment of Russia»",
"shortInvestmentName": "ПАО «МояИнвестиционная компания»",
"shortInvestmentNameEng": "PJSC «MyInvestment»",
"Brand": {
"brandName": "МояИнвестиционнаяГрупп",
"logoURL": "https://www.myinvestment.ru/logo"
},
"investmentTypes": "Брокерская деятельность",
"BrokerServices": {
"stockExchangeAccess": "MoscowExchange",
"instrumentGroups": "RussianShares",
"otherInstruments": "Опционы",
"сonversionCurrencies": "KZT",
"сreditingCurrencies": "RUB",
"withdrawalCurrencies": "RUB"
},
"BrokerServicesAdditional": {
"investorServices": "- Участие в корпоративных событиях за инвестора - Кредитование под залог активов на БС - Подача налоговых деклараций по ИИС за инвесторов - Индивидуальные налоговые сервисы",
"iisPossibility": true,
"tradeTerminal": [
"Quik"
]
},
"License": [
{
"documentDescription": "Генеральная лицензия инвестиционной компании России на осуществление инвестиционной деятельности",
"documentDate": "2019-08-24",
"documentNumber": "1481"
}
],
"InvestmentDetails": {
"Account": {
"name": "Основной счет",
"schemeName": "RU.CBR.BBAN",
"identification": 40817810621234570000
},
"Agent": {
"schemeName": "RU.CBR.BIC",
"identification": 9612123
},
"AgentAccount": {
"name": "Кор. счет г. Москва",
"schemeName": "RU.CBR.BBAN",
"identification": "30101810400000000123"
},
"IdentificationCodes": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240000"
},
{
"schemeName": "RU.CBR.OGRN",
"identification": "1027700130000"
}
],
"registrationNumber": "1027739049689",
"registrationDate": "2019-08-24"
},
"AddressAndContactInformation": {
"LegalAdress": {
"addressType": "Business",
"addressLine": [
"Москва, 117000, ул. Садовая, д. 12"
]
},
"PostalAddress": {
"addressType": "Postal",
"addressLine": [
"Россия, Москва, 117000, ул. Строителей, д. 40"
]
},
"ContactDetails": {
"phoneNumber": "79251230000",
"emailAddress": "support@example.ru",
"chiefName": "Фамилия Имя Отчество",
"baseUrl": [
"www.myinvestment.ru",
"www.myinvestment.com"
]
}
},
"mobileApp": true,
"stateParticipation": false,
"socialMediaAccount": false,
"onlineSupport": false,
"investConsultants": {
"ogrnip": "31686170013322",
"consultantName": "Фамилия Имя Отчество",
"consultantAddress": "Москва, 127000, ул. Абрикосовая, д. 7"
}
}
]
},
"Links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
},
"Meta": {
"totalPages": 0
}
}
Конечная точка позволяет получить список всех подразделений и офисов, принадлежащих инвестиционной организации.
Пример запроса
(Для первого запроса заголовок If-None-Match будет отсутствовать, поскольку ETag для этого ресурса ещё не создан.
Для остальных запросов можно использовать заголовки If-Modified-Since и If-None-Match совместно или раздельно.
В данном примере допускаем, что произошло обновление данных. ETag в ответе не совпадает с заголовком If-None-Match).
GET /investment-branches HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-fapi-customer-ip-address: 104.25.212.99
x-customer-user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36
if-modified-since: 2023-08-23T12:34:56Z
if-none-match: 34dc78d2-12ab-4567-89cd-ef1234567890
Accept: application/json
Пример ответа
HTTP/1.1 200 OK
ETag: 7b6f56e9-3ac2-4bfe-9f1b-4a5c6d123456
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
x-jws-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
{
"Data": {
"InvestmentBranch": [
{
"investmentBranchId": "this-is-a-123-format-branch-id",
"investmentBranchName": "Общество с ограниченной ответственностью «Моя инвестиционная организация России» отделение «Восточное»",
"AddressAndLocation": {
"administrationZone": "45388000",
"fias": "b6ebd656-af80-43ea-a8c0-33e19ffd5d22",
"PostalAddress": {
"addressType": "Postal",
"addressLine": [
"Россия, Москва, 117000, ул. Строителей, д. 40"
]
},
"Geolocation": {
"GeographicCoordinates": {
"latitude": 37.592206,
"longitude": 55.751206
}
}
},
"IdentificationCode": [
{
"schemeName": "RU.CBR.OKPO",
"identification": "00012345"
}
],
"branchType": "representative",
"AccessibilityItem": [
{
"type": "Braille",
"description": "Шрифт Брайля"
},
{
"type": "AutomaticDoors",
"description": "Автоматические двери"
},
{
"type": "WheelchairAccess",
"description": "Доступность для инвалидных колясок"
},
{
"type": "SignLanguageInterpreter",
"description": "Возможность получить помощь сурдопереводчика"
}
],
"InvestmentServices": [
{
"serviceCode": "6712010",
"name": "string",
"segment": "Individual",
"dateTime": "2021-06-05T15:15:13+00:00",
"currentStatus": "Active",
"description": "string",
"url": "string"
}
],
"Information": {
"segment": [
"Business",
"Individual"
],
"Availability": {
"access24Hours": false,
"isRestricted": false,
"sameAsOrganization": false,
"temporarilyUnavailable": true,
"description": "Дополнительная информация о работе объекта",
"StandardAvailability": {
"Day": [
{
"dayCode": "01",
"openingTime": "09:00:00+0300",
"closingTime": "19:00:00+0300",
"BreakTime": [
{
"breakFromTime": "13:00:00+0300",
"breakToTime": "14:00:00+0300"
}
]
}
]
},
"NonStandardAvailability": [
{
"name": "Ограничение в связи с праздником",
"fromDate": "2022-12-30",
"toDate": "2023-01-03",
"description": "В период ограничения клиенты могут обращаться в единую службу поддержки",
"Day": [
{
"dayCode": "01",
"openingTime": "09:00:00+0300",
"closingTime": "19:00:00+0300",
"BreakTime": [
{
"breakFromTime": "13:00:00+0300",
"breakToTime": "14:00:00+0300"
}
]
}
]
}
]
},
"Rating": {
"grade": "4.50",
"max": "5"
},
"numberOfEmployees": "12",
"ContactDetails": [
{
"phoneNumber": "79251230000",
"mobileNumber": "79251230000",
"emailAddress": "support@example.ru",
"other": "Дополнительный контактная информация",
"SocialNetworks": [
{
"networkName": "VK",
"url": "https://messanger.example.ru",
"description": "Работает служба поддержки"
}
]
}
]
}
}
]
},
"Links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
},
"Meta": {
"totalPages": 0
}
}
Конечная точка позволяет получить краткую информацию о инвестиционных продуктах, включая их идентификаторы.
Пример запроса
(Для первого запроса заголовок If-None-Match будет отсутствовать, поскольку ETag для этого ресурса ещё не создан.
Для остальных запросов можно использовать заголовки If-Modified-Since и If-None-Match совместно или раздельно.
В данном примере допускаем, что произошло обновление данных. ETag в ответе не совпадает с заголовком If-None-Match).
GET /investment-products HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-fapi-customer-ip-address: 104.25.212.99
x-customer-user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36
if-modified-since: 2023-08-23T12:34:56Z
if-none-match: 34dc78d2-12ab-4567-89cd-ef1234567890
Accept: application/json
Пример ответа
HTTP/1.1 200 OK
ETag: 7b6f56e9-3ac2-4bfe-9f1b-4a5c6d123456
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
x-jws-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
{
"Data": {
"InvestmentProduct": [
{
"productId": "022eaab4-568b-4635-a5fb-fe91153e6cd6",
"productName": "МойПродукт",
"investmentType": "BrokerAccount",
"productVersion": "13.201.001-rls",
"Brand": {
"brandName": "МойБанкГрупп",
"applicationUri": "https://mybank.ru/products/credit-card/applay"
},
"BrokerServices": {
"stockExchangeAccess": "MoscowExchange",
"instrumentGroups": "RussianShares",
"otherInstruments": "Опционы",
"сonversionCurrencies": "KZT",
"сreditingCurrencies": "RUB",
"withdrawalCurrencies": "RUB"
},
"FeatureAndBenefit": [
{
"FeatureAndBenefitGroup": [
{
"name": "Возможность досрочного погашения",
"type": "EarlySettlement",
"comments": [
"Информация для клиента"
],
"benefitGroupNominalValue": "200.00",
"fee": "200.00",
"applicationFrequency": "Monthly",
"OtherApplicationFrequency": {
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
},
"calculationFrequency": "Monthly",
"OtherCalculationFrequency": {
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
},
"OtherType": {
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
},
"FeatureAndBenefitItem": [
{
"identification": "14ee9bcb-ce8d-407d-b377-d7663c586f73",
"type": "EarlySettlement",
"name": "Возможность досрочного погашения",
"comments": [
"Информация для клиента"
],
"amount": "10000.00",
"indicator": true,
"textual": "Скидка 10% на билеты в кино по вторникам вечером",
"OtherType": {
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
},
"FeatureBenefitEligibility": [
{
"name": "Наименование, указанное для критериев приемлемости",
"description": "Полное описание критериев приемлемости",
"type": "NewCustomersOnly",
"comments": [
"Информация для клиента"
],
"amount": "199.99",
"indicator": false,
"textual": "Любые критерии приемлемости с подробным описанием",
"period": "Month",
"OtherEligibilityType": [
{
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
}
]
}
]
}
],
"FeatureBenefitEligibility": [
{
"name": "Наименование, указанное для критериев приемлемости",
"description": "Полное описание критериев приемлемости",
"type": "NewCustomersOnly",
"comments": [
"Информация для клиента"
],
"amount": "199.99",
"indicator": false,
"textual": "Любые критерии приемлемости с подробным описанием",
"period": "Month",
"OtherEligibilityType": [
{
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
}
]
}
]
}
],
"FeatureAndBenefitItem": [
{
"identification": "14ee9bcb-ce8d-407d-b377-d7663c586f73",
"type": "EarlySettlement",
"name": "Возможность досрочного погашения",
"comments": [
"Информация для клиента"
],
"amount": "10000.00",
"indicator": true,
"textual": "Скидка 10% на билеты в кино по вторникам вечером",
"OtherType": {
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
},
"FeatureBenefitEligibility": [
{
"name": "Наименование, указанное для критериев приемлемости",
"description": "Полное описание критериев приемлемости",
"type": "NewCustomersOnly",
"comments": [
"Информация для клиента"
],
"amount": "199.99",
"indicator": false,
"textual": "Любые критерии приемлемости с подробным описанием",
"period": "Month",
"OtherEligibilityType": [
{
"code": "CODE",
"name": "Собственное наименование типа",
"description": "Описание применения кода"
}
]
}
]
}
]
}
]
}
]
},
"Links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
},
"Meta": {
"totalPages": 0
}
}
Конечная точка позволяет получить детальной информации о продукте по его идентификатору.
Пример запроса
(Для первого запроса заголовок If-None-Match будет отсутствовать, поскольку ETag для этого ресурса ещё не создан.
Для остальных запросов можно использовать заголовки If-Modified-Since и If-None-Match совместно или раздельно.
В данном примере допускаем, что произошло обновление данных. ETag в ответе не совпадает с заголовком If-None-Match.
Передается investmentProductId в path параметрах).
GET /investment-products/{022eaab4-568b-4635-a5fb-fe91153e6cd6} HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-fapi-customer-ip-address: 104.25.212.99
x-customer-user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36
if-modified-since: 2023-08-23T12:34:56Z
if-none-match: 34dc78d2-12ab-4567-89cd-ef1234567890
Пример ответа
HTTP/1.1 200 OK
ETag: 7b6f56e9-3ac2-4bfe-9f1b-4a5c6d123456
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
x-jws-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
{
"Data": {
"Product": {
"productId": "022eaab4-568b-4635-a5fb-fe91153e6cd6",
"productName": "МойПродукт",
"investmentType": "BrokerAccount",
"productVersion": "13.201.001-rls",
"Brand": {
"brandName": "МойБанкГрупп",
"applicationUri": "https://mybank.ru/products/credit-card/applay"
},
"BrokerServices": {
"stockExchangeAccess": "MoscowExchange",
"instrumentGroups": "RussianShares",
"otherInstruments": "Опционы",
"сonversionCurrencies": "KZT",
"сreditingCurrencies": "RUB",
"withdrawalCurrencies": "RUB"
},
"SupplementaryData": {}
}
},
"Links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
},
"Meta": {
"totalPages": 0
}
}