Skip to main content

Api Main Member / Reference

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

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

Version: 1.0.0

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

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

GET
/client/v1/api/balances/digital-accounts/{account_identification}
Остатки
ЦРО
ЦРА

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

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

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

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

POST
/client/v1/api/charges/request/{member_identification}
Комиссия ПФУ
Кредитовый перевод
PACS.008
Платёж от имени Плательщика

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

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

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

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

POST
/client/v1/api/charges/response/{member_identification}
Расчёт комиссии
Сведения о комиссии ПФУ
Платёж конечному Бенефициару

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
member_identificationpathИдентификатор Участника ОФУ. Пример: bankName.
Да
string
paymentChargebodyСведения о комиссии.
Да
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_identificationpathИдентификатор Цифрового счёта. Для Эмиссионного счёта: emission, для Операционного счёта: main или другая строка, которая идентифицирует Операционный счёт, например: reserveAccount.
Да
string

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

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

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

POST
/client/v1/api/digital-accounts/{account_identification}/consolidate
Объединение остатков
ЦРА

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

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

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

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

POST
/client/v1/api/digital-accounts/{account_identification}/{reference}
Служба прослушивания транзакций
Распределённый реестр
Обновить состояние
Поток платежей
transaction_reference_number

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

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

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

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

POST
/client/v1/api/exchange
Обмен активами
Окончательный расчёт
Распределённый реестр
Атомарная операция

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

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

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

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

GET
/client/v1/api/exchange/quotations
Котировки
Валютный курс
Предложения от Участников
Фильтр

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

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

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

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

POST
/client/v1/api/exchange/quotations
Котировки
Валютный курс
Предложения от Участников
Фильтр

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

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

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

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

DELETE
/client/v1/api/exchange/quotations
Котировки
Фильтр

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

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

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

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

POST
/client/v1/api/exchange/quotations/request
Котировки
Условия
Валютный курс

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

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

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

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

GET
/client/v1/api/exchange/quotations/request/{request_uuid}
Котировки
Предложения от Участников

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

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

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

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

GET
/client/v1/api/exchange/quotations/{quotation_uuid}
Котировка
Условия
Валютный курс
Предложение от Участника

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
quotation_uuidpathУникальный идентификатор Котировки. Пример: 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_uuidpathУникальный идентификатор Котировки. Идентификатор формируется из request_uuid запроса котировок и идентификатора Участника member_identification. Пример: 844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName.
Да
string
quotationObjectbodyПакет сведений о Котировке.
Да
quotationObject

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

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

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

DELETE
/client/v1/api/exchange/quotations/{quotation_uuid}
Котировка
Удалить котировку

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
quotation_uuidpathУникальный идентификатор Котировки. Идентификатор формируется из 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
Сообщения

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

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

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

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

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

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
country_codequeryДвухбуквенный код страны нахождения Участников, соответствующий стандарту ISO 3166-1. Пример: RU.
Нет
string
asset_code_identificationqueryТрёхбуквенный код актива, соответствующий стандарту ISO 4217. Пример: RUB.
Нет
string
asset_issuer_identificationqueryIdentifier 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_identificationbodyИдентификатор Участника. Пример: bankName.
Да
string

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

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

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

DELETE
/client/v1/api/members/allowlist
Разрешённый список
Участники
Прекратить сотрудничество

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

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

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

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

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

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

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

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

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

GET
/client/v1/api/oauth-token/refresh
JWT-токен
Обновить
Запрос

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

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

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

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

GET
/client/v1/api/payment-points
Пункты выплаты
Способы доставки средств
TKEY7
Фильтр

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
uuidqueryУникальный идентификатор пункта выплаты. Пример: b1b1bec91beb2760c769c74b10fc2ccb.
Нет
string
identificationqueryНазвание Пункта выплаты. Пример: Bank Name.
Нет
string
point_typequeryТип пункта выплаты: Bank (Банк), Non-bank Financial Company (Небанковская кредитная организация), Mobile Operator (Оператор мобильной связи) или Other (другое).
Нет
string
logo_urlqueryСсылка на логотип организации. Пример: https://tkey7.com/assets/logo.png
Нет
string
website_urlqueryСсылка на сайт организации, которой принадлежит Пункт выплаты. Пример: https://tkey7.com/.
Нет
string
phone_numberqueryНомер телефона пункта выплаты без кода страны. Пример: 8000123456.
Нет
string
currency_codequeryСписок поддерживаемых валют пунктом выплаты. Пример: RUB, CNY.
Нет
string
point_child_uuidqueryИдентификатор дочернего пункта выплаты, который принадлежит родительскому местоположению. Пример: 8e23d56284c00dfb3ccb8d5fcd339a26.
Нет
string
point_parent_uuidqueryИдентификатор родительского местоположения, который принадлежит Пункту выплаты. Пример: dc7bec7d9dc1a6dba004543f5dc43382.
Нет
string
institution_identificationsqueryНазвание организации или организаций, которым принадлежат пункты выплаты. Пример: Bank Name или Money Transfer Provider Name, Bank Name, Mobile Operator Name.
Нет
string
method_identificationqueryСпособ выплаты: cashout-delivery (Доставка наличных), cashout-branch (Получение наличных в отделении), cashout-agency (Получение наличных в отделении партнёра), cashout-mobile-operators (Получение наличных в салонах мобильных операторов), bank-account (Зачисление на банковский счёт).
Нет
string
city_namequeryГород или населённый пункт. Пример: Moscow.
Нет
string
region_namequeryНазвание административно-территориальной единицы: область, республика, автономный округ, край, автономная область, штат, провинция, регион, губернаторство, губерния, префектура, столичная префектура, департамент, муниципалитет, экономический округ, административный округ, автономный край, автономный город, город центрального подчинения, город республиканского подчинения, город прямого подчинения, город-регион, город-метрополия, автономная республика, автономный район, специальный административный район, автономное территориальное образование, эмират, вилайет, мухафаза, дзонгхаг, аймак, уезд, община, коммуна, приход, земля, воеводство, жудец, кантон, островной совет, территория, суверенная территория, союзная территория, федеральная территория, федеральная территория племён, федеральная столичная территория, зависимая территория, административный регион, автономный регион, специальный административный регион, культурно-исторический регион, статистический регион, регион развития, заморский регион, графство, автономное сообщество. Пример: Moscow, Arkhangelsk Oblast, Dubai, Bern, Tunisia, California, Bistrita-Nasaud.
Нет
string
street_namequeryУлица или проспект. Пример: Presnenskaya Embankment.
Нет
string
country_codequeryДвухбуквенный код страны, соответствующий стандарту ISO 3166-1. Пример: RU.
Нет
string
postal_codequeryПочтовый индекс. Пример: 123112.
Нет
string
address_filterqueryАдрес. Используется для сортировки Пунктов выплаты, которые находятся рядом с указанным адресом.
Нет
string
geo_coordinatesqueryГеографические координаты Пункта выплаты.
Нет
string

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

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

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

POST
/client/v1/api/payments/message/redeem
Токенизатор
Вернуть ЦРА
Получить денежные средства
PACS.009
ISO 20022

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

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

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

POST
/client/v1/api/payments/message/reply
Финансовое сообщение
TKEY.001
PACS.004
CAMT.029
ISO 20022

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

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

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

POST
/client/v1/api/payments/message/send
Финансовое сообщение
PACS.008
TKEY.002
CAMT.026
CAMT.056
CAMT.087
ISO 20022

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
financialMessagebodyСлужебное сообщение 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_identificationqueryИдентификатор кода актива ЦРО. Идентификатор соответствует соглашению из 6 символов, где первые 3 символа являются трёхбуквенным кодом валюты ISO 4217, и последующие 3 символа, которые соответствуют группе активов ЦРО в TKEY7, что образует идентификатор Актива, например: RUBDSO.
Да
string
asset_group_identificationqueryГруппа активов: DSO.
Да
string

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

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

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

POST
/client/v1/api/settlement-instruments/credit-line
Кредитная линия
Авторизация
Запрос

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

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

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

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

GET
/client/v1/api/settlement-instruments/digital-accounts/{account_identification}
Авторизованные активы
ЦРО
ЦРА

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
account_identificationpathИдентификатор Цифрового счёта. Пример: 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_identificationpathИдентификатор Участника. Пример: bankName.
Да
string
typequeryПараметр, который определяет, какие активы требуется получить. Значения: both (оба варианта), emission (выпущенные активы), authorized (авторизованные активы).
Да
string

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

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

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

GET
/client/v1/api/settlement-obligations
ЦРО
Обязательства
Непогашенный остаток

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
asset_code_identificationqueryИдентификатор кода актива ЦРО. Идентификатор соответствует соглашению из 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_identificationpathИдентификатор кода актива ЦРО. Идентификатор соответствует соглашению из 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

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

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

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

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

POST
/client/v1/api/sign/payload
Цифровая подпись
Полезная нагрузка

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

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

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

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

GET
/client/v1/api/transactions
Транзакция
Детали
Статус
Фильтр

Параметры
НаименованиеРасположениеОписаниеОбязательныйРазметка
data_typequeryТип, определяющий, какие данные передаются в запросе: INSTRUCTION_IDENTIFICATION (идентификатор инструкции), TRANSACTION_IDENTIFICATION (идентификатор транзакции в распределённом реестре), DATE_INTERVAL (диапазон дат, в котором совершены транзакции).
Да
string
data_idqueryЗначение для идентификации транзакции, например, для INSTRUCTION_IDENTIFICATION значение 989a0f0974ef985c592c6703fa4f88c9 и для TRANSACTION_IDENTIFICATION значение 87dv4b23e654d67be83ad947923912g13eaw3ag6h1w343q7sv31rr671929f6jk.
Нет
string
start_datequeryДата начала диапазона в формате YYYY-MM-DD, в котором запрашиваются транзакции.
Нет
date
finish_datequeryДата окончания диапазона в формате YYYY-MM-DD, в котором запрашиваются транзакции.
Нет
date
maximum_transaction_countqueryКоличество транзакций на одной странице.
Нет
integer
target_page_numberqueryЗапрашиваемый номер страницы.
Нет
integer

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

Модели

balanceInfo

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

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

balanceSheetLiabilities

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

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

charge

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

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

chargeRequest

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

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

compare

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

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

consolidateBalance

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

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

consolidateBalanceInstruction

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

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

consolidateBalanceResult

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

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

creditLine

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

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

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

exchangeInfo

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

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

exchangeObject

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

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

exchangeResult

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

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

financialMessage

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

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

geoCoordinates

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

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

kafkaMessages

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

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

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

memberSignedPayload

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

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

paymentCharge

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

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

paymentPointAddress

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

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

paymentPointBusinessHours

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

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

paymentPointGeoCoordinates

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

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

paymentPointInfo

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

НаименованиеТипОписаниеОбязательный
institution_identifications[ string ]Название организации или список учреждений, пункты выплат которых доступны в выбранном местоположении. Пример: [Bank Name] или [Money Transfer Provider, Bank Name, Mobile Operator Name].
Да
institution_phone_numberstringНомер телефона пункта выплаты без кода страны. Пример: 8000123456.
Да
institution_routing_numberstringУникальный идентификатор банка (Routing Number или БИК), однозначно идентифицирующий банк и его подразделение. Пример: 044525000.
Нет
institution_website_urlstringСсылка на сайт организации, которой принадлежит Пункт выплаты. Пример: 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_identificationstringНазвание Пункта выплаты. Пример: Bank Name branch No. 37, если пункт выплаты является одной точкой или Moscow International Business Center, если местоположение содержит несколько Пунктов выплаты.
Да
payment_point_logo_urlstringСсылка на логотип организации. Пример: https:tkey7.com/assets/logo.png
Да
payment_point_methods[ paymentPointMethods ]Сведения о способах выплат, которые обслуживаются пунктом выплаты.
Да
payment_point_parent_uuids[ string ]Список родительских идентификаторов Пунктов выплаты, которым принадлежит это местоположение. Идентификаторы могут включать только area. Пример: dc7bec7d9dc1a6dba004543f5dc43382 (идентификатор принадлежит Международному Центру Москва-Сити).
Да
payment_point_typestringТип пункта выплаты: Bank (Банк), Non-bank Financial Company (Небанковская кредитная организация), Mobile Operator (Оператор мобильной связи) или Other (другое).
Да
payment_point_uuidstringУникальный идентификатор пункта выплаты. Пример: b1b1bec91beb2760c769c74b10fc2ccb.
Нет

paymentPointMethods

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

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

paymentPointTerms

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

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

quotationInfo

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

НаименованиеТипОписаниеОбязательный
end_timenumber (int64)Время окончания действия Котировки. Пример: 1650967677000.
Да
foreign_exchange_ratenumber (decimal)Обменный курс между Базовым активом и Котируемым активом. Пример: 0.3241715.
Да
maximum_amount_limitnumber (decimal)Максимальное количество единиц Котируемого актива, которое Участник готов продать. Пример: 10000.
Да
minimum_amount_limitnumber (decimal)Минимальное количество единиц Котируемого актива, которое Участник готов продать. Пример: 500.
Нет
quotation_uuidstringУникальный идентификатор Котировки. Идентификатор формируется из request_uuid Запроса котировок и идентификатора Участника member_identification, который ответил на запрос. Пример: 844349a6-fd5c-4fbc-9062-f1a6583d95be-sellerBankName.
Да
request_quotation[ requestQuotation ]Сведения о Запросе котировок.
Да
seller_crediting_account_identificationstringИдентификатор Цифрового счёта Участника ПФУ, на который будет зачислен Базовый актив. Пример: main.
Да
seller_debiting_account_identificationstringИдентификатор Цифрового счёта Участника ПФУ, с которого будет списан Котируемый актив. Пример: reserveAccount.
Да
seller_member_identificationstringИдентификатор Участника ПФУ. Пример: bankName.
Да
start_timenumber (int64)Время начала действия Котировки. Пример: 1650967477000.
Да

quotationObject

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

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

quotationParameters

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

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

quotationState

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

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

requestQuotation

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

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

requestQuotationResult

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

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

settlementInstrumentInfo

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

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

signedMessagePayload

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

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

transaction

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

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

transactionInfo

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

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

transactionState

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

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

unsignedPayload

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

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