Api Tokenizer / Reference
TKEY7 API для Токенизатора
RESTful API для взаимодействия Токенизатора с TKEY7.
Version: 1.0.0
Получить Адрес счёта Участника
Возвращает Идентификатор учётной записи из распределённого реестра, соответствующий заданному идентификатору адресации Участника.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
addressing_identification | query | Идентификатор адресации. Идентификатор формируется из account_identification + * + country_code + member_identification + payments.tkey7.com . Пример: main*ru.bankName.payments.tkey7.com . | Нет | string |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Адрес счёта успешно получен. | digitalAccount |
400 | Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос. | error |
404 | Адрес счёта не найден. Пожалуйста, проверьте данные указанного Участника. | error |
Получить список всех Участников
Возвращает список всех активных Участников и связанные с ними данные. Информация об Участниках.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
country_code | query | Двухбуквенный код страны нахождения Участников, соответствующий стандарту ISO 3166-1. Пример: RU . | Нет | string |
asset_code_identification | query | Трёхбуквенный код актива, соответствующий стандарту ISO 4217. Пример: RUB . | Нет | string |
asset_issuer_identification | query | Идентификатор эмитента активов. Пример: issuerBankName . | Нет | string |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Список активных Участников получен. | [ memberInfo ] |
404 | Не найдено ни одного Участника. | error |
Получить сведения об Участнике по идентификатору
Возвращает сведения об Участнике по заданному идентификатору.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
member_identification | path | Идентификатор Участника. Пример: bankName . | Да | string |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Сведения об Участнике успешно получены. | memberInfo |
404 | Участник с таким идентификатором не найден. | error |
Получить список выпущенных Активов ЦРА
Возвращает список Активов ЦРА, выпущенных Токенизатором и зарегистрированных в TKEY7.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
tokenizer_identification | path | Идентификатор Токенизатора. Пример: tokenizerCentralBankName . | Да | string |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Список выпущенных активов успешно получен. | [ settlementInstrumentInfo ] |
401 | Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке. | error |
404 | Нет выпущенных активов в TKEY7. | error |
Изменить Кредитную линию
Изменяет состояние Кредитной линии по Активу ЦРА между Токенизатором и Участником. Информация о Кредитной линии.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
tokenizer_identification | path | Идентификатор Токенизатора. Пример: tokenizerBankName . | Да | string |
creditLine | body | Сведения для установления или изменения Кредитной линии между Токенизатором и Участником. | Да | creditLine |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Кредитная линия успешно изменена. | |
400 | Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос. Данный код ошибки возникает из-за отсутствия или недопустимых параметров в запросе. | error |
401 | Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке. | error |
404 | Не удалось изменить кредитную линию с Участником. Пожалуйста, проверьте корректность передаваемых сведений о кредитной линии. | error |
Создать инструкцию по Финансированию
Создаёт инструкцию по финансированию Участника Активами ЦРА. Информация о Финансировании. Сценарий — Запрос финансирования.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
fundingInfo | body | Сведения о Финансировании. | Да | fundingInfo |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Инструкция по финансированию Участника успешно создана. | instruction |
400 | Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос. Данный код ошибки возникает из-за отсутствия или недопустимых параметров в запросе. | error |
401 | Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке. | error |
404 | Запрос на создание инструкции не выполнен или указан недействительный Участник. | error |
Ответить на запрос выкупа ЦРА
Отправляет ответ на запрос Участника о выкупе ЦРА. Сценарий — Выкуп ЦРА.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
financialMessage | body | Уведомление о результатах обработки финансового сообщения. Подписанное XML-сообщение pacs.002 в кодировке base64. | Да | financialMessage |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Служебное сообщение pacs.002 подтипа 01 от TKEY7 успешно получено. | financialMessage |
404 | Произошла ошибка во время обработки ответа. | error |
Финансировать Участника
Пополняет Цифровой счёт Участника Активами ЦРА. Информация о Финансировании. Сценарий — Запрос финансирования.
Параметры
Наименование | Расположение | Описание | Обязательный | Разметка |
---|---|---|---|---|
fundingInfo | body | Сведения о Финансировании. | Да | fundingInfo |
funding_payload_signature | query | Подпись полезной нагрузки fundingInfo в кодировке base64. Пример: hWC4Q+asKbO9Hya3oWXW97mMDKlG/8X65jHzk7hYj2zTjG1BCqvsFLTmBAM++HW6N/sWzc30qb66sGdNbdfWDg== . | Да | string |
signed_funding_transaction | query | Подписанная транзакция с подписью Токенизатора на Финансирование в кодировке base64. Пример: AAAAAtAAAABGUPkCVt32XjAe+00rrbSAW7RxDmVWnB1iYGk5NMLC2AAAAGQAAAAAAAAAEQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAEZQ+QJW3fZeMB77TSuttIBbtHEOZVacHWJgaTk0wsLYAAAAAQAAAADS8Dlw7lPHuCkVfcXWwVxM3qher6nN6vCXpPJ5yxjR4gAAAAFSVUIAAAAAAEZQ+QJW3fZeMB77TSuttIBbtHEOZVacHWJgaTk0wsLYAABa8xB6QAAAAAAAAAAAATTCwtgAAABARogDHBBaAw8O9GCTIPElVIZOVCX78U3rgCxsureu8YAPezpLoHBY+0sVDlWuUaPSdIqrgOsQ2DFJggltENNtDQ== . | Да | string |
Ответ ←
Код HTTP | Описание | Разметка |
---|---|---|
200 | Участник успешно профинансирован. | fundingResult |
400 | Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос. | error |
401 | Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке. | error |
404 | Не удалось профинансировать Участника из-за ошибки получения подписи Токенизатора из внутреннего реестра участников. | error |
Модели
creditLine
Сведения о Кредитной линии.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
account_identification | string | Идентификатор Операционного счёта Участника, с которым будет установлена Кредитная линия по активу ЦРА. Пример: main . | Да |
asset_code_identification | string | Трёхбуквенный код актива, соответствующий стандарту ISO 4217. Пример: RUB . | Да |
credit_line_state | string | Параметр для изменения состояния Кредитной линии: allow (разрешить) или revoke (отозвать). | Да |
end_to_end_identification | string | Уникальный идентификатор, присвоенный Участником для однозначной идентификации запроса Кредитной линии. Пример: ac05c7d8f4406c971085f947e43ef730 . | Нет |
maximum_credit_limit | integer | Предел суммы актива ЦРА, которую Участник сможет удерживать после успешно установленной Кредитной линии с Токенизатором. Этот параметр не заполняется Токенизатором. | Нет |
member_identification | string | Идентификатор Участника, который запросил разрешение на Кредитную линию. Пример: bankName . | Да |
digitalAccount
Цифровой счёт Участника.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
distributed_ledger_account_address | string | Адрес счёта в Распределённом реестре. Пример: TACHSKJNU22MVJVOVOLWVTVHOGMF7IBGQUQTRGLSTDLZYIVQP7BBO7GX . | Да |
identification | string | Идентификатор Цифрового счёта. Для Эмиссионного счёта: emission , для Операционного счёта: main или другая строка, которая идентифицирует Операционный счёт, например: reserveAccount . | Нет |
error
Сведения об ошибке.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
build_version | string | Версия сборки службы. | Нет |
code | string | Код ошибки. | Нет |
endpoint_url | string | URL-адрес конечной точки, которая завершилась с ошибкой. | Нет |
long_message | string | Подробное описание возникшей ошибки. | Да |
member_identification | string | Идентификатор Участника. Пример: bankName . | Нет |
service_name | string | Название службы. | Нет |
short_message | string | Краткое описание сообщения об ошибке. | Да |
timestamp | number (int64) | Временная метка события. Пример: 1651224866578 . | Да |
troubleshooting_id | string | Идентификатор, указывающий на источник возникновения ошибки. | Нет |
financialMessage
Сведения о сообщении ISO 20022. Форматы сообщений MT
не поддерживаются, требуется преобразовать их в общепринятый стандарт финансовой индустрии ISO 20022
.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
financial_message_data | string | XML-сообщение в кодировке base64. | Нет |
financial_message_type | string | Тип XML-сообщения. Пример: isomsg20022:pacs.008.001.09 . | Да |
fundingInfo
Сведения о Финансировании.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
account_identification | string | Идентификатор Операционного счёта. По умолчанию main или другая строка, которая идентифицирует Операционный счёт, например: distributionAcct . | Нет |
end_to_end_identification | string | Уникальный идентификатор, присвоенный Токенизатором для однозначной идентификации запроса на Финансирование. Пример: c542f55b88270f25130b5e39bc243008 . | Да |
funding_amount | number (float64) | Сумма, на которую Токенизатор финансирует Участника. | Да |
issued_asset_code_identification | string | Идентификатор актива ЦРА. Пример: RUB . | Да |
member_identification | string | Идентификатор Участника, который получит Финансирование. Пример: bankName . | Да |
memo_transaction | string | Пометка для транзакции, присвоенная Токенизатором. Пример: FR-2832RUB . | Нет |
tokenizer_identification | string | Идентификатор Токенизатора. Пример: tokenizerBankName . | Да |
fundingResult
Квитанция о завершении транзакции.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
funding_payload | [ fundingInfo ] | Сведения о Финансировании. | Да |
funding_state | [ transactionState ] | Квитанция о завершении транзакции по Финансированию. | Да |
instruction
Инструкция по финансированию Участника.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
funding_payload | [ fundingInfo ] | Сведения о Финансировании. | Да |
unsigned_transaction_object | string | Неподписанная транзакция на Финансирование Участника в кодировке base64. Пример: AAAAAtAAAAAWezQAp2GGnfIm1nqbIdcB7D1+QywvsDE1eNVxLNQxPwAAAGQAAAAAAAAABwAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAABZ7NACnYYad8ibWepsh1wHsPX5DLC+wMTV41XEs1DE/AAAAAQAAAABkMXty5xTjRQWRClEfR8N0qoJV12N/zfnNS0Syp0bUTgAAAAFSVUIAAAAAAOKxrmVqSEDfjgo1KoxeqpBVk82UV/CTDCA+hyX8OHKDAABa8xB6QAAAAAAAAAAAAA== . | Да |
memberInfo
Сведения об Участнике.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
bicfi | string | Банковский идентификационный код Участника. Пример: XXXXRUMMXXX . | Да |
business_role | string | Бизнес-роль зарегистрированного Участника. Для Маркетмейкера MMM и MIS для Токенизатора. | Да |
country_code | string | Двухбуквенный код страны нахождения Участника, соответствующий стандарту ISO 3166-1. Пример: RU . | Да |
distributed_ledger_emission_account_address | string | Идентификатор учётной записи из распределённого реестра, соответствующий Эмиссионному счёту. Пример: TACHSKJNU22MVJVOVOLWVTVHOGMF7IBGQUQTRGLSTDLZYIVQP7BBO7GX . | Нет |
identification | string | Идентификатор Участника. Пример: bankName . | Да |
member_state | string | Статус Участника: created (создан), activated (активирован), blocked (заблокирован). | Нет |
operating_digital_accounts | [ digitalAccount ] | Операционные счета. | Нет |
settlementInstrumentInfo
Сведения об Активе.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
asset_code_identification | string | Группа актива: DSO — ЦРО или DSA — ЦРА. | Да |
asset_group_identification | string | Трёхбуквенный код актива, соответствующий стандарту ISO 4217 для ЦРА, например, RUB и шестибуквенный код актива для ЦРО, например, RUBDSO . | Да |
asset_issuer_identification | string | Идентификатор эмитента актива. Пример: issuerBankName . | Нет |
transactionState
Квитанция о завершении транзакции.
Наименование | Тип | Описание | Обязательный |
---|---|---|---|
timestamp | number (int64) | Временная метка транзакции. Пример: 1651222986384 . | Да |
transaction_flow_status | string | Статус транзакции в жизненном цикле платежа, например, Payment cleared (Платёж проведён), Payment settled (Платёж урегулирован). | Да |
transaction_identification | string | Уникальный идентификатор транзакции, который является хеш-значением в распределённом реестре. Пример: 87dv4b23e654d67be83ad947923912g13eaw3ag6h1w343q7sv31rr671929f6jk . | Да |