Skip to main content

Api Tokenizer / Reference

TKEY7 API для Токенизатора

RESTful API для взаимодействия Токенизатора с TKEY7.

Version: 1.0.0

Получить Адрес счёта Участника

Возвращает Идентификатор учётной записи из распределённого реестра, соответствующий заданному идентификатору адресации Участника.

GET
/tokenizer/v1/api/account-address
Адрес счёта
Распределённый реестр

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
addressing_identificationqueryИдентификатор адресации. Идентификатор формируется из account_identification + * + country_code + member_identification + payments.tkey7.com. Пример: main*ru.bankName.payments.tkey7.com.
Нет
string

Ответ ←
Код HTTPОписаниеРазметка
200Адрес счёта успешно получен.digitalAccount
400Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.error
404Адрес счёта не найден. Пожалуйста, проверьте данные указанного Участника.error

Получить список всех Участников

Возвращает список всех активных Участников и связанные с ними данные. Информация об Участниках.

GET
/tokenizer/v1/api/members
Реестр участников
Центральные банки
Коммерческие банки
Операторы Денежных Переводов

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
country_codequeryДвухбуквенный код страны нахождения Участников, соответствующий стандарту ISO 3166-1. Пример: RU.
Нет
string
asset_code_identificationqueryТрёхбуквенный код актива, соответствующий стандарту ISO 4217. Пример: RUB.
Нет
string
asset_issuer_identificationqueryИдентификатор эмитента активов. Пример: issuerBankName.
Нет
string

Ответ ←
Код HTTPОписаниеРазметка
200Список активных Участников получен.[ memberInfo ]
404Не найдено ни одного Участника.error

Получить сведения об Участнике по идентификатору

Возвращает сведения об Участнике по заданному идентификатору.

GET
/tokenizer/v1/api/members/{member_identification}
Реестр участников
Центральные банки
Коммерческие банки
Операторы Денежных Переводов

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
member_identificationpathИдентификатор Участника. Пример: bankName.
Да
string

Ответ ←
Код HTTPОписаниеРазметка
200Сведения об Участнике успешно получены.memberInfo
404Участник с таким идентификатором не найден.error

Получить список выпущенных Активов ЦРА

Возвращает список Активов ЦРА, выпущенных Токенизатором и зарегистрированных в TKEY7.

GET
/tokenizer/v1/api/settlement-instruments/available/{tokenizer_identification}
Выпущенные активы
Зарегистрированные активы
ЦРА
TKEY7

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
tokenizer_identificationpathИдентификатор Токенизатора. Пример: tokenizerCentralBankName.
Да
string

Ответ ←
Код HTTPОписаниеРазметка
200Список выпущенных активов успешно получен.[ settlementInstrumentInfo ]
401Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке.error
404Нет выпущенных активов в TKEY7.error

Изменить Кредитную линию

Изменяет состояние Кредитной линии по Активу ЦРА между Токенизатором и Участником. Информация о Кредитной линии.

POST
/tokenizer/v1/api/settlement-instruments/credit-line/{tokenizer_identification}
Кредитная линия
Авторизация
Разрешить
Отозвать

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
tokenizer_identificationpathИдентификатор Токенизатора. Пример: tokenizerBankName.
Да
string
creditLinebodyСведения для установления или изменения Кредитной линии между Токенизатором и Участником.
Да
creditLine

Ответ ←
Код HTTPОписаниеРазметка
200Кредитная линия успешно изменена.
400Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос. Данный код ошибки возникает из-за отсутствия или недопустимых параметров в запросе.error
401Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке.error
404Не удалось изменить кредитную линию с Участником. Пожалуйста, проверьте корректность передаваемых сведений о кредитной линии.error

Создать инструкцию по Финансированию

Создаёт инструкцию по финансированию Участника Активами ЦРА. Информация о Финансировании. Сценарий — Запрос финансирования.

POST
/tokenizer/v1/api/transactions/instruction
Финансирование
ЦРА
Инструкция
Распределённый реестр

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
fundingInfobodyСведения о Финансировании.
Да
fundingInfo

Ответ ←
Код HTTPОписаниеРазметка
200Инструкция по финансированию Участника успешно создана.instruction
400Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос. Данный код ошибки возникает из-за отсутствия или недопустимых параметров в запросе.error
401Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке.error
404Запрос на создание инструкции не выполнен или указан недействительный Участник.error

Ответить на запрос выкупа ЦРА

Отправляет ответ на запрос Участника о выкупе ЦРА. Сценарий — Выкуп ЦРА.

POST
/tokenizer/v1/api/transactions/message/redeem
Получить ЦРА
Отправить денежные средства
Уведомление
PACS.002
ISO 20022

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
financialMessagebodyУведомление о результатах обработки финансового сообщения. Подписанное XML-сообщение pacs.002 в кодировке base64.
Да
financialMessage

Ответ ←
Код HTTPОписаниеРазметка
200Служебное сообщение pacs.002 подтипа 01 от TKEY7 успешно получено.financialMessage
404Произошла ошибка во время обработки ответа.error

Финансировать Участника

POST
/tokenizer/v1/api/transactions/send
Финансирование
ЦРА
Подпись
Распределённый реестр

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
fundingInfobodyСведения о Финансировании.
Да
fundingInfo
funding_payload_signaturequeryПодпись полезной нагрузки fundingInfo в кодировке base64. Пример: hWC4Q+asKbO9Hya3oWXW97mMDKlG/8X65jHzk7hYj2zTjG1BCqvsFLTmBAM++HW6N/sWzc30qb66sGdNbdfWDg==.
Да
string
signed_funding_transactionqueryПодписанная транзакция с подписью Токенизатора на Финансирование в кодировке base64. Пример: AAAAAtAAAABGUPkCVt32XjAe+00rrbSAW7RxDmVWnB1iYGk5NMLC2AAAAGQAAAAAAAAAEQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAEZQ+QJW3fZeMB77TSuttIBbtHEOZVacHWJgaTk0wsLYAAAAAQAAAADS8Dlw7lPHuCkVfcXWwVxM3qher6nN6vCXpPJ5yxjR4gAAAAFSVUIAAAAAAEZQ+QJW3fZeMB77TSuttIBbtHEOZVacHWJgaTk0wsLYAABa8xB6QAAAAAAAAAAAATTCwtgAAABARogDHBBaAw8O9GCTIPElVIZOVCX78U3rgCxsureu8YAPezpLoHBY+0sVDlWuUaPSdIqrgOsQ2DFJggltENNtDQ==.
Да
string

Ответ ←
Код HTTPОписаниеРазметка
200Участник успешно профинансирован.fundingResult
400Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.error
401Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке.error
404Не удалось профинансировать Участника из-за ошибки получения подписи Токенизатора из внутреннего реестра участников.error

Модели

creditLine

Сведения о Кредитной линии.

НаименованиеТипОписаниеОбязательный
account_identificationstringИдентификатор Операционного счёта Участника, с которым будет установлена Кредитная линия по активу ЦРА. Пример: main.
Да
asset_code_identificationstringТрёхбуквенный код актива, соответствующий стандарту ISO 4217. Пример: RUB.
Да
credit_line_statestringПараметр для изменения состояния Кредитной линии: allow (разрешить) или revoke (отозвать).
Да
end_to_end_identificationstringУникальный идентификатор, присвоенный Участником для однозначной идентификации запроса Кредитной линии. Пример: ac05c7d8f4406c971085f947e43ef730.
Нет
maximum_credit_limitintegerПредел суммы актива ЦРА, которую Участник сможет удерживать после успешно установленной Кредитной линии с Токенизатором. Этот параметр не заполняется Токенизатором.
Нет
member_identificationstringИдентификатор Участника, который запросил разрешение на Кредитную линию. Пример: bankName.
Да

digitalAccount

Цифровой счёт Участника.

НаименованиеТипОписаниеОбязательный
distributed_ledger_account_addressstringАдрес счёта в Распределённом реестре. Пример: TACHSKJNU22MVJVOVOLWVTVHOGMF7IBGQUQTRGLSTDLZYIVQP7BBO7GX.
Да
identificationstringИдентификатор Цифрового счёта. Для Эмиссионного счёта: emission, для Операционного счёта: main или другая строка, которая идентифицирует Операционный счёт, например: reserveAccount.
Нет

error

Сведения об ошибке.

НаименованиеТипОписаниеОбязательный
build_versionstringВерсия сборки службы.
Нет
codestringКод ошибки.
Нет
endpoint_urlstringURL-адрес конечной точки, которая завершилась с ошибкой.
Нет
long_messagestringПодробное описание возникшей ошибки.
Да
member_identificationstringИдентификатор Участника. Пример: bankName.
Нет
service_namestringНазвание службы.
Нет
short_messagestringКраткое описание сообщения об ошибке.
Да
timestampnumber (int64)Временная метка события. Пример: 1651224866578.
Да
troubleshooting_idstringИдентификатор, указывающий на источник возникновения ошибки.
Нет

financialMessage

Сведения о сообщении ISO 20022. Форматы сообщений MT не поддерживаются, требуется преобразовать их в общепринятый стандарт финансовой индустрии ISO 20022.

НаименованиеТипОписаниеОбязательный
financial_message_datastringXML-сообщение в кодировке base64.
Нет
financial_message_typestringТип XML-сообщения. Пример: isomsg20022:pacs.008.001.09.
Да

fundingInfo

Сведения о Финансировании.

НаименованиеТипОписаниеОбязательный
account_identificationstringИдентификатор Операционного счёта. По умолчанию main или другая строка, которая идентифицирует Операционный счёт, например: distributionAcct.
Нет
end_to_end_identificationstringУникальный идентификатор, присвоенный Токенизатором для однозначной идентификации запроса на Финансирование. Пример: c542f55b88270f25130b5e39bc243008.
Да
funding_amountnumber (float64)Сумма, на которую Токенизатор финансирует Участника.
Да
issued_asset_code_identificationstringИдентификатор актива ЦРА. Пример: RUB.
Да
member_identificationstringИдентификатор Участника, который получит Финансирование. Пример: bankName.
Да
memo_transactionstringПометка для транзакции, присвоенная Токенизатором. Пример: FR-2832RUB.
Нет
tokenizer_identificationstringИдентификатор Токенизатора. Пример: tokenizerBankName.
Да

fundingResult

Квитанция о завершении транзакции.

НаименованиеТипОписаниеОбязательный
funding_payload[ fundingInfo ]Сведения о Финансировании.
Да
funding_state[ transactionState ]Квитанция о завершении транзакции по Финансированию.
Да

instruction

Инструкция по финансированию Участника.

НаименованиеТипОписаниеОбязательный
funding_payload[ fundingInfo ]Сведения о Финансировании.
Да
unsigned_transaction_objectstringНеподписанная транзакция на Финансирование Участника в кодировке base64. Пример: AAAAAtAAAAAWezQAp2GGnfIm1nqbIdcB7D1+QywvsDE1eNVxLNQxPwAAAGQAAAAAAAAABwAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAABZ7NACnYYad8ibWepsh1wHsPX5DLC+wMTV41XEs1DE/AAAAAQAAAABkMXty5xTjRQWRClEfR8N0qoJV12N/zfnNS0Syp0bUTgAAAAFSVUIAAAAAAOKxrmVqSEDfjgo1KoxeqpBVk82UV/CTDCA+hyX8OHKDAABa8xB6QAAAAAAAAAAAAA==.
Да

memberInfo

Сведения об Участнике.

НаименованиеТипОписаниеОбязательный
bicfistringБанковский идентификационный код Участника. Пример: XXXXRUMMXXX.
Да
business_rolestringБизнес-роль зарегистрированного Участника. Для Маркетмейкера MMM и MIS для Токенизатора.
Да
country_codestringДвухбуквенный код страны нахождения Участника, соответствующий стандарту ISO 3166-1. Пример: RU.
Да
distributed_ledger_emission_account_addressstringИдентификатор учётной записи из распределённого реестра, соответствующий Эмиссионному счёту. Пример: TACHSKJNU22MVJVOVOLWVTVHOGMF7IBGQUQTRGLSTDLZYIVQP7BBO7GX.
Нет
identificationstringИдентификатор Участника. Пример: bankName.
Да
member_statestringСтатус Участника: created (создан), activated (активирован), blocked (заблокирован).
Нет
operating_digital_accounts[ digitalAccount ]Операционные счета.
Нет

settlementInstrumentInfo

Сведения об Активе.

НаименованиеТипОписаниеОбязательный
asset_code_identificationstringГруппа актива: DSOЦРО или DSAЦРА.
Да
asset_group_identificationstringТрёхбуквенный код актива, соответствующий стандарту ISO 4217 для ЦРА, например, RUB и шестибуквенный код актива для ЦРО, например, RUBDSO.
Да
asset_issuer_identificationstringИдентификатор эмитента актива. Пример: issuerBankName.
Нет

transactionState

Квитанция о завершении транзакции.

НаименованиеТипОписаниеОбязательный
timestampnumber (int64)Временная метка транзакции. Пример: 1651222986384.
Да
transaction_flow_statusstringСтатус транзакции в жизненном цикле платежа, например, Payment cleared (Платёж проведён), Payment settled (Платёж урегулирован).
Да
transaction_identificationstringУникальный идентификатор транзакции, который является хеш-значением в распределённом реестре. Пример: 87dv4b23e654d67be83ad947923912g13eaw3ag6h1w343q7sv31rr671929f6jk.
Да