В документе приведены примеры запросов и ответов по получению информации об инвестициях клиента (вызовы POST /investment-applications, GET /investment-applications/{investmentApplicationId}, DELETE /investment-applications/{investmentApplicationId}, GET /investment-operations, GET /investment-assets и GET /investment-accounts).
Содержание (оглавление работает только по поиску):
Конечная точка позволяет инициировать Заявку на предложение по продукту.
Пример запроса
POST /investment-applications HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
x-idempotency-key: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8
Accept: application/json
Пример ответа
HTTP/1.1 201 Created
ETag: 7b6f56e9-3ac2-4bfe-9f1b-4a5c6d123456
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
x-jws-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
{
"Data": {
"InvestmentApplication": [
{
"productApplicationId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productApplicationStatus": "AwaitingAuthorisation",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
},
"ProductApplication": {
"allowMultiOffer": true,
"CustomerData": [
{
"leadId": "95791e79-0f2d-47de-a5e0-df034b28574a",
"PersonIdentification": {
"FullName": {
"lastName": "Иванов",
"firstName": "Иван",
"middleName": "Иванович"
},
"countryOfResidence": "RU",
"countryOfBirth": "RU",
"provinceOfBirth": "Ставропольский край",
"cityOfBirth": "Ставрополь",
"birthDate": "2001-06-05",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": 7728240240
}
],
"ContactDetails": {
"phoneNumber": "79251230000",
"mobileNumber": "79251230000",
"emailAddress": "support@example.ru",
"other": "Дополнительный контактная информация",
"SocialNetworks": [
{
"networkName": "VK",
"url": "https://messanger.example.ru",
"description": "Работает служба поддержки"
}
]
}
},
"RegistrationAddress": {
"addressType": "DeliveryTo",
"addressLine": [
"string"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"ResidenceAddress": {
"addressType": "DeliveryTo",
"addressLine": [
"string"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"PostalAddress": {
"addressType": "DeliveryTo",
"addressLine": [
"string"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"СurrentPassport": {
"serial": "4411",
"number": "111111",
"issueDate": "2010-02-02",
"issueAuthorityCode": "700-300",
"issueAuthorityName": "ОУФМС России по гор. Москва по району Останкинский"
},
"PreviousPassport": {
"serial": "4411",
"number": "111111",
"issueDate": "2010-02-02",
"issueAuthorityCode": "700-300",
"issueAuthorityName": "ОУФМС России по гор. Москва по району Останкинский"
},
"ConsentInformations": [
{
"consentFlag": true,
"consentStartDate": "2023-06-05",
"consentFile": "Согласие + хешкод"
}
],
"PersonDocuments": [
{
"type": "Personal",
"customerDocumentSource": "CustomerUpload",
"comments": [
"Комментарии к документу"
],
"DocumentFiles": [
{
"documentName": "Паспорт",
"fileName": "string",
"contentType": "PDF",
"content": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0"
}
]
}
],
"PublicOfficialApplication": {
"PublicOfficialData": {
"type": "Russian",
"position": "string",
"employerFullName": "string",
"EmployerAddress": {
"administrationZone": "45388000",
"fias": "b6ebd656-af80-43ea-a8c0-33e19ffd5d22",
"PostalAddress": {
"addressType": "Postal",
"addressLine": [
"Россия, Москва, 117000, ул. Строителей, д. 40"
]
},
"Geolocation": {
"GeographicCoordinates": {
"latitude": 37.592206,
"longitude": 55.751206
}
}
}
},
"PublicOfficialRelationData": {
"Relation2PublicOfficial": [
{
"relationStatus": "FamilyInLaw",
"relativeFullName": "string",
"PublicOfficialData": {
"type": "Russian",
"position": "string",
"employerFullName": "string",
"EmployerAddress": {
"administrationZone": "45388000",
"fias": "b6ebd656-af80-43ea-a8c0-33e19ffd5d22",
"PostalAddress": {
"addressType": "Postal",
"addressLine": [
"Россия, Москва, 117000, ул. Строителей, д. 40"
]
},
"Geolocation": {
"GeographicCoordinates": {
"latitude": 37.592206,
"longitude": 55.751206
}
}
}
}
}
]
},
"financialPosition": "string",
"bankruptStatus": true,
"reputationInfo": "string",
"relationPurpose": "string",
"sourceOfFunds": [
"BorrowedFunds"
]
}
}
]
}
}
]
},
"Links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
},
"Meta": {
"totalPages": 0
}
}
Конечная точка позволяет получить информацию о Заявке на предложениe по продукту по идентификатору.
Пример запроса
Передается investmentApplicationId в path параметрах.
GET /investment-applications/{APPLICATION-01-df034b28574a} HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Accept: application/json
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json
{
"Data": {
"InvestmentApplication": [
{
"productApplicationId": "OFFER-01-df034b28574a",
"creationDateTime": "2019-08-24T14:15:22Z",
"productApplicationStatus": "AwaitingAuthorisation",
"statusUpdateDateTime": "2019-08-24T14:15:22Z",
"StatusReasonInformation": {
"reason": "Cancelled",
"additionalInformation": "Повторное обращение",
"comments": [
"Информация для клиента"
]
},
"ProductApplication": {
"allowMultiOffer": true,
"CustomerData": [
{
"leadId": "95791e79-0f2d-47de-a5e0-df034b28574a",
"PersonIdentification": {
"FullName": {
"lastName": "Иванов",
"firstName": "Иван",
"middleName": "Иванович"
},
"countryOfResidence": "RU",
"countryOfBirth": "RU",
"provinceOfBirth": "Ставропольский край",
"cityOfBirth": "Ставрополь",
"birthDate": "2001-06-05",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": 7728240240
}
],
"ContactDetails": {
"phoneNumber": "79251230000",
"mobileNumber": "79251230000",
"emailAddress": "support@example.ru",
"other": "Дополнительный контактная информация",
"SocialNetworks": [
{
"networkName": "VK",
"url": "https://messanger.example.ru",
"description": "Работает служба поддержки"
}
]
}
},
"RegistrationAddress": {
"addressType": "DeliveryTo",
"addressLine": [
"string"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"ResidenceAddress": {
"addressType": "DeliveryTo",
"addressLine": [
"string"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"PostalAddress": {
"addressType": "DeliveryTo",
"addressLine": [
"string"
],
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
},
"СurrentPassport": {
"serial": "4411",
"number": "111111",
"issueDate": "2010-02-02",
"issueAuthorityCode": "700-300",
"issueAuthorityName": "ОУФМС России по гор. Москва по району Останкинский"
},
"PreviousPassport": {
"serial": "4411",
"number": "111111",
"issueDate": "2010-02-02",
"issueAuthorityCode": "700-300",
"issueAuthorityName": "ОУФМС России по гор. Москва по району Останкинский"
},
"ConsentInformations": [
{
"consentFlag": true,
"consentStartDate": "2023-06-05",
"consentFile": "Согласие + хешкод"
}
],
"PersonDocuments": [
{
"type": "Personal",
"customerDocumentSource": "CustomerUpload",
"comments": [
"Комментарии к документу"
],
"DocumentFiles": [
{
"documentName": "Паспорт",
"fileName": "string",
"contentType": "PDF",
"content": "0LTQu9GPINC60L7QtNC40YDQvtCQWERFBddU8y0LDQvdC40Y8g0LIgYmFzZTY0"
}
]
}
],
"PublicOfficialApplication": {
"PublicOfficialData": {
"type": "Russian",
"position": "string",
"employerFullName": "string",
"EmployerAddress": {
"administrationZone": "45388000",
"fias": "b6ebd656-af80-43ea-a8c0-33e19ffd5d22",
"PostalAddress": {
"addressType": "Postal",
"addressLine": [
"Россия, Москва, 117000, ул. Строителей, д. 40"
]
},
"Geolocation": {
"GeographicCoordinates": {
"latitude": 37.592206,
"longitude": 55.751206
}
}
}
},
"PublicOfficialRelationData": {
"Relation2PublicOfficial": [
{
"relationStatus": "FamilyInLaw",
"relativeFullName": "string",
"PublicOfficialData": {
"type": "Russian",
"position": "string",
"employerFullName": "string",
"EmployerAddress": {
"administrationZone": "45388000",
"fias": "b6ebd656-af80-43ea-a8c0-33e19ffd5d22",
"PostalAddress": {
"addressType": "Postal",
"addressLine": [
"Россия, Москва, 117000, ул. Строителей, д. 40"
]
},
"Geolocation": {
"GeographicCoordinates": {
"latitude": 37.592206,
"longitude": 55.751206
}
}
}
}
}
]
},
"financialPosition": "string",
"bankruptStatus": true,
"reputationInfo": "string",
"relationPurpose": "string",
"sourceOfFunds": [
"BorrowedFunds"
]
}
}
]
}
}
]
},
"Links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
},
"Meta": {
"totalPages": 0
}
}
Конечная точка позволяет удалять ресурс Заявки на предложение по продукту.
Пример запроса
Передается investmentApplicationId в path параметрах.
DELETE /investment-applications/{APPLICATION-01-df034b28574a} HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Accept: application/json
Пример ответа
HTTP/1.1 204 No Content
x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d
Конечная точка позволяет получить информацию об операциях по брокерскому счету клиента.
Пример запроса
(Для первого запроса заголовок If-None-Match будет отсутствовать, поскольку ETag для этого ресурса ещё не создан.
Для остальных запросов можно использовать заголовки If-Modified-Since и If-None-Match совместно или раздельно.
В данном примере допускаем, что произошло обновление данных. ETag в ответе не совпадает с заголовком If-None-Match).
GET /investment-operations 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": {
"InvestmentOperation": [
{
"operationType": "Purchase",
"dateTime": "2021-06-05T15:15:13+00:00",
"isin": "RU0007661625",
"assetType": "Stock",
"tiker": "MGNT",
"OperationAmount": {
"amount": "200.00",
"currency": "RUB"
},
"OperationPrice": {
"amount": "200.00",
"currency": "RUB"
},
"amount": "1000"
}
]
},
"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-assets 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": {
"InvestmentAsset": [
{
"assetId": "022eaab4-568b-4635-a5fb-fe91153e6cd6",
"assetName": "МойФинансовыйИнструмент",
"isin": "RU0007661625",
"assetType": "Stock",
"depositary": "НКО АО «Национальный расчетный депозитарий»",
"assetStatus": "Blocked",
"tiker": "MGNT",
"amount": "1000",
"AssetAmount": {
"amount": "200.00",
"currency": "RUB"
},
"AssetAmountCurrency": {
"amount": "1000.00",
"currency": "EUR"
}
}
]
},
"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-accounts 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": {
"InvestmentAccount": [
{
"partyId": "022eaab4-568b-4635-a5fb-fe91153e6cd6",
"status": true,
"test": [
"Пример 1",
"Пример 2"
],
"residenceRF": true,
"partyType": "Individual",
"BrokerageAccountInfo": {
"BrokerAccount": {
"name": "Брокерский счет",
"schemeName": "RU.CBR.BBAN",
"identification": "30101810400000000123"
},
"accountStatus": "Active"
},
"investmentType": "BrokerAccount",
"marginalTrade": true,
"PortfolioValue": {
"amount": "200.00",
"currency": "RUB"
},
"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": "Описание применения кода"
}
]
}
]
}
]
}
],
"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
}
}