TKEY7 API для Участников

RESTful API для взаимодействия Участника с Бизнес-ролью Маркетмейкер с TKEY7.

Version: 1.0.0

Получить остатки по идентификатору Цифрового счёта

Возвращает остатки Активов, которые доступны на заданном Цифровом счёте.

GET
  /client/v1/api/balances/digital-accounts/{account_identification}

Остатки

ЦРО

ЦРА

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
account_identification	path	Идентификатор Цифрового счёта. Для Эмиссионного счёта: `emission`, для Операционного счёта: `main` или другая строка, которая идентифицирует Операционный счёт, например: `reserveAccount`.	Да	string
asset_code_identification	query	Трёхбуквенный код актива, соответствующий стандарту ISO 4217 для ЦРА, например, `RUB` и шестибуквенный код актива для ЦРО, например, `RUBDSO`.	Нет	string
asset_issuer_identification	query	Идентификатор эмитента актива. Пример: `issuerBankName`.	Нет	string

Ответ ←

Код HTTP	Описание	Разметка
200	Остатки по заданному цифровому счёту успешно получены.	balanceInfo
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось получить остатки на заданном цифровом счёте. Не установлена кредитная линия по заданному активу с эмитентом, который выпустил запрашиваемый актив.	error

Запросить комиссию за обработку платежа

Отправляет запрос Участнику ПФУ для расчёта комиссии за обработку платежа от имени Плательщика. Сценарий — Запрос комиссии.

POST
  /client/v1/api/charges/request/{member_identification}

Комиссия ПФУ

Кредитовый перевод

PACS.008

Платёж от имени Плательщика

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
member_identification	path	Идентификатор Участника ПФУ. Пример: `bankName`.	Да	string
chargeRequest	body	Сведения, необходимые для расчёта комиссии ПФУ за обработку платежа.	Да	chargeRequest

Ответ ←

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

Ответить на запрос комиссии

Отправляет Участнику ОФУ сведения о комиссии за обработку платежа от имени Плательщика. Сценарий — Запрос комиссии.

POST
  /client/v1/api/charges/response/{member_identification}

Расчёт комиссии

Сведения о комиссии ПФУ

Платёж конечному Бенефициару

Параметры

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

Ответ ←

Код HTTP	Описание	Разметка
200	Ответ на запрос комиссии успешно отправлен.
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
409	Не удалось отправить ответ на запрос комиссии из-за неправильно сформированной полезной нагрузки.	error

Получить список открытых Цифровых счетов

Возвращает список Цифровых счетов, открытых в TKEY7. Идентификатор для Эмиссионного счёта: emission, для Операционного счёта: main или другая строка, которая идентифицирует Операционный счёт, например: distributionAcct. Информация о Цифровых счетах.

GET
  /client/v1/api/digital-accounts

Счета Участника

Операционный счёт для ЦРА

Эмиссионный счёт для ЦРО

Ответ ←

Код HTTP	Описание	Разметка
200	Список цифровых счетов успешно получен.	[ digitalAccount ]
404	Не найдено ни одного открытого цифрового счёта.	error

Получить Адрес счёта по идентификатору Цифрового счёта

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

GET
  /client/v1/api/digital-accounts/{account_identification}

Адрес счёта

Распределённый реестр

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
account_identification	path	Идентификатор Цифрового счёта. Для Эмиссионного счёта: `emission`, для Операционного счёта: `main` или другая строка, которая идентифицирует Операционный счёт, например: `reserveAccount`.	Да	string

Ответ ←

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

Консолидировать остатки на одном счёте

Консолидирует остатки активов ЦРА на одном Операционном счёте, что включает в себя перевод остатков с исходных счетов на целевой счёт.

POST
  /client/v1/api/digital-accounts/{account_identification}/consolidate

Объединение остатков

ЦРА

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
account_identification	path	Идентификатор Операционного счёта, на который будут переведены остатки. Пример: `consolidateAcct`.	Да	string
consolidateBalanceInstruction	body	Инструкция для консолидации остатков.	Да	consolidateBalanceInstruction

Ответ ←

Код HTTP	Описание	Разметка
200	Консолидация остатков успешно завершена.	consolidateBalanceResult
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
403	Невозможно выполнить консолидацию остатков для группы активов ЦРО.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.

Перезапустить прослушивание транзакций для заданного Цифрового счёта

Перезапускает Службу прослушивания транзакций для заданного Цифрового счёта на основе указанного референса и идентификатора Цифрового счёта. Этот метод используется, если по какой-то причине произошёл сбой, и требуется повторно начать обрабатывать информацию о новых транзакциях по мере их добавления в Распределённый реестр. Если установить значение now для параметра {reference}, то прослушивание потока транзакций начнётся с момента вызова запроса. Если произошёл сбой, то требуется указать значение последнего референса, на котором произошёл сбой, чтобы восстановить поток прослушивания транзакций с момента сбоя.

POST
  /client/v1/api/digital-accounts/{account_identification}/{reference}

Служба прослушивания транзакций

Распределённый реестр

Обновить состояние

Поток платежей

transaction_reference_number

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
account_identification	path	Идентификатор Цифрового счёта. Для Эмиссионного счёта: `emission`, для Операционного счёта: `main` или другая строка, которая идентифицирует Операционный счёт, например: `reserveAccount`.	Да	string
reference	path	Идентификатор референса. Пример: `now` или `333568171318368008` (transaction_reference_number).	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Служба прослушивания транзакций успешно перезапущена.
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
409	Невозможно перезапустить службу. Пожалуйста, проверьте корректность указанного идентификатора цифрового счёта.	error

Инициировать Расчёт на условиях DvP

Инициирует прямой Двусторонний обмен Активами между Участниками, после того как Участники подтвердили условия по обмену. Сценарий — Расчёт на условиях DvP.

POST
  /client/v1/api/exchange

Обмен активами

Окончательный расчёт

Распределённый реестр

Атомарная операция

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
exchangeObject	body	Сведения, необходимые для обмена активами.	Да	exchangeObject

Ответ ←

Код HTTP	Описание	Разметка
200	Обмен активами успешно завершён.	exchangeResult
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
403	Отказано в доступе. Идентификатор Участника ОФУ не соответствует JWT-токену инициатора запроса.	error
404	Не удалось выполнить обмен активами из-за ошибки получения подписи котировки Участника ПФУ.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

Получить список Котировок

GET
  /client/v1/api/exchange/quotations

Котировки

Валютный курс

Предложения от Участников

Фильтр

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
quotationParameters	body	Набор условий для получения списка Котировок.	Нет	quotationParameters

Ответ ←

Код HTTP	Описание	Разметка
200	Список котировок успешно получен.	[ quotationState ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error

Получить список Котировок

Возвращает список всех Котировок или Котировки по заданным условиям. Информация о Котировках. Сценарий — Запрос котировок. Бизнес-логика обработки Котировок и обмена активами. Этот метод предназначен для Участников, чьи клиенты не поддерживают GET-запросы с телом запроса.

POST
  /client/v1/api/exchange/quotations

Котировки

Валютный курс

Предложения от Участников

Фильтр

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
quotationParameters	body	Набор условий для получения списка Котировок.	Нет	quotationParameters

Ответ ←

Код HTTP	Описание	Разметка
200	Список котировок успешно получен.	[ quotationState ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error

Отменить Котировки

Отменяет все Котировки или Котировки по заданным условиям. Информация о Котировках. Сценарий — Запрос котировок. Бизнес-логика обработки Котировок и обмена активами.

DELETE
  /client/v1/api/exchange/quotations

Котировки

Фильтр

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
quotationParameters	body	Набор условий для отмены Котировок.	Да	quotationParameters

Ответ ←

Код HTTP	Описание
200	Котировки успешно отменены.
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.

Отправить Запрос котировок

Публикует Запрос котировок в TKEY7 и возвращает идентификатор запроса, по которому Участник будет получать Котировки. Ответить на Запрос котировок смогут Участники, включённые в Разрешённый список, и с которыми установлена Кредитная линия по Активам. Информация о Котировках. Сценарий — Запрос котировок. Бизнес-логика обработки Котировок и обмена активами.

POST
  /client/v1/api/exchange/quotations/request

Котировки

Условия

Валютный курс

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
requestQuotation	body	Сведения, необходимые для формирования запроса Котировок.	Да	requestQuotation

Ответ ←

Код HTTP	Описание	Разметка
200	Запрос котировок успешно отправлен.	requestQuotationResult
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось отправить Запрос котировок из-за отсутствия Участников в разрешённом списке.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

Получить список всех Котировок по идентификатору Запроса котировок

Возвращает список Котировок от других Участников по заданному идентификатору Запроса котировок. Информация о Котировках. Сценарий — Запрос котировок. Бизнес-логика обработки Котировок и обмена активами.

GET
  /client/v1/api/exchange/quotations/request/{request_uuid}

Котировки

Предложения от Участников

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
request_uuid	path	Уникальный идентификатор Запроса котировок. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be`.	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Котировки успешно получены.	[ quotationState ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.
404	Не удалось получить котировки по заданному идентификатору запроса котировок. Пожалуйста, проверьте корректность значения `request_uuid`.

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

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

GET
  /client/v1/api/exchange/quotations/{quotation_uuid}

Котировка

Условия

Валютный курс

Предложение от Участника

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
quotation_uuid	path	Уникальный идентификатор Котировки. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName`.	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Сведения о котировке успешно получены.	quotationState
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось получить сведения по заданному идентификатору котировки. Пожалуйста, проверьте корректность значения `quotation_uuid`.	error

Отправить Котировку

Отправляет Котировку Участнику, в ответ на его Запрос котировок. Информация о Котировках. Сценарий — Запрос котировок. Бизнес-логика обработки Котировок и обмена активами.

POST
  /client/v1/api/exchange/quotations/{quotation_uuid}

Котировка

Условия

Валютный курс

Предложение Участника

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
quotation_uuid	path	Уникальный идентификатор Котировки. Идентификатор формируется из `request_uuid` запроса котировок и идентификатора Участника `member_identification`. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName`.	Да	string
quotationObject	body	Пакет сведений о Котировке.	Да	quotationObject

Ответ ←

Код HTTP	Описание
200	Котировка успешно отправлена.
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.

Отменить Котировку по заданному идентификатору

Отменяет активную Котировку, отправленную в ответ на Запрос котировок. В случае если Котировка была принята Участником, Котировку отменить не удастся. Информация о Котировках. Сценарий — Запрос котировок. Бизнес-логика обработки Котировок и обмена активами.

DELETE
  /client/v1/api/exchange/quotations/{quotation_uuid}

Котировка

Удалить котировку

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
quotation_uuid	path	Уникальный идентификатор Котировки. Идентификатор формируется из `request_uuid` запроса котировок и идентификатора Участника `member_identification`. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName`.	Да	string

Ответ ←

Код HTTP	Описание
200	Котировка успешно отменена.
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.
404	Не удалось отменить котировку по заданному идентификатору. Пожалуйста, проверьте корректность значения `quotation_uuid`.

Получить сообщение от TKEY7

Возвращает сообщения, направленные Участнику. Список может включать запросы и ответы на запросы по котировкам, комиссиям, платежам и транзакциям. Информация о Шлюзовой службе сообщений Kafka.

GET
  /client/v1/api/gateway/messages

API-шлюз

Kafka

Сообщения

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
type	query	Тип запроса: `charge` (комиссия), `payment` (платёж), `transactions` (транзакции), `quotations` (котировки).	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Сообщения успешно получены.	[ kafkaMessages ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

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

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

GET
  /client/v1/api/members

Участники

Центральные банки

Коммерческие банки

Токенизаторы

Операторы Денежных Переводов

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
country_code	query	Двухбуквенный код страны нахождения Участников, соответствующий стандарту ISO 3166-1. Пример: `RU`.	Нет	string
asset_code_identification	query	Трёхбуквенный код актива, соответствующий стандарту ISO 4217. Пример: `RUB`.	Нет	string
asset_issuer_identification	query	Identifier of the Issuer of this asset.	Нет	string

Ответ ←

Код HTTP	Описание	Разметка
200	Список активных Участников получен.	[ memberInfo ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не найдено ни одного Участника.	error
406	Не удалось получить список Участников из-за неприемлемого заголовка.	error

Получить список Участников, которые добавлены в Разрешённый список

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

GET
  /client/v1/api/members/allowlist

Разрешённый список

Участники

Ответ ←

Код HTTP	Описание	Разметка
200	Список Участников успешно получен.	[ string ]
401	Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

Добавить Участника в Разрешённый список

Добавляет Участника в Разрешённый список по заданному идентификатору. Информация о Разрешённом списке.

POST
  /client/v1/api/members/allowlist

Разрешённый список

Участники

Начать сотрудничество

Параметры

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

Ответ ←

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

Удалить Участника из Разрешённого списка

Удаляет Участника из Разрешённого списка по заданному идентификатору. Удаление из Разрешённого списка отзывает возможность совершать операции между Участниками. Информация о Разрешённом списке.

DELETE
  /client/v1/api/members/allowlist

Разрешённый список

Участники

Прекратить сотрудничество

Параметры

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

Ответ ←

Код HTTP	Описание	Разметка
200	Участник успешно удалён.
401	Проблема с авторизацией. Пожалуйста, проверьте корректность JWT-токена в заголовке.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

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

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

GET
  /client/v1/api/members/{member_identification}

Участники

Центральные банки

Коммерческие банки

Токенизаторы

Операторы Денежных Переводов

Параметры

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

Ответ ←

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

Обновить токен доступа

Обновляет токен доступа с 15-минутным сроком действия.

GET
  /client/v1/api/oauth-token/refresh

JWT-токен

Обновить

Запрос

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
oauthBearerToken	body	Токен доступа, который требуется обновить.	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Токен доступа успешно обновлён.	string
404	Не удалось обновить токен доступа. Пожалуйста, проверьте корректность указанного токена.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

Получить список Пунктов выплаты

Возвращает список всех Пунктов выплаты в TKEY7 и связанные с ними сведения. Информация о Пунктах выплаты.

GET
  /client/v1/api/payment-points

Пункты выплаты

Способы доставки средств

TKEY7

Фильтр

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
uuid	query	Уникальный идентификатор пункта выплаты. Пример: `b1b1bec91beb2760c769c74b10fc2ccb`.	Нет	string
identification	query	Название Пункта выплаты. Пример: `Bank Name`.	Нет	string
point_type	query	Тип пункта выплаты: `Bank` (Банк), `Non-bank Financial Company` (Небанковская кредитная организация), `Mobile Operator` (Оператор мобильной связи) или `Other` (другое).	Нет	string
logo_url	query	Ссылка на логотип организации. Пример: `https://tkey7.com/assets/logo.png`	Нет	string
website_url	query	Ссылка на сайт организации, которой принадлежит Пункт выплаты. Пример: `https://tkey7.com/`.	Нет	string
phone_number	query	Номер телефона пункта выплаты без кода страны. Пример: `8000123456`.	Нет	string
currency_code	query	Список поддерживаемых валют пунктом выплаты. Пример: `RUB`, `CNY`.	Нет	string
point_child_uuid	query	Идентификатор дочернего пункта выплаты, который принадлежит родительскому местоположению. Пример: `8e23d56284c00dfb3ccb8d5fcd339a26`.	Нет	string
point_parent_uuid	query	Идентификатор родительского местоположения, который принадлежит Пункту выплаты. Пример: `dc7bec7d9dc1a6dba004543f5dc43382`.	Нет	string
institution_identifications	query	Название организации или организаций, которым принадлежат пункты выплаты. Пример: `Bank Name` или `Money Transfer Provider Name`, `Bank Name, Mobile Operator Name`.	Нет	string
method_identification	query	Способ выплаты: `cashout-delivery` (Доставка наличных), `cashout-branch` (Получение наличных в отделении), `cashout-agency` (Получение наличных в отделении партнёра), `cashout-mobile-operators` (Получение наличных в салонах мобильных операторов), `bank-account` (Зачисление на банковский счёт).	Нет	string
city_name	query	Город или населённый пункт. Пример: `Moscow`.	Нет	string
region_name	query	Название административно-территориальной единицы: область, республика, автономный округ, край, автономная область, штат, провинция, регион, губернаторство, губерния, префектура, столичная префектура, департамент, муниципалитет, экономический округ, административный округ, автономный край, автономный город, город центрального подчинения, город республиканского подчинения, город прямого подчинения, город-регион, город-метрополия, автономная республика, автономный район, специальный административный район, автономное территориальное образование, эмират, вилайет, мухафаза, дзонгхаг, аймак, уезд, община, коммуна, приход, земля, воеводство, жудец, кантон, островной совет, территория, суверенная территория, союзная территория, федеральная территория, федеральная территория племён, федеральная столичная территория, зависимая территория, административный регион, автономный регион, специальный административный регион, культурно-исторический регион, статистический регион, регион развития, заморский регион, графство, автономное сообщество. Пример: `Moscow`, `Arkhangelsk Oblast`, `Dubai`, `Bern`, `Tunisia`, `California`, `Bistrita-Nasaud`.	Нет	string
street_name	query	Улица или проспект. Пример: `Presnenskaya Embankment`.	Нет	string
country_code	query	Двухбуквенный код страны, соответствующий стандарту ISO 3166-1. Пример: `RU`.	Нет	string
postal_code	query	Почтовый индекс. Пример: `123112`.	Нет	string
address_filter	query	Адрес. Используется для сортировки Пунктов выплаты, которые находятся рядом с указанным адресом.	Нет	string
geo_coordinates	query	Географические координаты Пункта выплаты.	Нет	string

Ответ ←

Код HTTP	Описание	Разметка
200	Список пунктов выплаты успешно получен.	[ paymentPointInfo ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.

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

Отправляет запрос выкупа ЦРА Участнику-Токенизатору, содержащий сведения об исходном платеже. Информация о бизнес-логике обработки финансовых сообщений. Сценарий — Выкуп ЦРА.

POST
  /client/v1/api/payments/message/redeem

Токенизатор

Вернуть ЦРА

Получить денежные средства

PACS.009

ISO 20022

Параметры

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

Ответ ←

Код HTTP	Описание	Разметка
200	Служебное сообщение pacs.002 подтипа 01 от TKEY7 успешно получено.	financialMessage
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error

Отправить ответное финансовое сообщение Участнику

Отправляет ответ на запрос Участника ОФУ. Информация о финансовых сообщениях ISO 20022. Информация о бизнес-логике обработки финансовых сообщений.

POST
  /client/v1/api/payments/message/reply

Финансовое сообщение

TKEY.001

PACS.004

CAMT.029

ISO 20022

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
financialMessage	body	Сведения, необходимые для ответа на запрос платежа.	Да	financialMessage

Ответ ←

Код HTTP	Описание	Разметка
200	Служебное сообщение pacs.002 подтипа 01 от TKEY7 успешно получено.	financialMessage
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error

Отправить финансовое сообщение Участнику

Отправляет запрос Участнику ПФУ. Информация о финансовых сообщениях ISO 20022. Информация о бизнес-логике обработки финансовых сообщений.

POST
  /client/v1/api/payments/message/send

Финансовое сообщение

PACS.008

TKEY.002

CAMT.026

CAMT.056

CAMT.087

ISO 20022

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
financialMessage	body	Служебное сообщение pacs.002 подтипа 01 от TKEY7 успешно получено.	Да	financialMessage

Ответ ←

Код HTTP	Описание	Разметка
200	Запрос платежа успешно отправлен.	financialMessage
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error

Получить список доступных Активов в TKEY7

Возвращает список всех Активов, выпущенных в TKEY7 Участниками с Бизнес-ролью Маркетмейкер и Токенизатор. Информация об Активах.

GET
  /client/v1/api/settlement-instruments

Активы в TKEY7

ЦРО

ЦРА

Ответ ←

Код HTTP	Описание	Разметка
200	Список активов успешно получен.	[ settlementInstrumentInfo ]
404	Не удалось получить список активов. Нет выпущенных активов или возникла ошибка при маршалинге данных.	error

Выпустить актив ЦРО

Выпускает Актив ЦРО, который станет доступен для расчётов в TKEY7 между Участниками. Информация об Активах. Сценарий — платёж с помощью ЦРО.

POST
  /client/v1/api/settlement-instruments

Выпуск актива в TKEY7

ЦРО

Распределённый реестр

Платёжное обязательство

Предварительное депонирование

Отсроченный нетто-расчёт

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
asset_code_identification	query	Идентификатор кода актива ЦРО. Идентификатор соответствует соглашению из 6 символов, где первые 3 символа являются трёхбуквенным кодом валюты ISO 4217, и последующие 3 символа, которые соответствуют группе активов ЦРО в TKEY7, что образует идентификатор Актива, например: `RUBDSO`.	Да	string
asset_group_identification	query	Группа активов: `DSO`.	Да	string

Ответ ←

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

Изменить Кредитную линию по заданному Активу

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

POST
  /client/v1/api/settlement-instruments/credit-line

Кредитная линия

Авторизация

Запрос

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
creditLine	body	Сведения о Кредитной линии.	Да	creditLine

Ответ ←

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

Получить список Авторизованных активов по идентификатору Цифрового счёта

Возвращает список Авторизованных активов. Результат конечной точки указывает на факт установленной Кредитной линии по Активам с Участником-Эмитентом ЦРО или ЦРА. Наличие установленной Кредитной линии разрешает использовать Авторизованные активы на заданном Цифровом счёте. При использовании нескольких Операционных счетов требуется установить Кредитную линию для каждого Цифрового счёта, чтобы пользоваться Авторизованными активами на каждом счёте. Информация о Кредитной линии.

GET
  /client/v1/api/settlement-instruments/digital-accounts/{account_identification}

Авторизованные активы

ЦРО

ЦРА

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
account_identification	path	Идентификатор Цифрового счёта. Пример: `main`.	Да	string

Ответ ←

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

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

Возвращает список активов ЦРО, выпущенных Участником.

GET
  /client/v1/api/settlement-instruments/emission

Выпущенные активы

ЦРО

Ответ ←

Код HTTP	Описание	Разметка
200	Список активов успешно получен.	[ settlementInstrumentInfo ]
404	Нет активов, выпущенных Участником.	error

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

Возвращает список Эмиссионных активов и Авторизованных активов по заданному идентификатору другого Участника. Информация о Кредитной линии.

GET
  /client/v1/api/settlement-instruments/members/{member_identification}

Выпущенные

Авторизованные

Активы

ЦРО

ЦРА

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
member_identification	path	Идентификатор Участника. Пример: `bankName`.	Да	string
type	query	Параметр, который определяет, какие активы требуется получить. Значения: `both` (оба варианта), `emission` (выпущенные активы), `authorized` (авторизованные активы).	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Список активов по заданным параметрам успешно получен.	[ settlementInstrumentInfo ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось найти активы по заданным параметрам.	error

Получить общую сумму обязательств вне TKEY7 перед Участниками

Возвращает общую сумму обязательств вне TKEY7 перед Участниками по каждому выпущенному Активу ЦРО.

GET
  /client/v1/api/settlement-obligations

ЦРО

Обязательства

Непогашенный остаток

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
asset_code_identification	query	Идентификатор кода актива ЦРО. Идентификатор соответствует соглашению из 6 символов, где первые 3 символа являются трёхбуквенным кодом валюты ISO 4217, и последующие 3 символа, которые соответствуют группе активов ЦРО в TKEY7, что образует идентификатор Актива, например: `RUBDSO`.	Нет	string

Ответ ←

Код HTTP	Описание	Разметка
200	Общая сумма обязательств успешно получена.	[ balanceInfo ]
404	Отсутствуют обязательства перед Участниками вне TKEY7.	error

Получить список обязательств вне TKEY7 по идентификатору ЦРО

Возвращает сумму обязательств вне TKEY7 перед каждым Участником по заданному идентификатору Актива ЦРО.

GET
  /client/v1/api/settlement-obligations/{asset_code_identification}

ЦРО

Обязательства

Непогашенный остаток

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
asset_code_identification	path	Идентификатор кода актива ЦРО. Идентификатор соответствует соглашению из 6 символов, где первые 3 символа являются трёхбуквенным кодом валюты ISO 4217, и последующие 3 символа, которые соответствуют группе активов ЦРО в TKEY7, что образует идентификатор Актива, например: `RUBDSO`.	Да	string

Ответ ←

Код HTTP	Описание	Разметка
200	Список обязательств перед каждым Участником успешно получен.	[ balanceSheetLiabilities ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось получить список обязательств перед Участниками вне TKEY7. Пожалуйста, проверьте корректность указанного кода актива.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

Подписать сообщение ISO 20022

Подписывает XML-сообщение ISO 20022 электронной подписью Участника. Информация о Службе электронной подписи.

POST
  /client/v1/api/sign/message

Цифровая подпись

Полезная нагрузка

ISO 20022

XML

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
UnsignedPayload	body	Сведения, необходимые для подписания XML-сообщения ISO 20022.	Да	unsignedPayload

Ответ ←

Код HTTP	Описание	Разметка
200	XML-сообщение успешно подписано.	signedMessagePayload
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось подписать полезную нагрузку. Ошибка при маршалинге данных.	error

Подписать полезную нагрузку

Подписывает полезную нагрузку электронной подписью Участника. Информация о Службе электронной подписи.

POST
  /client/v1/api/sign/payload

Цифровая подпись

Полезная нагрузка

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
payload	body	Сведения, необходимые для подписания полезной нагрузки.	Да	unsignedPayload

Ответ ←

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

Получить список транзакций

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

GET
  /client/v1/api/transactions

Транзакция

Детали

Статус

Фильтр

Параметры

Наименование	Расположение	Описание	Обязательный	Разметка
data_type	query	Тип, определяющий, какие данные передаются в запросе: `INSTRUCTION_IDENTIFICATION` (идентификатор инструкции), `TRANSACTION_IDENTIFICATION` (идентификатор транзакции в распределённом реестре), `DATE_INTERVAL` (диапазон дат, в котором совершены транзакции).	Да	string
data_id	query	Значение для идентификации транзакции, например, для `INSTRUCTION_IDENTIFICATION` значение `989a0f0974ef985c592c6703fa4f88c9` и для `TRANSACTION_IDENTIFICATION` значение `87dv4b23e654d67be83ad947923912g13eaw3ag6h1w343q7sv31rr671929f6jk`.	Нет	string
start_date	query	Дата начала диапазона в формате `YYYY-MM-DD`, в котором запрашиваются транзакции.	Нет	date
finish_date	query	Дата окончания диапазона в формате `YYYY-MM-DD`, в котором запрашиваются транзакции.	Нет	date
maximum_transaction_count	query	Количество транзакций на одной странице.	Нет	integer
target_page_number	query	Запрашиваемый номер страницы.	Нет	integer

Ответ ←

Код HTTP	Описание	Разметка
200	Список транзакций успешно получен.	[ transaction ]
400	Неверный запрос. Пожалуйста, проверьте корректность указанных параметров и повторите запрос.	error
404	Не удалось получить список транзакций по заданным параметрам.	error
500	Внутренняя ошибка сервера. Попробуйте вызвать метод через некоторое время.	error

Модели

balanceInfo

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

Наименование	Тип	Описание	Обязательный
account_identification	string	Идентификатор Цифрового счёта. Для Эмиссионного счёта: `emission`, для Операционного счёта: `main` или другая строка, которая идентифицирует Операционный счёт, например: `reserveAccount`.	Да
asset_code_identification	string	Трёхбуквенный код актива, соответствующий стандарту ISO 4217 для ЦРА, например, `RUB` и шестибуквенный код актива для ЦРО, например, `RUBDSO`.	Да
asset_issuer_identification	string	Идентификатор эмитента актива. Пример: `issuerBankName`.	Нет
balance	string	Остаток на счёте.	Да

balanceSheetLiabilities

Сведения об обязательствах перед Участниками вне TKEY7.

Наименование	Тип	Описание	Обязательный
member_identification	string	Идентификатор Участника, который владеет ЦРО. Пример: `bankName`.	Нет
outstanding_balance	[ balanceInfo ]	Непогашенный остаток.	Нет

charge

Сведения о комиссии.

Наименование	Тип	Описание	Обязательный
fee_amount	number (float64)	Сумма комиссии.	Да
fee_asset	[ settlementInstrumentInfo ]	Актив, в котором рассчитывается комиссия.	Да

chargeRequest

Сведения, необходимые для расчёта комиссии за Платёж.

Наименование	Тип	Описание	Обязательный
instructed_currency_code	string	Трёхбуквенный код выплачиваемой валюты конечному Бенефициару, соответствующий стандарту ISO 4217. Пример: `RUB`.	Да
instructed_net_amount	number (float64)	Чистая сумма в выплачиваемой валюте, которую Участник ПФУ зачислит конечному Бенефициару в соответствии с платёжными инструкциями. Применяется, когда Плательщику необходимо рассчитать общую сумму перевода, включая комиссию Участника ПФУ. Если установлено это условие, то `interbank_settlement_gross_amount` не заполняется.	Нет
interbank_settlement_amount	number (float64)	Общая сумма межбанковского расчёта до вычета комиссии ПФУ, которую Участник ОФУ переводит ПФУ.	Нет
interbank_settlement_gross_amount	number (float64)	Общая сумма межбанковского расчёта, которую Участник ОФУ переводит Участнику ПФУ в распределённом реестре. Конечный Бенефициар получит эту сумму за вычетом комиссии ПФУ. Применяется, когда Плательщику необходимо рассчитать сумму, которую получит конечный Бенефициар. Если установлено это условие, то `instructed_net_amount` не заполняется.	Нет
interbank_settlement_instrument	[ settlementInstrumentInfo ]	Расчётный актив, используемый для передачи Стоимости в TKEY7.	Да
member_identification	string	Идентификатор Участника ОФУ. Пример: `bankName`.	Да
payment_point_info	[ paymentPointInfo ]	Сведения о пункте выплаты.	Нет
request_uuid	string (UUIDv4Identifier)	Уникальный идентификатор Запроса комиссии. Пример: `f24f837d-8602-4995-998e-a91de9a237b1`.	Да

compare

Условия для сравнительной проверки.

Наименование	Тип	Описание	Обязательный
comparison_value	number (decimal)	Число, которое необходимо сравнить.	Да
relational_operator	string	Оператор сравнения. По умолчанию: `eq` (равно). Параметры: `gt` (больше), `lt` (меньше), `ge` (больше или равно) и `le` (меньше или равно).	Да

consolidateBalance

Сведения об остатках на исходном Цифровом счёте после консолидации.

Наименование	Тип	Описание	Обязательный
asset_info	[ settlementInstrumentInfo ]	Сведения об Активе.	Да
consolidated_amount	number (decimal)	Сумма остатков.	Да
source_account_identification	string	Идентификатор исходного Операционного счёта. По умолчанию `main` или другая строка, которая идентифицирует операционный счёт, например: `reserveAccount`.	Да

consolidateBalanceInstruction

Инструкция для консолидации остатков.

Наименование	Тип	Описание	Обязательный
instruction	[ consolidateBalance ]	Сведения о Цифровых счетах, с которых необходимо произвести консолидацию остатков.	Да

consolidateBalanceResult

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

Наименование	Тип	Описание	Обязательный
account_balances	[ consolidateBalance ]	Остатки на исходном Операционном счёте после консолидации.	Нет
consolidate_timestamp	number (int64)	Временная метка успешно выполненной консолидации остатков.	Нет
transaction_identification	string	Уникальный идентификатор транзакции, который является хеш-значением в распределённом реестре. Пример: `87dv4b23e654d67be83ad947923912g13eaw3ag6h1w343q7sv31rr671929f6jk`.	Да

creditLine

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

Наименование	Тип	Описание	Обязательный
account_identification	string	Идентификатор Цифрового счёта Участника, с которым будет установлена Кредитная линия по Активу. Для группы активов ЦРО: `emission`, для ЦРА: `main` или другая строка, которая идентифицирует Операционный счёт Токенизатора, например `distributionAcct`.	Да
asset_code_identification	string	Трёхбуквенный код актива, соответствующий стандарту ISO 4217 для ЦРА, например, `RUB` и шестибуквенный код актива для ЦРО, например, `RUBDSO`.	Да
credit_line_state	string	Параметр для изменения состояния Кредитной линии: `request` (запросить), `allow` (разрешить) или `revoke` (отозвать).	Да
end_to_end_identification	string	Уникальный идентификатор, присвоенный Участником для однозначной идентификации запроса Кредитной линии. Пример: `ac05c7d8f4406c971085f947e43ef730`.	Нет
maximum_credit_limit	integer	Предел суммы актива ЦРО или ЦРА, которую Участник сможет удерживать после успешно установленной Кредитной линии с Участником-Эмитентом. Обязательный параметр, если в параметре `credit_line_state` передаётся значение `request` (запрос на установление Кредитной линии).	Нет
member_identification	string	Идентификатор Участника. Пример: `bankName`. Если в параметре `credit_line_state` передаётся значение `request` (запрос на установление Кредитной линии), требуется указать идентификатор Участника-Эмитента, если значение `allow` (разрешить) или `revoke` (отозвать), требуется указать идентификатор Участника, который инициировал запрос на установление Кредитной линии.	Да

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	Идентификатор, указывающий на источник возникновения ошибки.	Нет

exchangeInfo

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

Наименование	Тип	Описание	Обязательный
amount_base_asset	number (decimal)	Сумма в Базовом активе, который подлежит обмену.	Да
buyer_crediting_account_identification	string	Идентификатор Цифрового счёта Участника ОФУ, на который будет зачислен Котируемый актив. Пример: `main`.	Да
buyer_debiting_account_identification	string	Идентификатор Цифрового счёта Участника ОФУ, с которого будет списан Базовый актив. Пример: `distributionAcct`.	Да
quotation_info	[ quotationInfo ]	Сведения о Котировке.	Да

exchangeObject

Пакет сведений о Расчёте на условиях DvP.

Наименование	Тип	Описание	Обязательный
exchange_payload	string	Полезная нагрузка exchangeinfo в кодировке base64.	Да
member_signature	string	Подпись полезной нагрузки exchangeinfo в кодировке base64.	Да

exchangeResult

Квитанция о завершении Расчёта на условиях DvP.

Наименование	Тип	Описание	Обязательный
amount_base_asset	number (decimal)	Сумма Базового актива.	Да
amount_quoted_asset	number (decimal)	Сумма Котируемого актива.	Да
exchange_info	[ exchangeInfo ]	Сведения об обмене.	Да
exchange_state	string	Статус обмена: `Success` (Успешно) или `Rejected` (Отклонено).	Да
settlement_timestamp	number (int64)	Временная метка расчёта. Пример: `1651046978437`.	Нет
transaction_identification	string	Уникальный идентификатор транзакции, который является хеш-значением в распределённом реестре. Пример: `87dv4b23e654d67be83ad947923912g13eaw3ag6h1w343q7sv31rr671929f6jk`.	Да

financialMessage

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

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

geoCoordinates

Координаты в последовательности «широта, долгота».

Наименование	Тип	Описание	Обязательный
latitude	number (float64)	Широта координат. Пример: `55.749633`.	Да
longitude	number (float64)	Долгота координат. Пример: `37.537434`.	Да

kafkaMessages

Сообщения от Kafka.

Наименование	Тип	Описание	Обязательный
response_data	[ object ]	Полезная нагрузка.	Да
timestamp	string	Временная метка. Пример: `1650974635`.	Да

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 ]	Операционные счета.	Нет

memberSignedPayload

Подпись Участника.

Наименование	Тип	Описание	Обязательный
payload	byte	Подпись полезной нагрузки. Пример: `hWC4Q+asKbO9Hya3oWXW97mMDKlG/8X65jHzk7hYj2zTjG1BCqvsFLTmBAM++HW6N/sWzc30qb66sGdNbdfWDg==`.	Да

paymentCharge

Сведения о комиссии, взимаемой Участником ПФУ за обработку Платежа.

Наименование	Тип	Описание	Обязательный
fee_amount	number (float64)	Сумма комиссии в расчётном активе.	Да
instructed_amount	number (float64)	Сумма в выплачиваемой валюте, которую Участник ПФУ зачислит конечному Бенефициару в соответствии с платёжными инструкциями.	Да
instructed_currency_code	string	Трёхбуквенный код выплачиваемой валюты конечному Бенефициару, соответствующий стандарту ISO 4217. Пример: `RUB`.	Да
interbank_settlement_amount_without_fee	number (float64)	Сумма межбанковского расчёта без учёта комиссии Участника ПФУ. Общая сумма межбанковского перевода `interbank_settlement_amount` будет равна `interbank_settlement_amount_without_fee` + `fee_amount`, которую Участник ОФУ будет переводить Участнику ПФУ в распределённом реестре.	Нет
interbank_settlement_instrument	[ settlementInstrumentInfo ]	Расчётный актив, используемый для передачи Стоимости в TKEY7.	Да
payment_point_info	[ paymentPointInfo ]	Сведения о Пункте выплаты.	Нет
request_uuid	string (UUIDv4Identifier)	Уникальный идентификатор расчёта комиссии за обработку платежа. Пример: `30227c9f-3cd9-4142-b1cf-648598fdeb73`.	Да

paymentPointAddress

Фактический адрес Пункта выплаты.

Наименование	Тип	Описание	Обязательный
bin_or_building_number	string	Номер здания или уникальный идентификатор `BIN`. Пример: `12`.	Да
city_name	string	Город или населённый пункт. Пример: `Moscow`.	Да
country_code	string	Двухбуквенный код страны, соответствующий стандарту ISO 3166-1. Пример: `RU`.	Да
postal_code	string	Почтовый индекс. Пример: `123112`.	Да
region_name	string	Название административно-территориальной единицы первого уровня: область, республика, автономный округ, край, автономная область, штат, провинция, регион, губернаторство, губерния, префектура, столичная префектура, департамент, муниципалитет, экономический округ, административный округ, автономный край, автономный город, город центрального подчинения, город республиканского подчинения, город прямого подчинения, город-регион, город-метрополия, автономная республика, автономный район, специальный административный район, автономное территориальное образование, эмират, вилайет, мухафаза, дзонгхаг, аймак, уезд, община, коммуна, приход, земля, воеводство, жудец, кантон, островной совет, территория, суверенная территория, союзная территория, федеральная территория, федеральная территория племён, федеральная столичная территория, зависимая территория, административный регион, автономный регион, специальный административный регион, культурно-исторический регион, статистический регион, регион развития, заморский регион, графство, автономное сообщество. Пример: `Moscow`, `Arkhangelsk Oblast`, `Dubai`, `Bern`, `Tunisia`, `California`, `Bistrita-Nasaud`.	Да
street_name	string	Улица. Пример: `Presnenskaya Embankment`.	Да

paymentPointBusinessHours

График работы Пункта выплаты.

Наименование	Тип	Описание	Обязательный
close_time	string	Время окончания работы Пункта выплаты. Пример: `19:00`.	Да
open_time	string	Время начала работы Пункта выплаты. Пример: `10:00`.	Да
work_days	[ string ]	Рабочие дни Пункта выплаты. Пример: `Monday`, `Tuesday`, `Wednesday`, `Thursday`.	Да

paymentPointGeoCoordinates

Географические координаты Пункта выплаты.

Наименование	Тип	Описание	Обязательный
geo_coordinates	[ geoCoordinates ]	Координаты объекта.	Да
geo_type	string	Тип географического объекта: `point`, если объект является точкой и `area`, если объект содержит выделенную область.	Да

paymentPointInfo

Сведения о пункте выплаты.

Наименование	Тип	Описание	Обязательный
institution_identifications	[ string ]	Название организации или список учреждений, пункты выплат которых доступны в выбранном местоположении. Пример: [`Bank Name`] или [`Money Transfer Provider`, `Bank Name`, `Mobile Operator Name`].	Да
institution_phone_number	string	Номер телефона пункта выплаты без кода страны. Пример: `8000123456`.	Да
institution_routing_number	string	Уникальный идентификатор банка (Routing Number или БИК), однозначно идентифицирующий банк и его подразделение. Пример: `044525000`.	Нет
institution_website_url	string	Ссылка на сайт организации, которой принадлежит Пункт выплаты. Пример: `https:tkey7.com/ru/`.	Да
payment_point_address	[ paymentPointAddress ]	Фактический адрес Пункта выплаты.	Нет
payment_point_business_hours	[ paymentPointBusinessHours ]	График работы Пункта выплаты.	Да
payment_point_child_uuids	[ string ]	Список идентификаторов Пунктов выплаты, которые принадлежат родительскому местоположению. Идентификаторы могут включать точки `point` и области `area`. Пример: `8e23d56284c00dfb3ccb8d5fcd339a26` (идентификатор принадлежит Башне Империи) с типом `area` и `931eb3d6fb96916029b8ad6e6ec48289` (идентификатор ATM) с типом `point`.	Да
payment_point_currency	[ string ]	Список поддерживаемых валют пунктом выплаты. Пример: `RUB`, `CNY`.	Да
payment_point_geo_coordinates	[ paymentPointGeoCoordinates ]	Координаты Пункта выплаты.	Да
payment_point_identification	string	Название Пункта выплаты. Пример: `Bank Name branch No. 37`, если пункт выплаты является одной точкой или `Moscow International Business Center`, если местоположение содержит несколько Пунктов выплаты.	Да
payment_point_logo_url	string	Ссылка на логотип организации. Пример: `https:tkey7.com/assets/logo.png`	Да
payment_point_methods	[ paymentPointMethods ]	Сведения о способах выплат, которые обслуживаются пунктом выплаты.	Да
payment_point_parent_uuids	[ string ]	Список родительских идентификаторов Пунктов выплаты, которым принадлежит это местоположение. Идентификаторы могут включать только `area`. Пример: `dc7bec7d9dc1a6dba004543f5dc43382` (идентификатор принадлежит Международному Центру Москва-Сити).	Да
payment_point_type	string	Тип пункта выплаты: `Bank` (Банк), `Non-bank Financial Company` (Небанковская кредитная организация), `Mobile Operator` (Оператор мобильной связи) или `Other` (другое).	Да
payment_point_uuid	string	Уникальный идентификатор пункта выплаты. Пример: `b1b1bec91beb2760c769c74b10fc2ccb`.	Нет

paymentPointMethods

Сведения о способах выплат в пункте выплаты.

Наименование	Тип	Описание	Обязательный
method_identification	string	Категория способов выплат: `cashout-delivery` (Доставка наличных), `cashout-branch` (Получение наличных в отделении), `cashout-agency` (Получение наличных в отделении партнёра), `cashout-mobile-operators` (Получение наличных в салонах мобильных операторов), `bank-account` (Зачисление на банковский счёт).	Да
payment_point_terms	[ paymentPointTerms ]	Сведения об условиях пункта выплаты.	Да

paymentPointTerms

Сведения об условиях пункта выплаты.

Наименование	Тип	Описание	Обязательный
service_description	string	Описание условий. Пример: `Max limit of 10,000`.	Да
service_title	string	Краткое описание услуги. Пример: `Receiving cash U.S. dollars at a bank branch`.	Да

quotationInfo

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

Наименование	Тип	Описание	Обязательный
end_time	number (int64)	Время окончания действия Котировки. Пример: `1650967677000`.	Да
foreign_exchange_rate	number (decimal)	Обменный курс между Базовым активом и Котируемым активом. Пример: `0.3241715`.	Да
maximum_amount_limit	number (decimal)	Максимальное количество единиц Котируемого актива, которое Участник готов продать. Пример: `10000`.	Да
minimum_amount_limit	number (decimal)	Минимальное количество единиц Котируемого актива, которое Участник готов продать. Пример: `500`.	Нет
quotation_uuid	string	Уникальный идентификатор Котировки. Идентификатор формируется из `request_uuid` Запроса котировок и идентификатора Участника `member_identification`, который ответил на запрос. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName`.	Да
request_quotation	[ requestQuotation ]	Сведения о Запросе котировок.	Да
seller_crediting_account_identification	string	Идентификатор Цифрового счёта Участника ПФУ, на который будет зачислен Базовый актив. Пример: `main`.	Да
seller_debiting_account_identification	string	Идентификатор Цифрового счёта Участника ПФУ, с которого будет списан Котируемый актив. Пример: `reserveAccount`.	Да
seller_member_identification	string	Идентификатор Участника ПФУ. Пример: `bankName`.	Да
start_time	number (int64)	Время начала действия Котировки. Пример: `1650967477000`.	Да

quotationObject

Пакет сведений о Котировке.

Наименование	Тип	Описание	Обязательный
member_signature	string	Подпись полезной нагрузки quotationInfo в кодировке base64.	Да
quotation_payload	string	Полезная нагрузка quotationInfo в кодировке base64.	Да

quotationParameters

Условия, необходимые для фильтрации результатов Котировок.

Наименование	Тип	Описание	Обязательный
base_asset_info	[ settlementInstrumentInfo ]	Сведения о Базовом активе.	Нет
buyer_member_identification	string	Идентификатор Участника ОФУ, который отправил Запрос котировок. Пример: `buyerBankName`.	Нет
cancel_quotations	boolean	Отменить все Котировки. Используется только для отмены Котировок, если установлено значение `true`.	Нет
foreign_exchange_rate	[ compare ]	Обменный курс.	Нет
quoted_asset_info	[ settlementInstrumentInfo ]	Сведения о Котируемом активе.	Нет
request_quotation_state	[ compare ]	Статус Запроса котировок: `1` (ожидание), `10` (обновлён), `20` (выполняется), `21` (выполнен), `80` (сбой), `90` (отменён).	Нет
seller_member_identification	string	Идентификатор Участника ПФУ, который отправил Котировку в ответ на Запрос котировок. Пример: `sellerBankName`.	Нет
time_end_request_quotation	[ compare ]	Время окончания действия запроса котировок.	Нет

quotationState

Сведения о статусе Котировки.

Наименование	Тип	Описание	Обязательный
quotation_uuid	string	Уникальный идентификатор Котировки. Идентификатор формируется из `request_uuid` Запроса котировок и идентификатора Участника `member_identification`, который ответил на запрос. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName`.	Да
request_quotation_state	number (int)	Статус Запроса котировок: `1` (ожидание), `10` (обновлён), `20` (выполняется), `21` (выполнен), `80` (сбой), `90` (отменён).	Да
request_quotation_time	number (int64)	Временная метка Запроса котировок. Пример: `1650967477000`.	Нет
request_uuid	string (UUIDv4Identifier)	Уникальный идентификатор запроса котировок. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be`.	Нет
response_data	[ quotationInfo ]	Сведения о Котировке.	Нет
response_quotation_time	number (int64)	Временная метка ответа Участника на Запрос котировок. Пример: `1650967677000`.	Нет
seller_member_identification	string	Идентификатор Участника ПФУ, который ответил на Запрос котировок. Пример: `bankName`.	Да

requestQuotation

Сведения о Запросе котировок.

Наименование	Тип	Описание	Обязательный
base_asset_info	[ settlementInstrumentInfo ]	Сведения о Базовом активе.	Нет
buyer_member_identification	string	Идентификатор Участника ОФУ.	Да
maximum_amount_limit	number (decimal)	Максимальное количество единиц Котируемого актива, которое Участник готов купить. Пример: `10000`.	Да
minimum_amount_limit	number (decimal)	Минимальное количество единиц Котируемого актива, которое Участник готов купить. Пример: `500`.	Нет
quoted_asset_info	[ settlementInstrumentInfo ]	Сведения о Котируемом активе.	Нет
time_end_request_quotation	number (int64)	Время окончания действия Запроса котировок. Пример: `1650968848000`.	Да

requestQuotationResult

Квитанция об успешном Запросе котировок.

Наименование	Тип	Описание	Обязательный
request_timestamp	number (int64)	Временная метка Запроса котировок. Пример: `1650967477000`.	Да
request_uuid	string (UUIDv4Identifier)	Уникальный идентификатор Запроса котировок. Пример: `844349a6-fd5c-4fbc-9062-f1a6583d95be`.	Да

settlementInstrumentInfo

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

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

signedMessagePayload

Сообщение ISO 20022 с подписью Участника.

Наименование	Тип	Описание	Обязательный
payload	byte	Подписанное XML-сообщение электронной подписью Участника в кодировке base64.	Да

transaction

Сведения о выполненной транзакции.

Наименование	Тип	Описание	Обязательный
transaction_info	[ transactionInfo ]	Детали транзакции.	Да
transaction_state	[ transactionState ]	Квитанция о завершении транзакции.	Да

transactionInfo

Детали транзакции.

Наименование	Тип	Описание	Обязательный
creditor_fee	[ charge ]	Комиссия за транзакцию в расчётном активе, взимаемая Участником ПФУ.	Да
instructed_amount	number (float64)	Сумма в выплачиваемой валюте, которую Участник ПФУ зачислил конечному Бенефициару в соответствии с платёжными инструкциями.	Да
instructed_currency_code	string	Трёхбуквенный код выплачиваемой валюты конечному Бенефициару, соответствующий стандарту ISO 4217. Пример: `RUB`.	Нет
instructed_member_identification	string	Идентификатор Участника ПФУ. Пример: `instructedbankName`.	Да
instructing_member_identification	string	Идентификатор Участника ОФУ. Пример: `instructingbankName`.	Да
interbank_settlement_amount	number (float64)	Общая сумма межбанковского расчёта, которую Участник ОФУ перевёл Участнику ПФУ в распределённом реестре.	Да
interbank_settlement_asset	[ settlementInstrumentInfo ]	Расчётный актив, используемый для передачи Стоимости в TKEY7.	Да
interbank_settlement_method	string	Способ расчётов: `DSO` (ЦРО) или `DSA` (ЦРА).	Да

transactionState

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

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

unsignedPayload

Сведения, необходимые для подписания полезной нагрузки.

Наименование	Тип	Описание	Обязательный
account_identification	string	Идентификатор Цифрового счёта, с которого необходимо подписать полезную нагрузку. Для Эмиссионного счёта: `emission`, для Операционного счёта: `main` или другая строка, которая идентифицирует Операционный счёт, например: `reserveAccount`.	Да
unsigned_payload	byte	Неподписанная полезная нагрузка в кодировке base64.	Да

API документация: Введение

API документация: API Токенизатора

Api Main Member / Reference

TKEY7 API для Участников

Version: 1.0.0

Получить остатки по идентификатору Цифрового счёта

Параметры

Ответ ←

Запросить комиссию за обработку платежа

Параметры

Ответ ←

Ответить на запрос комиссии

Параметры

Ответ ←

Получить список открытых Цифровых счетов

Ответ ←

Получить Адрес счёта по идентификатору Цифрового счёта

Параметры

Ответ ←

Консолидировать остатки на одном счёте

Параметры

Ответ ←

Перезапустить прослушивание транзакций для заданного Цифрового счёта

Параметры

Ответ ←

Инициировать Расчёт на условиях DvP

Параметры

Ответ ←

Получить список Котировок

Параметры

Ответ ←

Получить список Котировок

Параметры

Ответ ←

Отменить Котировки

Параметры

Ответ ←

Отправить Запрос котировок

Параметры

Ответ ←

Получить список всех Котировок по идентификатору Запроса котировок

Параметры

Ответ ←

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

Параметры

Ответ ←

Отправить Котировку

Параметры

Ответ ←

Отменить Котировку по заданному идентификатору

Параметры

Ответ ←

Получить сообщение от TKEY7

Параметры

Ответ ←

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

Параметры

Ответ ←

Получить список Участников, которые добавлены в Разрешённый список

Ответ ←

Добавить Участника в Разрешённый список

Параметры

Ответ ←

Удалить Участника из Разрешённого списка

Параметры

Ответ ←

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

Параметры

Ответ ←

Обновить токен доступа

Параметры

Ответ ←

Получить список Пунктов выплаты

Параметры

Ответ ←

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

Параметры

Ответ ←

Отправить ответное финансовое сообщение Участнику

Параметры

Ответ ←

Отправить финансовое сообщение Участнику