openapi: "3.0.1" info: title: "Tinkoff API" license: name: "Apache 2.0" version: "1.0" x-logo: url: "https://business.cdn-tinkoff.ru/static/projects/openapi/logo.svg" backgroundColor: "#616871" externalDocs: description: "Tinkoff API" url: "https://developer.tinkoff.ru/docs/api" tags: - name: "Tinkoff Business ID. Информация о компании" description: "Методы для получения данных о компании и её реквизитов." x-parent-tag: "Tinkoff ID" - name: "Tinkoff ID. Информация о пользователе" description: "Методы принадлежат API Tinkoff ID и нужны для получения информации\ \ о физических лицах. Доступно только в партнёрском сценарии.\n\n## Получение\ \ учётных данных\n\nПользователь должен дать согласие на предоставление следую\ щих данных: «Полное имя», «E-mail», «Номер телефона». Перечень `scopes` у токе\ на для получения учётных данных:\n* profile;\n* phone;\n* email.\n\n### Входны\ е параметры\n\n* Заголовок `Authorization = Bearer \\\\{access_token}`.\n* Пол\ я формы `application/x-www-form-urlencoded`:\n* `client_id` — ID клиента;\n* `client_secret`\ \ — пароль клиента.\n\n### Формат ответа\n\nОтвет метода представлен в формате\ \ `application/json`. Поля json-документа (зависит от scope, нефиксированный с\ писок):\n\n* `sub` — идентификатор авторизированного пользователя;\n* `name` —\ \ фамилия, имя;\n* `gender` — пол;\n* `birthdate` — дата рождения в формате **yyyy-mm-dd**;\n\ * `family_name` — фамилия;\n* `given_name` — имя;\n* `middle_name` — отчество\ ;\n* `phone_number` — телефон в формате **+ (международный идентификатор стран\ ы)(номер абонента)**;\n* `email` — почтовый адрес.\n\n#### Пример запроса\n\n\ POST https://id.tinkoff.ru/userinfo/userinfo\n\n\n#### Пример отв\ ета\n\n {`\"email\": \"tinkoff@mail.ru\", \"email_verified\": false, \"\ family_name\": \"Иванов\", \"birthdate\": \"2000-01-01\", \"sub\": \"923d4812-148c-45v4-a56b-eed15cdd2857\"\ , \"name\": \"Иванов Олег\", \"gender\": \"male\", \"phone_number\": \"+79998887766\"\ , \"phone_number_verified\" : true, \"middle_name\": \"Юрьевич\", \"given_name\"\ : \"Олег\"`} " x-parent-tag: "Tinkoff ID" - name: "Tinkoff ID. Делегированная идентификация" description: "Методы для проверки информации о физическом лице по 115 ФЗ." x-parent-tag: "Tinkoff ID" - name: "Счета и выписки" description: "Методы для получения выписок и информации по расчётным и инвестици\ онным счетам организаций." - name: "Платежи" description: "Методы для совершения платежей, создания черновиков, платёжных пор\ учений и платежей через СБП." - name: "Зарплатный проект" description: "Методы для перевода денег сотрудникам и выпуска зарплатных карт." - name: "Выплаты самозанятым" description: "Методы для работы с выплатами самозанятым — добавление самозанятых\ \ по реквизитам, создание черновиков анкет и платёжных реестров, подписание и\ \ оплата реестров, получение информации о самозанятых.\n\nПеред интеграцией ре\ комендуем изучить сценарии использования методов и последовательность их вызов\ а. Подробнее." - name: "Самозанятые" description: "Методы для работы с самозанятыми — привязка самозанятых к Тинькофф\ , проверка статуса, формирование чеков и выполнение других операций от имени с\ амозанятого в налоговой." - name: "Выставление счетов" description: "Методы для работы с выставленными счетами." - name: "Номинальные счета" description: "Методы для работы с номинальными счетами." - name: "Безакцептные списания" description: "Методы для работы с безакцептными списаниями." - name: "Специальные счета" description: "Методы для работы со специальными счетами — тендерными, номинальны\ ми и так далее: получение информации по картотекам, блокировкам, картотекам ЭТ\ П (электронная торговая площадка) и списаниям в бюджет." - name: "Безопасная сделка" description: "Методы для поддержания процесса безопасной сделки. Доступно только\ \ в Self-сценарии." - name: "Торговый эквайринг" description: "Методы для получения подробной информации по операциям в терминале\ .\n\n\nТорговый эквайринг — услуга банка по приёму безналичной оплаты в торгов\ ой точке." - name: "Проверка контрагентов" description: "Методы для получения информации о любых юридических лицах и ИП, ко\ гда-либо существовавших в России, по данным из открытых источников — ФНС, СПАР\ К, Госзакупки, ФССП.\n\nЕсли данные неточные, напишите в поддержку Тинькофф Би\ знеса." - name: "Бизнес-карты" description: "Методы для получения данных по картам компании и установки по ним\ \ лимитов." - name: "Удалённая идентификация сотрудников" description: "Методы предназначены для проведения удалённой идентификации сотруд\ ников компании-клиента Тинькофф Бизнес — без очной встречи с представителем ба\ нка.\n\n\nДля проведения удалённой идентификации создаётся заявка, к которой п\ рикрепляются необходимые копии документов — например, скан паспорта.\nПосле эт\ ого подготовленную заявку можно использовать в целевом действии,\nдля которого\ \ нужен идентифицированный сотрудник — например, выпуск для него виртуальной б\ изнес-карты.\n\n\nУдалённая идентификация не имеет ценности сама по себе, поэт\ ому заявка запускается в работу в рамках целевого действия." - name: "Партнерские методы для работы с заявкой на покупку в кредит (PROD)" description: "Методы для работы с заявкой на покупку в кредит в точках продаж." - name: "Партнерские методы для работы с заявкой на покупку в кредит (TEST)" description: "Демо-методы для тестирования работы с заявкой на пос-кредит в точк\ ах продаж." - name: "Рейтинги продуктов" description: "Методы для пагинированного получения рейтингов на товары." - name: "Тинькофф Корзина. Работа с заказом" description: "Методы для работы с заказами в системе Тинькофф Корзина." - name: "Кредитные продукты" description: "Методы для работы с универсальным кредитным адаптером банка." - name: "Интернет-эквайринг. Диспуты" description: "Методы для обмена информацией по оспариваемым операциям между банк\ ом и компанией.\n\nДиспут (опротестование) — процесс оспаривания операции клие\ нтом или банком в соответствии с [порядком проведения претензионной работы](https://acdn.tinkoff.ru/static/documents/18e1262d-051a-4e99-b5e1-b8879b4437cc.pdf)." - name: "Партнёрская доставка" description: "Методы для создания задания представителю Тинькофф: удостоверить л\ ичность, сделать фотографии документов, провести опрос, доставить и активирова\ ть продукты.\n\n\nДоступно только для Self-сценария.\n\n\nЧтобы подключиться к\ \ линии доставки Тинькофф, напишите на openapi@tinkoff.ru." - name: "Cпецпредложения и кэшбэк" description: "Методы для получения информации о спецпредложениях, доступных клие\ нту. Доступно для Self-сценария." - name: "Декларации 3-НДФЛ" description: "Методы для получения данных, которые нужны партнёру для формирован\ ия налоговой декларации по форме 3-НДФЛ. Для работы с методами нужен уникальны\ й идентификатор заявки — `taxRequestId` (UUID)." - name: "Tinkoff ID" description: "Tinkoff ID — единая точка авторизации для всего Тинькофф банка, ко\ торая упрощает пользователям вход на ваш сайт и в приложение." - name: "Бенефициары и реквизиты" description: "Методы для работы с бенефициарами и реквизитами бенефициаров. Дост\ упно для Self-сценария. \n\n\nВажно:\n* Если бенефициар участвует в нескольких\ \ сделках, его данные нужно добавить только 1 раз\n — даже если сделки соверша\ ются в рамках нескольких номинальных счетов.\n* Первые указанные реквизиты бен\ ефициара считаются реквизитами по умолчанию и\n подставляются в сделках автома\ тически.\n* Если вам нужно использовать другие реквизиты, создайте новые и ука\ жите ID этих реквизитов\n у реципиента на этапе сделки.\nЧтобы установить эти\ \ реквизиты как реквизиты по умолчанию, используйте метод\n [Установить банков\ ские реквизиты бенефициара по умолчанию](https://developer.tinkoff.ru/docs/api/post-api-v-1-nominal-accounts-beneficiaries-beneficiaryid-bank-details-bankdetailsid-set-default).\n\ \ Если владелец денежных средств меняется, но их нужно оставить на номинальном\ \n счёте, вы можете перевести денежные средства на виртуальный счёт. Для этого\ \ используйте метод [Создать реципиента в этапе сделки](https://developer.tinkoff.ru/docs/api/post-api-v-1-nominal-accounts-deals-dealid-steps-stepid-recipients):\n\ \ в параметре `keepOnVirtualAccount` передайте `true`.\n\n\n\n ⚠️ Если вы испо\ льзуете управление расчётами через номинальные счета, пользоваться другими кан\ алами вывода средств с номинальных счетов — например, личный кабинет, метод пл\ атежа — нельзя.\n Если использовать другие способы, биллинг с учётом средств н\ а виртуальных счетах будет работать некорректно.\n" x-parent-tag: "Номинальные счета" - name: "Биллинг" description: "Методы для работы с номинальными счетами — идентификация пополнени\ й, просмотр остатков и холдов на виртуальных счетах бенефициаров, контроль вып\ олнения операций по сделкам и выплаты с виртуальных счетов на реальные счета б\ ез создания сделок.\n\nОграничение на использование методов — 10 запросов в се\ кунду.\n\nЕсли вы управляете расчётами через номинальные счета, пользоваться д\ ругими каналами вывода средств с номинальных счетов — например, личный кабинет\ \ или метод платежа — нельзя. Если использовать другие способы, биллинг с учёт\ ом средств на виртуальных счетах будет работать некорректно." x-parent-tag: "Номинальные счета" - name: "Депоненты и реципиенты" description: "Методы для управления отправителями — депонентами (deponents) и по\ лучателями денежных средств — реципиентами (recipients). Доступно для Self-сце\ нария. \n\n\nВажно:\n* В рамках сделки и этапа может быть несколько отправител\ ей (deponents) и несколько получателей (recipients).\n* Прикрепить одного и то\ го же бенефициара в рамках одного этапа как отправителя (deponent) больше\nодн\ ого раза не получится.\n* Прикрепить одного и того же бенефициара в рамках одн\ ого этапа как получателя (recipient) больше\nодного раза — можно.\n* Идентифик\ ация получателя происходит по ID реципиента (`recipientId`), отправителя — по\ \ ID бенефициара (`beneficiaryId`).\n\n\n\n ⚠️ Если вы используете управление\ \ расчётами через номинальные счета, пользоваться другими каналами вывода сред\ ств с номинальных счетов — например, личный кабинет, метод платежа — нельзя.\n\ \ Если использовать другие способы, биллинг с учётом средств на виртуальных сч\ етах будет работать некорректно.\n" x-parent-tag: "Номинальные счета" - name: "Партнёрские методы для работы с заявкой на выдачу кредита наличными" description: "Методы для работы с заявкой на на выдачу кредита наличными" - name: "Платёжные требования" description: "Методы для работы с платёжными требованиями — создание, получение\ \ списка платёжных требований и деталей, отзыв.\n\nПлатёжное требование — это\ \ платёжный документ, по которому происходит списание денежных средств по треб\ ованию получателя со счёта плательщика, в том числе безакцептное." x-parent-tag: "Безакцептные списания" - name: "Правила" description: "Методы для работы с платёжными правилами. Доступно для Self-сценар\ ия.\n\nПлатёжное правило — это принцип, по которому происходит автоматическое\ \ списание денежных средств с плательщика." x-parent-tag: "Безакцептные списания" - name: "Соглашения" description: "Методы для работы с соглашениями о безакцептном списании. Доступно\ \ для Self-сценария.\n\nБезакцептное списание — это списание денег со счёта пл\ ательщика без его дополнительного подтверждения в рамках соглашения о заранее\ \ данном акцепте.\n\nЕсли вы хотите использовать безакцептные списания со счет\ ов контрагентов, перед началом работы с методами убедитесь, что вы согласовали\ \ шаблон соглашения с банком и выбрали счёт, на который хотите получать деньги\ . С этим поможет менеджер в чате.\n\nСоглашение о безакцептном списании — это\ \ юридическое основание для безакцептного списания. В соглашении плательщик за\ ранее даёт своё согласие на последующие списания с его счёта без дополнительно\ го подтверждения. Соглашение можно заключить как по стандартному шаблону, кото\ рый предлагает банк, так и изменить шаблон под потребности получателя денег. П\ олучатель денег может встроить в свой интерфейс функционал для быстрого подпис\ ания контрагентами своего шаблона соглашения.\n\nЕсли у вас есть вопросы или п\ редложения, напишите на [non_acceptance_debiting@tinkoff.ru](mailto:non_acceptance_debiting@tinkoff.ru)." x-parent-tag: "Безакцептные списания" - name: "Управление сделками" description: "Методы для работы с номинальными счетами — управление сделками (CRUD).\n\ \nОграничение на использование методов — 10 запросов в секунду.\n\n[Пример раб\ оты со сделками и этапами](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/deal-flow.svg)\n\ \nЕсли вы управляете расчётами через номинальные счета, пользоваться другими к\ аналами вывода средств с номинальных счетов — например, личный кабинет или мет\ од платежа — нельзя. Если использовать другие способы, биллинг с учётом средст\ в на виртуальных счетах будет работать некорректно." x-parent-tag: "Номинальные счета" - name: "Управление этапами сделок" description: "Методы для работы с номинальными счетами — управление этапами сдел\ ок (CRUD).\n\nОграничение на использование методов — 10 запросов в секунду.\n\n\ [Пример работы со сделками и этапами](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/deal-flow.svg)\n\ \nВажно:\n\n* Если платёж не может быть выплачен, статус этапа переходит в `PAYMENT_FAILED`.\ \ На этом статусе этапа можно изменить реквизиты получателя денежных средств —\ \ реципиента — через метод [Обновить банковские реквизиты у реципиента в этапе\ \ сделки](https://developer.tinkoff.ru/docs/api/post-api-v-1-nominal-accounts-deals-dealid-steps-stepid-recipients-recipientid-update-bank-details).\n\ \n* Отменить эту сделку нельзя — при попытке совершения платежа на реальный сч\ ёт мы считаем, что деньги уже принадлежат получателю и должны быть выплачены е\ му в каком-либо виде. Если деньги должны остаться на номинальном счёте, в мето\ де [Создать реципиента на этапе сделки](https://developer.tinkoff.ru/docs/api/post-api-v-1-nominal-accounts-deals-dealid-steps-stepid-recipients)\ \ в реквизитах реципиента передайте `keepOnVirtualAccount = true`.\n\nЕсли вы\ \ управляете расчётами через номинальные счета, пользоваться другими каналами\ \ вывода средств с номинальных счетов — например, личный кабинет или метод пла\ тежа — нельзя. Если использовать другие способы, биллинг с учётом средств на в\ иртуальных счетах будет работать некорректно." x-parent-tag: "Номинальные счета" paths: /api/clfm/create: post: tags: - "Партнёрские методы для работы с заявкой на выдачу кредита наличными" summary: "Получить данные о клиенте и создать заявку" description: "Метод для предоставления данных о клиенте — по этим данным буд\ ет создана\nзаявка. \n\nВ ответе возвращаются ссылка и идентификатор заявк\ и — по этой ссылке партнёр направляет клиента и запускает процесс \nвыдачи\ \ с нашей стороны. \n\n\nМетод синхронный.\n" operationId: "postApiV1ClfmAppCreate" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: type: "object" properties: fio: type: "object" properties: lastName: type: "string" description: "Фамилия клиента." format: "string" firstName: type: "string" description: "Имя клиента." format: "string" middleName: type: "string" description: "Отчество клиента." format: "string" description: "ФИО клиента." birthDate: type: "string" description: "Дата рождения клиента в формате `yyyy-MM-dd`." format: "date" phone: pattern: "\\+\\d*" type: "string" description: "Номер телефона клиента в международном формате." format: "string" example: "+79631111112" email: type: "string" description: "Электронная почта клиента." format: "email" required: true responses: "200": description: "Успешный запрос. Заявка была создана" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "id" - "url" type: "object" properties: id: type: "string" description: "Уникальный идентификатор созданной заявки." format: "uuid" url: type: "string" description: "Ссылка на созданную заявку. По ней нужно направи\ ть клиента, чтобы начать процесс выдачи." format: "url" description: "Успешный ответ" example: id: "7d7093cd-004f-4201-acca-0ede88dbd71c" url: "https://forma.tinkoff.ru/cashloan/applications/7d7093cd-004f-4201-acca-0ede88dbd71c" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: INVALID_JSON: summary: "Некорректный JSON" value: errorId: "8f8cb741-a07d-41ea-b2b0-2617937f54e7" errorMessage: "Получен некорректный JSON." errorCode: "INVALID_JSON" INVALID_PHONE: summary: "Неверный формат номера телефона" value: errorId: "c584b8c6-0e78-49e2-8647-69a2751dd035" errorMessage: "Ошибка валидации. Неверный формат номера телефо\ на." errorCode: "INVALID_PHONE" errorDetails: phone: "Неверный формат номера телефона. Используйте междуна\ родный формат." INVALID_BIRTHDATE: summary: "Неверный формат даты рождения" value: errorId: "0f79caf4-06d0-4c9b-89ad-55f3b4ba4ba0" errorMessage: "Ошибка валидации. Неверный формат даты рождения\ ." errorCode: "INVALID_BIRTHDATE" errorDetails: birtDate: "Неверный формат даты рождения. Используйте `yyyy-MM-dd`." "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/clfm/demo: post: tags: - "Партнёрские методы для работы с заявкой на выдачу кредита наличными" summary: "Получить данные о клиенте и создать демо-заявку" description: " Метод для проверки корректности интеграции, аналогичен методу\ \ Получить данные о кли\ енте и создать заявку. Создаёт «прозрачную» для продуктового процесса\ \ заявку.\n\nМетод синхронный." operationId: "postApiV1ClfmAppDemo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: type: "object" properties: fio: type: "object" properties: lastName: type: "string" description: "Фамилия клиента." format: "string" firstName: type: "string" description: "Имя клиента." format: "string" middleName: type: "string" description: "Отчество клиента." format: "string" description: "ФИО клиента." birthDate: type: "string" description: "Дата рождения клиента в формате `yyyy-MM-dd`." format: "date" phone: pattern: "\\+\\d*" type: "string" description: "Номер телефона клиента в международном формате." format: "string" example: "+79631111112" email: type: "string" description: "Электронная почта клиента." format: "email" required: true responses: "200": description: "Заявка создана" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "id" - "url" type: "object" properties: id: type: "string" description: "Уникальный идентификатор созданной заявки." format: "uuid" url: type: "string" description: "Ссылка на созданную заявку. По ней нужно направи\ ть клиента, чтобы начать процесс выдачи." format: "url" description: "Успешный ответ" example: id: "7d7093cd-004f-4201-acca-0ede88dbd71c" url: "https://forma.tinkoff.ru/cashloan/applications/7d7093cd-004f-4201-acca-0ede88dbd71c" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: INVALID_JSON: summary: "Некорректный JSON" value: errorId: "8f8cb741-a07d-41ea-b2b0-2617937f54e7" errorMessage: "Получен некорректный JSON." errorCode: "INVALID_JSON" INVALID_PHONE: summary: "Неверный формат номера телефона" value: errorId: "c584b8c6-0e78-49e2-8647-69a2751dd035" errorMessage: "Ошибка валидации. Неверный формат номера телефо\ на." errorCode: "INVALID_PHONE" errorDetails: phone: "Неверный формат номера телефона. Используйте междуна\ родный формат." INVALID_BIRTHDATE: summary: "Неверный формат даты рождения" value: errorId: "0f79caf4-06d0-4c9b-89ad-55f3b4ba4ba0" errorMessage: "Ошибка валидации. Неверный формат даты рождения\ ." errorCode: "INVALID_BIRTHDATE" errorDetails: birtDate: "Неверный формат даты рождения. Используйте `yyyy-MM-dd`." "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/offline/partners/v1/create: post: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (PROD)" summary: "Создать новую заявку" description: "Метод создаёт кредитную заявку в системе Тинькофф Кредит Броке\ р.\n\nВ ответе возвращается ссылка с ссылочной авторизацией для продолжени\ я заявочного процесса внутри личного кабинета агента." operationId: "createTcbAppV1" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "orderNumber" - "type" type: "object" properties: agentLogin: pattern: "^[9]{1}[0-9]{9}$" type: "string" description: "Номер телефона агента под которым он заведён в TCB." orderNumber: maxLength: 50 minLength: 1 type: "string" description: "Номер заказа на стороне продавца." format: "string" order: required: - "items" type: "object" properties: items: maxItems: 99 minItems: 1 type: "array" items: required: - "name" - "price" - "quantity" type: "object" properties: name: maxLength: 255 minLength: 1 type: "string" description: "Наименование товара." format: "string" quantity: minimum: 0 type: "integer" description: "Количество товара." format: "int32" price: minimum: 0 type: "number" description: "Стоимость 1 единицы товара." format: "double" externalId: minLength: 1 type: "string" description: "Идентификатор товара." format: "string" description: "Товары в корзине." description: "Модель заказа клиента в запросе создания заявки." type: required: - "isCreditCard" - "isPos" type: "object" properties: isPos: type: "boolean" description: "Флаг отправки заявки на пос-кредит." format: "boolean" isCreditCard: type: "boolean" description: "Флаг отправки заявки на кредитную карту." format: "boolean" description: "Объект с информацией по запрашиваемым продуктам." isCallSigning: type: "boolean" description: "Флаг телефонного заполнения. По умолчанию — `false`." format: "boolean" isOnlyCredit: type: "boolean" description: "Флаг отключения рассрочек, возможно оформление тол\ ько кредитов. По умолчанию — `false`." format: "boolean" values: type: "object" properties: contact: type: "object" properties: fio: required: - "firstName" - "lastName" type: "object" properties: firstName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Имя клиента." format: "string" lastName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Фамилия клиента." format: "string" middleName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Отчество клиента." format: "string" description: "ФИО клиента." mobilePhone: pattern: "^[9]{1}[0-9]{9}$" type: "string" description: "Номер телефона клиента." birthDate: type: "string" description: "Дата рождения клиента." format: "date" isResident: type: "boolean" description: "Флаг резидента РФ." format: "boolean" description: "Модель данных клиента." description: "Данные клиента." webhookURL: pattern: "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\\ .[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$" type: "string" description: "URL для отправки вебхуков. Если не указан, использ\ уется URL из настроек точки." format: "url" pointId: maxLength: 50 minLength: 1 type: "string" description: "Внешний идентификатор точки." format: "string" companyId: maxLength: 100 minLength: 1 type: "string" description: "Внешний идентификатор компании." format: "string" agentId: maxLength: 100 minLength: 1 type: "string" description: "Внешний идентификатор агента." format: "string" creditCards: type: "object" additionalProperties: required: - "ean" type: "object" properties: ean: maxLength: 13 pattern: "^\\d{13}$" type: "string" description: "Штрихкод кредитной карты. Допускаются только\ \ цифры." format: "string" description: "Объект с кредитными картами." example: skb-card: ean: 123456789101 kvk-card: ean: 123456789101 description: "Модель запроса на создание заявки" required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "id" - "link" type: "object" properties: id: type: "string" description: "ID заявки в системе TCB." format: "uuid" link: type: "string" description: "Ссылка для перехода в личный кабинет TCB." format: "url" example: id: "21dc246d-ff4b-451b-a1f6-c746579bfb26" link: "https://forma.tinkoff.ru/auth/authorize?auth_token={access_token}&redirect_uri={redirectUrl}&client_id=tcb&response_type=code" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при некорректном запросе: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Выберите хотя бы один тип заявки." errorCode: "INVALID_REQUEST" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Агент не имеет достаточно прав для создания зая\ вок на текущей компании. Обратитесь в поддержку брокера." errorCode: "AUTH_FORBIDDEN" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/demo/create: post: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (TEST)" summary: "Создать новую заявку" description: "Метод создаёт кредитную заявку в системе Тинькофф Кредит Броке\ р.\n\nВ ответе возвращается ссылка с ссылочной авторизацией для продолжени\ я заявочного процесса внутри личного кабинета агента." operationId: "createTcbAppV1Demo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "orderNumber" - "type" type: "object" properties: agentLogin: pattern: "^[9]{1}[0-9]{9}$" type: "string" description: "Номер телефона агента под которым он заведён в TCB." orderNumber: maxLength: 50 minLength: 1 type: "string" description: "Номер заказа на стороне продавца." format: "string" order: required: - "items" type: "object" properties: items: maxItems: 99 minItems: 1 type: "array" items: required: - "name" - "price" - "quantity" type: "object" properties: name: maxLength: 255 minLength: 1 type: "string" description: "Наименование товара." format: "string" quantity: minimum: 0 type: "integer" description: "Количество товара." format: "int32" price: minimum: 0 type: "number" description: "Стоимость 1 единицы товара." format: "double" externalId: minLength: 1 type: "string" description: "Идентификатор товара." format: "string" description: "Товары в корзине." description: "Модель заказа клиента в запросе создания заявки." type: required: - "isCreditCard" - "isPos" type: "object" properties: isPos: type: "boolean" description: "Флаг отправки заявки на пос-кредит." format: "boolean" isCreditCard: type: "boolean" description: "Флаг отправки заявки на кредитную карту." format: "boolean" description: "Объект с информацией по запрашиваемым продуктам." isCallSigning: type: "boolean" description: "Флаг телефонного заполнения. По умолчанию — `false`." format: "boolean" isOnlyCredit: type: "boolean" description: "Флаг отключения рассрочек, возможно оформление тол\ ько кредитов. По умолчанию — `false`." format: "boolean" values: type: "object" properties: contact: type: "object" properties: fio: required: - "firstName" - "lastName" type: "object" properties: firstName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Имя клиента." format: "string" lastName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Фамилия клиента." format: "string" middleName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Отчество клиента." format: "string" description: "ФИО клиента." mobilePhone: pattern: "^[9]{1}[0-9]{9}$" type: "string" description: "Номер телефона клиента." birthDate: type: "string" description: "Дата рождения клиента." format: "date" isResident: type: "boolean" description: "Флаг резидента РФ." format: "boolean" description: "Модель данных клиента." description: "Данные клиента." webhookURL: pattern: "^https?:\\/\\/(?:www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\\ .[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&\\/=]*)$" type: "string" description: "URL для отправки вебхуков. Если не указан, использ\ уется URL из настроек точки." format: "url" pointId: maxLength: 50 minLength: 1 type: "string" description: "Внешний идентификатор точки." format: "string" companyId: maxLength: 100 minLength: 1 type: "string" description: "Внешний идентификатор компании." format: "string" agentId: maxLength: 100 minLength: 1 type: "string" description: "Внешний идентификатор агента." format: "string" creditCards: type: "object" additionalProperties: required: - "ean" type: "object" properties: ean: maxLength: 13 pattern: "^\\d{13}$" type: "string" description: "Штрихкод кредитной карты. Допускаются только\ \ цифры." format: "string" description: "Объект с кредитными картами." example: skb-card: ean: 123456789101 kvk-card: ean: 123456789101 description: "Модель запроса на создание заявки" required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "id" - "link" type: "object" properties: id: type: "string" description: "ID заявки в системе TCB." format: "uuid" link: type: "string" description: "Ссылка для перехода в личный кабинет TCB." format: "url" example: id: "21dc246d-ff4b-451b-a1f6-c746579bfb26" link: "https://forma.tinkoff.ru/auth/authorize?authToken={accessToken}&redirect_uri={redirectUrl}&client_id=tcb&responseType=code" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при некорректном запросе: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Выберите хотя бы один тип заявки." errorCode: "INVALID_REQUEST" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Агент не имеет достаточно прав для создания зая\ вок на текущей компании. Обратитесь в поддержку брокера." errorCode: "AUTH_FORBIDDEN" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/demo/orders/{orderNumber}/cancel: post: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (TEST)" summary: "Отменить заявку" description: "Метод отменяет заявку по вашему идентификатору — номеру заказа\ . После вызова метода заявка в личном кабинете агента перейдёт в статус `О\ тменена`." operationId: "cancelTcbAppV1Demo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderNumber" in: "path" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Не найдена заявка с номером заказа {orderNumber}." errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/demo/orders/{orderNumber}/commit: post: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (TEST)" summary: "Сохранить номер чека под заявкой" description: "Метод сохраняет номер чека под заявкой в системе TCB." operationId: "commitTcbAppV1Demo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderNumber" in: "path" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" requestBody: content: application/json: schema: required: - "invoiceNumber" type: "object" properties: invoiceNumber: maxLength: 250 type: "string" description: "Номер чека на стороне партнёра." format: "string" description: "Модель запроса на коммит." required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Не найдена заявка с номером заказа {orderNumber}." errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/demo/orders/{orderNumber}/info: get: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (TEST)" summary: "Получить информацию по заявке" description: "Метод возвращает актуальную информацию по заявке. Набор возвра\ щаемых полей может меняться в зависимости от статуса заявки." operationId: "infoTcbAppV1Demo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderNumber" in: "path" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "createdAt" - "id" - "orderNumber" - "status" type: "object" properties: id: type: "string" description: "ID заявки в системе TCB." format: "uuid" orderNumber: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" status: type: "string" description: "Статус заявки." enum: - "new" - "inprogress" - "wait-offers" - "approved" - "signing" - "signed" - "rejected" - "canceled" - "error" createdAt: type: "string" description: "Дата и время создания заявки." format: "dateTime" firstName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Имя клиента." format: "string" lastName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Фамилия клиента." format: "string" middleName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Отчество клиента." format: "string" mobilePhone: pattern: "^[9]{1}[0-9]{9}$" type: "string" description: "Номер телефона клиента." email: pattern: "^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$" type: "string" description: "E-mail клиента." format: "string" chosenPosOfferId: maxLength: 50 type: "string" description: "ID выбранного оффера (пос)." format: "string" chosenCardOfferId: maxLength: 50 type: "string" description: "ID выбранного оффера (карта)." format: "string" orderAmount: type: "number" description: "Сумма стоимостей товаров из корзины." format: "double" transferAmount: type: "number" description: "Сумма перевода партнёру." format: "double" offers: maxItems: 99 type: "array" items: required: - "bankId" - "bankName" - "id" - "status" type: "object" properties: id: maxLength: 100 type: "string" description: "ID оффера." format: "string" status: type: "string" description: "Статус оффера." enum: - "waiting" - "approved" - "rejected" - "error" - "signing" - "signed" - "canceled" firstPayment: type: "number" description: "Первоначальный взнос." format: "double" orderAmount: type: "number" description: "Сумма стоимостей товаров из корзины." format: "double" creditAmount: type: "number" description: "Сумма кредита." format: "double" discount: type: "number" description: "Скидка по рассрочке (в процентах)." format: "double" discountAmount: type: "number" description: "Скидка по рассрочке (в рублях)." format: "double" limit: type: "number" description: "Лимит по кредитной карте." format: "double" rate: type: "number" description: "Ставка по кредиту." format: "double" productCode: type: "string" description: "Идентификатор продукта." format: "string" product: type: "string" description: "Тип продукта." enum: - "credit" - "installment_credit" - "creditcard" term: type: "integer" description: "Срок кредита." format: "int32" monthlyPayment: type: "number" description: "Ежемесячный платёж по кредиту." format: "double" signingTypes: maxItems: 5 type: "array" description: "Типы подписания." items: type: "string" enum: - "partner" - "ses" - "sms" bankId: type: "string" description: "ID банка." format: "string" bankName: type: "string" description: "Название банка." format: "string" chosenServices: maxItems: 3 type: "array" description: "Выбранные банковские доп.услуги." items: type: "string" enum: - "life_insurance" - "lost_work_insurance" - "sms_bank" loanNumber: type: "string" description: "Номер договора." format: "string" accountNumber: pattern: "^\\d{1,20}$" type: "string" description: "Номер счёта клиента." format: "string" description: "Модель оффера от банка" order: required: - "items" type: "object" properties: items: minimum: 1 maxItems: 99 type: "array" items: required: - "name" - "price" - "quantity" type: "object" properties: name: maxLength: 255 minLength: 1 type: "string" description: "Наименование товара." format: "string" quantity: minimum: 0 type: "integer" description: "Количество товара." format: "int32" price: minimum: 0 type: "number" description: "Стоимость 1 единицы товара." format: "double" externalId: minLength: 1 type: "string" description: "Идентификатор товара." format: "string" description: "Товары в корзине." boxedServices: type: "object" properties: lifeInsurance: required: - "amount" - "name" - "term" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" term: type: "integer" description: "Срок услуги." format: "int32" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «Капитал Life»." pushSms: required: - "amount" - "name" - "term" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" term: type: "integer" description: "Срок услуги." format: "int32" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «ПУШСМС»." warranty: required: - "amount" - "name" - "params" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" params: maxItems: 99 type: "array" items: required: - "idCertificate" - "price" - "term" type: "object" properties: term: type: "integer" description: "Срок услуги." format: "int32" price: type: "number" description: "Стоимость услуги." format: "double" idCertificate: type: "string" description: "Номер сертификата." format: "string" name: type: "string" description: "Название товара." format: "string" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «Гарантия на технику»." teco: required: - "amount" - "name" - "tecoId" - "term" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" term: type: "integer" description: "Срок услуги." format: "int32" tecoId: type: "string" description: "Теко ID." format: "string" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «ТЕКО»." description: "Коробочные услуги." description: "Модель заказа клиента." example: id: "21dc246d-ff4b-451b-a1f6-c746579bfb2" orderNumber: "№12345678" status: "approved" createdAt: "2012-04-23T18:25:43.511Z" firstName: "Иван" lastName: "Иванов" middleName: "Иванович" mobilePhone: "9898882365" email: "bka@gmail.com" chosenPosOfferId: "21dc246d-ff4b-451b-a1f6-c746579bfb3" chosenCardOfferId: "12d8ee08-f08b-45ac-b891-1717ea93506c" orderAmount: 10000 transferAmount: 10000 order: items: - name: "iphone 11" quantity: 2 price: 60000 - name: "dyson x" quantity: 1 price: 45000 boxedServices: warranty: name: "Услуга-1" amount: 45 params: - term: 4 name: "что-то" price: 11658 idCertificate: "test_id" pushSms: name: "Услуга-2" amount: 40 term: 6 lifeInsurance: name: "Услуга-3" amount: 2423 term: 6 discountedAmount: 2423 teco: name: "Услуга-4" amount: 2423 term: 6 tecoId: "64c87fda60b2a35a104a6dbb" discountedAmount: 2423 offers: - id: "undefined" status: "rejected" bankId: "otp" bankName: "ОТП" - id: "24dc246d-ff4b-451b-a1f6-c746579bfb7" status: "signed" firstPayment: 0 orderAmount: 10000 creditAmount: 10000 product: "credit" term: 6 discount: 0.0 discountAmount: 0.0 monthlyPayment: 1500 bankId: "kvk" bankName: "Тинькофф" loanNumber: "№234234234" accountNumber: "40701810000010000038" signingTypes: - "ses" - "partner" chosenServices: - "sms_bank" - "life_insurance" - "lost_work_insurance" - id: "12d8ee08-f08b-45ac-b891-1717ea93506c" status: "approved" limit: 100000 product: "creditcard" bankId: "kvk-card" bankName: "Тинькофф" signingTypes: - "ses" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Не найдена заявка с номером заказа {orderNumber}." errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/orders/{orderNumber}/cancel: post: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (PROD)" summary: "Отменить заявку" description: "Метод отменяет заявку по вашему идентификатору — номеру заказа\ . После вызова метода заявка в личном кабинете агента перейдёт в статус `О\ тменена`." operationId: "cancelTcbAppV1" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderNumber" in: "path" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Не найдена заявка с номером заказа {orderNumber}." errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/orders/{orderNumber}/commit: post: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (PROD)" summary: "Сохранить номер чека под заявкой" description: "Метод сохраняет номер чека под заявкой в системе TCB." operationId: "commitTcbAppV1" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderNumber" in: "path" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" requestBody: content: application/json: schema: required: - "invoiceNumber" type: "object" properties: invoiceNumber: maxLength: 250 type: "string" description: "Номер чека на стороне партнёра." format: "string" description: "Модель запроса на коммит." required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Не найдена заявка с номером заказа {orderNumber}." errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/offline/partners/v1/orders/{orderNumber}/info: get: tags: - "Партнерские методы для работы с заявкой на покупку в кредит (PROD)" summary: "Получить информацию по заявке" description: " Метод возвращает актуальную информацию по заявке. Набор возвр\ ащаемых полей может меняться в зависимости от статуса заявки.\n\nЧтобы опе\ ративно отслеживать изменения статуса заявки на покупку товаров в кредит,\ \ вы можете воспользоваться вебхуком Статус заявки на товарный кредит." operationId: "infoTcbAppV1" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderNumber" in: "path" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "createdAt" - "id" - "orderNumber" - "status" type: "object" properties: id: type: "string" description: "ID заявки в системе TCB." format: "uuid" orderNumber: maxLength: 50 type: "string" description: "Номер заказа на стороне продавца." format: "string" status: type: "string" description: "Статус заявки." enum: - "new" - "inprogress" - "wait-offers" - "approved" - "signing" - "signed" - "rejected" - "canceled" - "error" createdAt: type: "string" description: "Дата и время создания заявки." format: "dateTime" firstName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Имя клиента." format: "string" lastName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Фамилия клиента." format: "string" middleName: pattern: "^[а-яА-ЯёЁ\\-\\s]{1,}$" type: "string" description: "Отчество клиента." format: "string" mobilePhone: pattern: "^[9]{1}[0-9]{9}$" type: "string" description: "Номер телефона клиента." email: pattern: "^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$" type: "string" description: "E-mail клиента." format: "string" chosenPosOfferId: maxLength: 50 type: "string" description: "ID выбранного оффера (пос)." format: "string" chosenCardOfferId: maxLength: 50 type: "string" description: "ID выбранного оффера (карта)." format: "string" orderAmount: type: "number" description: "Сумма стоимостей товаров из корзины." format: "double" transferAmount: type: "number" description: "Сумма перевода партнёру." format: "double" offers: maxItems: 99 type: "array" items: required: - "bankId" - "bankName" - "id" - "status" type: "object" properties: id: maxLength: 100 type: "string" description: "ID оффера." format: "string" status: type: "string" description: "Статус оффера." enum: - "waiting" - "approved" - "rejected" - "error" - "signing" - "signed" - "canceled" firstPayment: type: "number" description: "Первоначальный взнос." format: "double" orderAmount: type: "number" description: "Сумма стоимостей товаров из корзины." format: "double" creditAmount: type: "number" description: "Сумма кредита." format: "double" discount: type: "number" description: "Скидка по рассрочке (в процентах)." format: "double" discountAmount: type: "number" description: "Скидка по рассрочке (в рублях)." format: "double" limit: type: "number" description: "Лимит по кредитной карте." format: "double" rate: type: "number" description: "Ставка по кредиту." format: "double" productCode: type: "string" description: "Идентификатор продукта." format: "string" product: type: "string" description: "Тип продукта." enum: - "credit" - "installment_credit" - "creditcard" term: type: "integer" description: "Срок кредита." format: "int32" monthlyPayment: type: "number" description: "Ежемесячный платёж по кредиту." format: "double" signingTypes: maxItems: 5 type: "array" description: "Типы подписания." items: type: "string" enum: - "partner" - "ses" - "sms" bankId: type: "string" description: "ID банка." format: "string" bankName: type: "string" description: "Название банка." format: "string" chosenServices: maxItems: 3 type: "array" description: "Выбранные банковские доп.услуги." items: type: "string" enum: - "life_insurance" - "lost_work_insurance" - "sms_bank" loanNumber: type: "string" description: "Номер договора." format: "string" accountNumber: pattern: "^\\d{1,20}$" type: "string" description: "Номер счёта клиента." format: "string" description: "Модель оффера от банка" order: required: - "items" type: "object" properties: items: minimum: 1 maxItems: 99 type: "array" items: required: - "name" - "price" - "quantity" type: "object" properties: name: maxLength: 255 minLength: 1 type: "string" description: "Наименование товара." format: "string" quantity: minimum: 0 type: "integer" description: "Количество товара." format: "int32" price: minimum: 0 type: "number" description: "Стоимость 1 единицы товара." format: "double" externalId: minLength: 1 type: "string" description: "Идентификатор товара." format: "string" description: "Товары в корзине." boxedServices: type: "object" properties: lifeInsurance: required: - "amount" - "name" - "term" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" term: type: "integer" description: "Срок услуги." format: "int32" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «Капитал Life»." pushSms: required: - "amount" - "name" - "term" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" term: type: "integer" description: "Срок услуги." format: "int32" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «ПУШСМС»." warranty: required: - "amount" - "name" - "params" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" params: maxItems: 99 type: "array" items: required: - "idCertificate" - "price" - "term" type: "object" properties: term: type: "integer" description: "Срок услуги." format: "int32" price: type: "number" description: "Стоимость услуги." format: "double" idCertificate: type: "string" description: "Номер сертификата." format: "string" name: type: "string" description: "Название товара." format: "string" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «Гарантия на технику»." teco: required: - "amount" - "name" - "tecoId" - "term" type: "object" properties: name: type: "string" description: "Наименование услуги." format: "string" amount: type: "number" description: "Стоимость услуги." format: "double" term: type: "integer" description: "Срок услуги." format: "int32" tecoId: type: "string" description: "Теко ID." format: "string" discountedAmount: type: "number" description: "Сумма услуги с вычетом скидки." format: "double" description: "Коробочная услуга «ТЕКО»." description: "Коробочные услуги." description: "Модель заказа клиента." example: id: "21dc246d-ff4b-451b-a1f6-c746579bfb2" orderNumber: "№12345678" status: "approved" createdAt: "2012-04-23T18:25:43.511Z" firstName: "Иван" lastName: "Иванов" middleName: "Иванович" mobilePhone: "9898882365" email: "bka@gmail.com" chosenPosOfferId: "21dc246d-ff4b-451b-a1f6-c746579bfb3" chosenCardOfferId: "12d8ee08-f08b-45ac-b891-1717ea93506c" orderAmount: 10000 transferAmount: 10000 order: items: - name: "iphone 11" quantity: 2 price: 60000 - name: "dyson x" quantity: 1 price: 45000 boxedServices: warranty: name: "Услуга-1" amount: 45 params: - term: 4 name: "что-то" price: 11658 idCertificate: "test_id" pushSms: name: "Услуга-2" amount: 40 term: 6 lifeInsurance: name: "Услуга-3" amount: 2423 term: 6 discountedAmount: 2423 teco: name: "Услуга-4" amount: 2423 term: 6 tecoId: "64c87fda60b2a35a104a6dbb" discountedAmount: 2423 offers: - id: "undefined" status: "rejected" bankId: "otp" bankName: "ОТП" - id: "24dc246d-ff4b-451b-a1f6-c746579bfb7" status: "signed" firstPayment: 0 orderAmount: 10000 creditAmount: 10000 product: "credit" term: 6 discount: 0.0 discountAmount: 0.0 monthlyPayment: 1500 bankId: "kvk" bankName: "Тинькофф" loanNumber: "№234234234" accountNumber: "40701810000010000038" signingTypes: - "ses" - "partner" chosenServices: - "sms_bank" - "life_insurance" - "lost_work_insurance" - id: "12d8ee08-f08b-45ac-b891-1717ea93506c" status: "approved" limit: 100000 product: "creditcard" bankId: "kvk-card" bankName: "Тинькофф" signingTypes: - "ses" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка авторизации агента: value: errorId: "170e4a82-9c62-4fb0-8055-45e810630754" errorMessage: "Не найдена заявка с номером заказа {orderNumber}." errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/agreements: get: tags: - "Соглашения" summary: "Получить список соглашений" description: " Метод позволяет получить список соглашений с актуальными стат\ усами, в которых компания является получателем или плательщиком." operationId: "getApiV1Nonacceptance-AgreementsList" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "limit" in: "query" description: "Максимальное количество соглашений, которое нужно вывести. З\ начение по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" format: "int32" default: 50 - name: "offset" in: "query" description: "Количество соглашений, которые нужно пропустить. Значение по\ \ умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" format: "int32" default: 0 responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Количество соглашений, которое было пропущено." format: "int32" limit: type: "integer" description: "Максимальное количество соглашений, которое могл\ о быть выведено." format: "int32" size: type: "integer" description: "Количество соглашений в ответе." format: "int32" total: type: "integer" description: "Общее количество соглашений." format: "int32" results: maxItems: 50 type: "array" description: "Результат." nullable: true items: required: - "id" type: "object" properties: id: type: "string" description: "ID соглашения." format: "uuid" type: type: "string" description: " Тип участия в соглашении:\n\n`Recipient`\ \ — в качестве получателя;\n\n`Payer` — в качестве пла\ тельщика." enum: - "Recipient" - "Payer" status: type: "string" description: " Статус соглашения:\n\n`Pending` — ожидает\ \ подписания одной или двумя сторонами.\n\n`Signed` —\ \ подписано, ожидает регистрации на стороне банка. Как\ \ правило, это занимает не больше двух дней.\n\n`Active`\ \ — соглашение активно, можно производить списания.\n\n\ `Terminated` — соглашение расторгнуто одной из сторон\ .\n\n`Outdated` — срок соглашения истёк, производить с\ писания нельзя.\n\n`Error` — при обработке соглашения\ \ произошла ошибка. " enum: - "Pending" - "Active" - "Signed" - "Terminated" - "Error" - "Outdated" example: offset: 60 limit: 10 size: 1 total: 61 results: - id: "4ec482b3-b314-4089-88c2-2b6fba9424ef" type: "Recipient" status: "Active" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "VALIDATION_ERROR" errorMessage: "offset: value must be greater than 0" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/agreements/url: get: tags: - "Соглашения" summary: "Получить URL страницы для контрагента" description: " Метод позволяет получить URL для создания нового соглашения.\n\ \nКогда плательщик переходит по URL, открывается окно, в котором он указыв\ ает свои реквизиты и детали соглашения — срок действия, максимальная сумма\ \ платежа.\n\nОбсудите предполагаемые суммы платежей со своим контрагентом\ . В рамках соглашения с плательщика за раз не может быть списана сумма бол\ ьше той, которая указана в соглашении." operationId: "getApiV1Nonacceptance-AgreementUrl" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "url" type: "object" properties: url: type: "string" description: "URL для контрагента, который ведёт на форму подп\ исания соглашения." format: "string" example: url: "https://business.tinkoff.ru/nonacceptance-debits/form/3fa85f64-5717-4562-b3fc-2c963f66afa6" "400": description: "Не найдена форма для соглашения о безакцептных списаниях" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/agreements/{agreementId}: get: tags: - "Соглашения" summary: "Получить детали соглашения" description: " Метод отдаёт информацию о реквизитах плательщика и получателя\ , статусе соглашения, максимальной сумме платежа по договору. Чтобы измени\ ть детали соглашения, напишите в чат.\n\nЧтобы оперативно отслеживать инфо\ рмацию о создании или обновлении соглашения о безакцептном списании, вы мо\ жете воспользоваться вебхуком Обновление соглашения о без\ акцептном списании." operationId: "getApiV1Nonacceptance-AgreementDetails" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "agreementId" in: "path" description: "ID соглашения." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "id" - "number" - "payerRequisites" - "recipientRequisites" - "startDate" type: "object" properties: id: type: "string" description: "ID соглашения." format: "uuid" number: type: "string" description: "Номер соглашения." format: "string" recipientRequisites: type: "object" properties: name: maxLength: 300 type: "string" description: "Наименование." nullable: true address: type: "string" description: "Полный юридический адрес." format: "string" nullable: true inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." nullable: true kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." nullable: true ogrn: pattern: "^(\\d{13}|\\d{15})$" type: "string" description: "ОГРН." nullable: true signerName: type: "string" description: "ФИО представителя." format: "string" nullable: true signerPosition: type: "string" description: "Должность представителя." format: "string" nullable: true signerDocument: type: "string" description: "Документ-обоснование должности представителя\ ." format: "string" nullable: true accountNumber: pattern: "^(\\d{20})$" type: "string" description: "Расчётный счёт." nullable: true accountCurrency: pattern: "^(\\d{3})$" type: "string" description: "Валюта расчётного счёта." nullable: true corAccountNumber: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт." nullable: true bic: pattern: "^(\\d{9})$" type: "string" description: "БИК." nullable: true bankName: maxLength: 300 type: "string" description: "Наименование банка." nullable: true description: "Реквизиты получателя." payerRequisites: type: "object" properties: name: maxLength: 300 type: "string" description: "Наименование." nullable: true address: type: "string" description: "Полный юридический адрес." format: "string" nullable: true inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." nullable: true kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." nullable: true ogrn: pattern: "^(\\d{13}|\\d{15})$" type: "string" description: "ОГРН." nullable: true signerName: type: "string" description: "ФИО представителя." format: "string" nullable: true signerPosition: type: "string" description: "Должность представителя." format: "string" nullable: true signerDocument: type: "string" description: "Документ-обоснование должности представителя\ ." format: "string" nullable: true accountNumber: pattern: "^(\\d{20})$" type: "string" description: "Расчётный счёт." nullable: true accountCurrency: pattern: "^(\\d{3})$" type: "string" description: "Валюта расчётного счёта." nullable: true corAccountNumber: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт." nullable: true bic: pattern: "^(\\d{9})$" type: "string" description: "БИК." nullable: true bankName: maxLength: 300 type: "string" description: "Наименование банка." nullable: true description: "Реквизиты плательщика." startDate: type: "string" description: "Дата подписания соглашения." format: "date-time" endDate: type: "string" description: "Дата окончания действия соглашения." format: "date-time" nullable: true maxSum: type: "number" description: "Максимальная сумма платежа." format: "decimal" nullable: true currency: pattern: "^(\\d{3})$" type: "string" description: "Валюта максимальной суммы." nullable: true reason: type: "string" description: "Документ-основание для заключения соглашения." format: "string" nullable: true status: type: "string" description: " Статус соглашения:\n\n`Pending` — ожидает подпи\ сания одной или двумя сторонами.\n\n`Signed` — подписано, ож\ идает регистрации на стороне банка. Как правило, это занимае\ т не больше двух дней.\n\n`Active` — соглашение активно, мож\ но производить списания.\n\n`Terminated` — соглашение растор\ гнуто одной из сторон.\n\n`Outdated` — срок соглашения истёк\ , производить списания нельзя.\n\n`Error` — при обработке со\ глашения произошла ошибка. " enum: - "Pending" - "Active" - "Signed" - "Terminated" - "Error" - "Outdated" example: id: "4ec482b3-b314-4089-88c2-2b6fba9424ef" number: "236383626412/2022-08-05/25.421" startDate: "2022-08-05T18:08:17.338628Z" endDate: "2023-08-06T18:00:00Z" maxSum: 1000.0 currency: "643" reason: "На основании договора №7345 от 01.02.2018" status: "Pending" recipientRequisites: name: "ООО \"Ромашка\"" address: "г. Москва, ул. Производственная, 12 корпус 3, 067889" inn: "1234567890" kpp: "123456789" ogrn: "1234567891234" signerName: "Иванов Иван Иванович" signerPosition: "Главный бухгалтер" signerDocument: "На основании доверенности №123412355 от 10.05.2018" accountNumber: "12345678900987654321" accountCurrency: "643" corAccountNumber: "30101810145250000974" bic: "044525974" bankName: "АО \"ТИНЬКОФФ БАНК\"" payerRequisites: name: "ИП Петров Петр Иванович" address: "г. Москва, ул. Производственная, д.15, 067889" inn: "1234567890" kpp: "123456789" ogrn: "1234567891234" signerName: "Петров Петр Иванович" signerPosition: "" signerDocument: "Выписка из ЕГРЮЛ" accountNumber: "12345678900987654321" accountCurrency: "643" corAccountNumber: "30101810145250000974" bic: "044525974" bankName: "АО \"ТИНЬКОФФ БАНК\"" "400": description: "Соглашение не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/agreements/{agreementId}/file: get: tags: - "Соглашения" summary: "Получить детали соглашения в PDF" description: "Метод для получения PDF-файла с текстом соглашения. Файл закод\ ирован в `base64`." operationId: "getApiV1Nonacceptance-AgreementDetails-file" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "agreementId" in: "path" description: "ID соглашения." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "content" - "filename" type: "object" properties: filename: type: "string" description: "Имя файла." format: "string" content: type: "string" description: "Base64-encoded файл в формате PDF с текстом согл\ ашения." format: "byte" example: content: "UERGIGZpbGUgc2hvdWxkIGJlIGhlcmU=" filename: "1234-010122.pdf" "400": description: "Соглашение не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/chargebacks: get: tags: - "Интернет-эквайринг. Диспуты" summary: "Получить информацию о диспутах компании" description: "Метод для получения информации по всем диспутам компании за за\ прашиваемый период. Включает в себя как новые диспуты, так и старые, по ко\ торым были изменения за период." operationId: "getChargebacks" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "beginDate" in: "query" description: "Дата начала." required: true style: "form" explode: true schema: type: "string" format: "date" - name: "endDate" in: "query" description: "Дата окончания." required: true style: "form" explode: true schema: type: "string" format: "date" responses: "200": description: "OK" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "data" type: "object" properties: message: maxLength: 300 type: "string" description: "Результат обработки запроса." data: maxItems: 500 type: "array" description: "Информация по каждому диспуту." items: required: - "attachments" - "cbkAmt" - "channel" - "chargebackStage" - "reasonCode" - "status" type: "object" properties: channel: type: "string" description: "Канал:\n- `ON-US` — карты Тинькофф;\n- `OFF-US`\ \ — карты сторонних банков." enum: - "ON-US" - "OFF-US" origTrxnDate: pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$" type: "string" description: "Дата и время оригинальной транзакции в фор\ мате `yyyy-mm-dd'T'HH:mm:ss`." cardNumber: maxLength: 100 pattern: "\\*{2,}" type: "string" description: "Маскированный номер карты клиента." merchantName: maxLength: 100 type: "string" description: "Название мерчанта." submerchantId: type: "integer" description: "Идентификатор точки." format: "int64" trxnAmt: type: "number" description: "Сумма транзакции в рублях." cbkAmt: type: "number" description: "Сумма оспаривания." cbkCur: maxLength: 100 type: "string" description: "Валюта оспаривания." paymentId: maxLength: 100 type: "string" description: "Идентификатор платежа (orderId)." terminalId: maxLength: 100 type: "string" description: "Идентификатор терминала." arn: maxLength: 100 type: "string" description: "Acquirer Reference Number." rrn: maxLength: 100 type: "string" description: "Retrieval Reference Number." reasonCode: maxLength: 100 type: "string" description: "Код причины оспаривания." status: maxLength: 100 type: "string" description: "Статус диспута:\n- `Вернули держателю` — д\ испут проиграли и сумма вернулась физическому лицу.\n\ - `Нужен ответ` — Тинькофф требует от вас ответа на ди\ спут: согласны с претензией или нет, а также документы\ , подтверждающие позицию компании в случае несогласия\ \ с диспутом.\n- `В работе` — ответ от компании получе\ н, диспут в обработке на стороне Тинькофф или стороне\ \ эмитента.\n- `Выиграли` — диспут закрыт в пользу ком\ пании.\n- `Решение по Арбитражу` — диспут закрыт по ит\ огам рассмотрения в Арбитражном комитете платёжной сис\ темы. Решение ПС может быть передано по запросу." chargebackStage: maxLength: 100 type: "string" description: "Стадия диспута." retentionDate: type: "string" description: "Дата удержания средств с ТСП." format: "date" moneyTransferDate: type: "string" description: "Дата зачисления средств в ТСП." format: "date" text: maxLength: 5000 type: "string" description: "Текст сообщения." deadline: type: "string" description: "Дата, до которой ожидаем получить ответ." format: "date" attachments: maxItems: 100 type: "array" description: "Файлы, прикрепленные к диспуту." items: maxLength: 100 type: "string" description: "Ссылка на файл в data.tinkoff." firstCbkDate: pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$" type: "string" description: "Дата и время открытия спора в формате `yyyy-mm-dd'T'HH:mm:ss`." description: "Информация о диспуте." firstCbkDate: type: "string" description: "Дата и время открытия спора." format: "datetime" description: "Общий формат ответа." example: message: "OK" data: - channel: "ON-US" origTrxnDate: "2023-01-31T17:25:14" cardNumber: "553691******6876" merchantName: "WIldberries" submerchantId: 123456 trxnAmt: 5000.5 cbkAmt: 4000 cbkCur: "RUB" paymentId: "klkjhgfdsdtyuio1kjh2g" terminalId: "1234567" arn: "12345678909876543212451" rrn: "987654321234" reasonCode: "4837" status: "Нужен ответ" chargebackStage: "Чарджбэк" retentionDate: "2023-02-10" moneyTransferDate: "2023-02-10" text: "Добрый день! По указанной ниже операции поступила претенз\ ия от держателя карты. Он утверждает, что данную операцию не с\ овершал." deadline: "2023-02-14" attachments: - "d7cf8082-8f8c-47a8-v80a-51aac30ba315/example.png" - "80b5a5c0-5a48-4bb8-9f71-0ed9bf8d1955/example.pdf" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b" errorMessage: "Мерчант не подключен к интернет-эквайрингу" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/chargebacks/download/files: post: tags: - "Интернет-эквайринг. Диспуты" summary: "Получить файлы по мерчанту" description: "Метод для получения файлов по определённому мерчанту." operationId: "getFiles" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "files" type: "object" properties: files: maxItems: 20 type: "array" description: "Список ссылок на файлы." items: type: "string" required: true responses: "200": description: "" headers: Content-Disposition: required: true style: "simple" explode: false schema: type: "string" description: "Файл для скачивания." example: "attachment; filename=\"files.zip\"" X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/octet-stream: schema: type: "string" format: "binary" example: "binary data" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b" errorMessage: "Мерчант не подключен к интернет-эквайрингу" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b" errorMessage: "Файл не найден" errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/chargebacks/replies: post: tags: - "Интернет-эквайринг. Диспуты" summary: "Отправить ответы по диспутам" description: "Метод для отправки ответов по диспутам компании. Возвращает ре\ зультаты обработки по каждому ответу." operationId: "saveChargebackReplies" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "chargebacksReply" type: "object" properties: chargebacksReply: maxItems: 100 type: "array" description: "Ответы компании на диспуты." items: required: - "arn" - "channel" - "isAccepted" - "paymentId" - "replyText" type: "object" properties: channel: type: "string" description: "Канал:\n- `ON-US` — карты Тинькофф;\n- `OFF-US`\ \ — карты сторонних банков." enum: - "ON-US" - "OFF-US" arn: maxLength: 100 type: "string" description: "Acquirer Reference Number." paymentId: maxLength: 100 type: "string" description: "Идентификатор платежа (orderId)." isAccepted: type: "boolean" description: "Флаг, согласна ли компания с чарджбэком. Для\ \ `true` передайте сумму в параметре `acceptedAmount`." acceptedAmount: type: "number" description: "Сумма, которую компания готова возместить кл\ иенту." replyText: maxLength: 5000 type: "string" description: "Текст ответа на диспут." replyAttachments: maxItems: 100 type: "array" description: "Файлы, прикрепленные к ответу." items: maxLength: 1000 type: "string" description: "В процессе доработок. Передайте ссылки на\ \ файлы в любом облачном хранилище или сами файлы поба\ йтово." description: "Ответ компании на диспут." description: "Запрос от компании по отправке ответов на диспуты." required: true responses: "200": description: "OK" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "data" type: "object" properties: message: maxLength: 300 type: "string" description: "Результат обработки запроса." data: maxItems: 100 type: "array" description: "Информация по каждому диспуту." items: required: - "channel" - "paymentId" - "result" type: "object" properties: channel: type: "string" description: "Канал:\n- `ON-US` — карты Тинькофф;\n- `OFF-US`\ \ — карты сторонних банков." enum: - "ON-US" - "OFF-US" arn: maxLength: 100 type: "string" description: "Acquirer Reference Number." paymentId: maxLength: 100 type: "string" description: "Идентификатор платежа (orderId)." result: type: "string" description: "Результат обработки ответа по конкретному\ \ диспуту." enum: - "OK" - "ERROR" resultMessage: maxLength: 300 type: "string" description: "Текст ошибки." description: "Результат обработки каждого ответа компании на\ \ диспут." description: "Информация по каждому диспуту." example: message: "OK" data: - channel: "ON-US" arn: "12345678909876543212345" paymentId: "rtyuio2hj34k5h6lgee" result: "OK" - channel: "OFF-US" arn: "0987654321234567890987" paymentId: "1111udfifjdj9922jjl" result: "ERROR" resultMessage: "acceptedAmt больше, чем сумма чарджбэка" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b" errorMessage: "Мерчант не подключен к интернет-эквайрингу" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/chargebacks/upload-files: post: tags: - "Интернет-эквайринг. Диспуты" summary: "Загрузить файлы" description: "Метод для загрузки файлов мерчантом." operationId: "uploadFiles" parameters: - name: "Content-Disposition" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Имя загружаемого файла." example: "attachment; filename=\"file.pdf\"" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/octet-stream: schema: type: "string" format: "binary" example: "binary data" responses: "200": description: "OK" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: maxItems: 10 type: "array" items: required: - "fileName" - "path" type: "object" properties: fileName: maxLength: 300 type: "string" description: "Оригинальное название файла." path: maxLength: 300 type: "string" description: "ID файла в нашей системе." examples: Ссылки на файлы: value: - fileName: "order.jpg" path: "ba73db63-7b54-4e3c-822c-480f65e09124.jpg" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b" errorMessage: "Мерчант не подключен к интернет-эквайрингу" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/company: get: tags: - "Tinkoff Business ID. Информация о компании" summary: "Получить информацию о компании" description: "Метод для получения информации о компании — название, город, р\ еквизиты, банк, ОПФ, система налогообложения." operationId: "getApiV1Company" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Информация о компании" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "bank" - "city" - "name" - "requisites" type: "object" properties: name: maxLength: 1000 type: "string" description: "Название компании." city: maxLength: 1000 type: "string" description: "Город." requisites: required: - "address" - "fullName" - "inn" type: "object" properties: fullName: maxLength: 1000 type: "string" description: "Полное название компании." foreignName: maxLength: 1000 type: "string" description: "Зарубежное название компании." address: maxLength: 3000 type: "string" description: "Адрес." inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН." kpp: maxLength: 20 type: "string" description: "КПП." ogrn: maxLength: 100 type: "string" description: "ОГРН." description: "Реквизиты компании." bank: required: - "bankAddress" - "bankBic" - "bankInn" - "bankName" - "corrAccount" type: "object" properties: bankName: maxLength: 1000 type: "string" description: "Название банка." bankAddress: maxLength: 3000 type: "string" description: "Адрес банка." corrAccount: maxLength: 100 type: "string" description: "Корреспондентский счёт." bankInn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН." bankBic: maxLength: 100 type: "string" description: "БИК." description: "Информация о банке." registrationDate: type: "string" description: "Дата регистрации." format: "date" opf: maxLength: 100 type: "string" description: "Организационно-правовая форма." taxationScheme: type: "string" description: "Система налогообложения: \n\n* `USN_INCOMES` — у\ прощённая система налогообложения;\n * `USN_INCOMES_MINUS_EXPENSES`\ \ — УСН «Доходы минус расходы»;\n * `AUSN_INCOMES` — автомат\ изированная УСН;\n * `AUSN_INCOMES_MINUS_EXPENSES` — автомат\ изированная УСН «Доходы минус расходы»;\n * `OSNO` — общая с\ истема налогообложения;\n * `NPD` — налог на профессиональны\ й доход;\n * `ESHN` — единый сельскохозяйственный налог;\n *\ \ `NPD` — единый налог на вменённый доход для отдельных видо\ в деятельности." enum: - "USN_INCOMES" - "USN_INCOMES_MINUS_EXPENSES" - "AUSN_INCOMES_MINUS_EXPENSES" - "AUSN_INCOMES" - "OSNO" - "NPD" - "ESHN" - "ENVD" example: name: "ООО \"Рога и Копыта\"" city: "Москва" requisites: fullName: "Общество с ограниченной ответственностью \"Рога и Коп\ ыта\"" address: "г. Москва" inn: "1234567890" kpp: "123456789" ogrn: "5183493905840938503" bank: bankName: "Воскресенье" bankAddress: "г. Москва, ул. Правобережная 8" corrAccount: "85452134134134" bankInn: "1234567890" bankBic: "68590468905486" registrationDate: "2019-01-01" taxationScheme: "OSNO" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/contracts: get: tags: - "Проверка контрагентов" summary: "Получить список контрактов" description: "Метод для получения списка контрактов." operationId: "getApiV1CounterpartyContracts" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "limit" in: "query" required: true style: "form" explode: true schema: maximum: 100 minimum: 1 type: "integer" format: "int32" - name: "offset" in: "query" required: true style: "form" explode: true schema: type: "integer" format: "int32" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "data" type: "object" properties: companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." data: required: - "items" - "total" type: "object" properties: total: type: "integer" format: "int64" items: maxItems: 100 type: "array" items: required: - "contractId" - "counterpartyOgrn" - "role" type: "object" properties: contractId: pattern: "^(\\d{19})$" type: "string" counterpartyOgrn: pattern: "^\\d{13,15}$" type: "string" purchaseObjectTypeName: type: "string" format: "string" nullable: true stageCode: type: "string" description: "Статус контракта:\\n* execution - испо\ лнение\\n* stopped - аннулировано\\n* completed -\ \ исполнение завершено\\n* canceled - исполнение п\ рекращено\\n* unknown - неизвестный статус" enum: - "execution" - "completed" - "canceled" - "stopped" - "unknown" role: type: "string" description: "Роль в контракте." enum: - "supplier" - "customer" price: type: "number" format: "double" nullable: true description: "Гос. контракты компании." example: companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"Название\"" fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"Название\"" dateReg: "1990-06-21" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, г Москва, ул Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "relatedCompanies" - page: "feedback" - page: "financialStatements" data: total: 164 items: - contractId: "0173200000000000071" counterpartyOgrn: "1000000000000" purchaseObjectTypeName: "Услуги" stageCode: "completed" role: "supplier" price: 612000 - contractId: "1490000000000000006" counterpartyOgrn: "1000000000000" purchaseObjectTypeName: "Услуги" stageCode: "execution" role: "supplier" price: 664976 - contractId: "1870000000000000002" counterpartyOgrn: "1000000000000" purchaseObjectTypeName: "Услуги" stageCode: "execution" role: "supplier" price: 6000000 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/excerpt: get: tags: - "Проверка контрагентов" summary: "Получить общую выписку для проверки контрагента" description: "Метод для получения выписки по контрагенту — тип компании, вып\ иска по организации, выписка по ИП, общая информация о компании." operationId: "getApiV1CounterpartyExcerpt" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "companyType" - "excerpt" type: "object" properties: companyType: type: "string" description: "Тип компании." enum: - "entrepreneur" - "company" companyExcerpt: required: - "address" - "bankruptcyMessage" - "expressExcerpt" - "fts" - "includeInList" - "leaders" - "okved" - "phones" type: "object" properties: shortName: maxLength: 1000 type: "string" description: "Краткое наименование компании." nullable: true inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН." nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" description: "ОГРН." nullable: true okpo: pattern: "^(\\d{8}|\\d{10})$" type: "string" description: "ОКПО." nullable: true isActing: type: "boolean" description: "Признак действующей компании." nullable: true normName: maxLength: 1000 type: "string" description: "Нормализованное наименование компании." nullable: true shortNameRus: maxLength: 1000 type: "string" description: "Краткое наименование компании." nullable: true shortNameEn: maxLength: 1000 type: "string" description: "Краткое наименование компании на английском\ \ языке." nullable: true dateFirstReg: type: "string" description: "Дата регистрации." format: "date" nullable: true fullNameRus: maxLength: 1000 type: "string" description: "Полное наименование компании на русском." nullable: true kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." nullable: true bik: pattern: "^(\\d{9}|0)$" type: "string" description: "БИК." nullable: true email: type: "string" description: "Электронная почта." format: "email" nullable: true www: maxLength: 512 type: "string" nullable: true registerNumber: maxLength: 512 type: "string" description: "Регистрационный номер." nullable: true okato: required: - "value" type: "object" properties: value: type: "string" format: "string" code: pattern: "^(\\d{2,11})$" type: "string" nullable: true regionName: maxLength: 512 type: "string" description: "Название региона." nullable: true regionCode: type: "integer" description: "Код региона." format: "int32" nullable: true description: "ОКАТО." status: required: - "code" - "isActing" type: "object" properties: isActing: type: "boolean" date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true text: type: "string" format: "string" nullable: true type: type: "string" format: "string" nullable: true code: type: "integer" format: "int32" groupId: type: "integer" format: "int32" nullable: true groupName: type: "string" format: "string" nullable: true description: "Статус." phones: maxItems: 200 type: "array" items: type: "object" properties: code: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператора)." nullable: true number: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true description: "Номера телефонов." finance: type: "object" properties: balanceType: type: "integer" format: "int64" nullable: true periods: maxItems: 200 type: "array" description: "Бухгалтерская отчётность." nullable: true items: type: "object" properties: periodName: maxLength: 512 type: "string" description: "Отчётный период." nullable: true dateBegin: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" description: "Начало периода." format: "string" nullable: true dateEnd: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" description: "Конец периода." format: "string" nullable: true data: maxItems: 200 type: "array" nullable: true items: type: "object" properties: form: maxLength: 512 type: "string" description: "Форма." nullable: true section: maxLength: 512 type: "string" description: "Раздел." nullable: true name: maxLength: 512 type: "string" description: "Наименование." nullable: true code: maxLength: 512 type: "string" description: "Код." nullable: true value: maxLength: 512 type: "string" description: "Значение." nullable: true id: type: "integer" description: "Идентификатор списка." format: "int32" nullable: true leaders: maxItems: 200 type: "array" description: "Руководители." items: type: "object" properties: actualDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" description: "Дата актуальности." format: "string" nullable: true name: type: "string" description: "Наименование." format: "string" nullable: true position: type: "string" description: "Должность." format: "string" nullable: true managementCompany: type: "string" format: "string" nullable: true managementCompanyINN: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true structure: type: "object" properties: countCoownerFCSM: type: "integer" description: "Количество совладельцев (данные компании\ /ФСФР)." format: "int32" nullable: true countCoownerRosstat: type: "integer" description: "Количество совладельцев (Росстат)." format: "int32" nullable: true countCoownerEGRUL: type: "integer" description: "Количество совладельцев (ЕГРЮЛ)." format: "int32" nullable: true countBranch: type: "integer" description: "Количество филиалов (данные компании)." format: "int32" nullable: true countBranchRosstat: type: "integer" description: "Количество филиалов (Росстат)." format: "int32" nullable: true countBranchEGRUL: type: "integer" description: "Количество филиалов (ЕГРЮЛ)." format: "int32" nullable: true countCoownerDKCPFR: type: "integer" format: "int32" nullable: true countCoownerUkrStat: type: "integer" format: "int32" nullable: true countAffiliatedCompany: type: "integer" format: "int32" nullable: true countAffiliatedCompanyFCSM: type: "integer" description: "Количество дочерних компаний (данные ком\ пании)." format: "int32" nullable: true countAffiliatedCompanyRosstat: type: "integer" description: "Количество дочерних компаний (Росстат)." format: "int32" nullable: true countAffiliatedCompanyEGRUL: type: "integer" description: "Количество дочерних компаний (ЕГРЮЛ)." format: "int32" nullable: true nonprofitOrganizationRosstat: type: "integer" description: "Количество некоммерческих партнерств (Ро\ сстат)." format: "int32" nullable: true activeBranchesRosstatNumber: type: "integer" format: "int32" nullable: true activeAffiliatedCompaniesNumber: type: "integer" format: "int32" nullable: true proceedings: required: - "active" - "executed" type: "object" properties: active: type: "integer" description: "Количество непогашенных обязательств." format: "int32" executed: type: "integer" description: "Количество погашенных обязательств." format: "int32" charterCapital: type: "object" properties: value: maxLength: 512 type: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true currencyCode: maxLength: 512 type: "string" nullable: true currencyName: maxLength: 512 type: "string" nullable: true charterCapitalHistory: maxItems: 200 type: "array" description: "История изменения уставного капитала." nullable: true items: type: "object" properties: value: maxLength: 512 type: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true currencyCode: maxLength: 512 type: "string" nullable: true currencyName: maxLength: 512 type: "string" nullable: true companyWithSameInfo: type: "object" properties: telephoneCount: required: - "value" type: "object" properties: value: type: "integer" format: "int32" phoneCode: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператора)." nullable: true phoneNumber: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true phoneList: maxItems: 500 type: "array" nullable: true items: required: - "value" type: "object" properties: value: type: "integer" format: "int32" phoneCode: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператора\ )." nullable: true phoneNumber: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true addressCount: type: "integer" format: "int32" nullable: true addressWithoutRoomCount: type: "integer" format: "int32" nullable: true addressNotAffiliatedCount: type: "integer" format: "int32" nullable: true addressFTSCount: type: "integer" format: "int32" nullable: true managerCountInCountry: type: "integer" format: "int32" nullable: true managerCountInRegion: type: "integer" format: "int32" nullable: true managerInnCount: type: "integer" format: "int32" nullable: true companyLiquidatedWithSameInfo: type: "object" properties: addressCount: type: "integer" format: "int32" nullable: true addressWithoutRoomCount: type: "integer" format: "int32" nullable: true arbitrationCases: type: "object" properties: cases: maxItems: 200 type: "array" nullable: true items: required: - "defendant" - "plaintiff" - "thirdOrOtherPerson" - "year" type: "object" properties: year: type: "integer" format: "int32" plaintiff: required: - "casesNumber" - "sum" type: "object" properties: casesNumber: type: "integer" format: "int32" sum: type: "string" format: "string" defendant: required: - "casesNumber" - "sum" type: "object" properties: casesNumber: type: "integer" format: "int32" sum: type: "string" format: "string" thirdOrOtherPerson: required: - "casesNumber" type: "object" properties: casesNumber: type: "integer" format: "int32" total: type: "integer" format: "int32" nullable: true considered: type: "integer" format: "int32" nullable: true appealed: type: "integer" format: "int32" nullable: true decisionsAndRulings: type: "integer" format: "int32" nullable: true completed: type: "integer" format: "int32" nullable: true federalTaxRegistrationPayment: type: "object" properties: regDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true regAuthority: maxLength: 1000 type: "string" nullable: true regAuthorityAddress: maxLength: 1000 type: "string" nullable: true regAuthorityCode: maxLength: 512 type: "string" nullable: true federalTaxRegistrationCurrent: type: "object" properties: regDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true regAuthority: maxLength: 1000 type: "string" nullable: true regAuthorityAddress: maxLength: 1000 type: "string" nullable: true regAuthorityCode: maxLength: 512 type: "string" nullable: true okved: maxItems: 2500 type: "array" description: "ОКВЭД." items: required: - "isMain" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" description: "Код." nullable: true name: maxLength: 1000 type: "string" description: "Наименование." nullable: true isMain: type: "boolean" description: "Признак основного ОКВЭД." isMainEgrul: type: "boolean" description: "Признак основного ОКВЭД по данным ЕГРЮ\ Л." nullable: true isMainRosstat: type: "boolean" description: "Признак основного ОКВЭД по данным Росс\ тата." nullable: true stateContracts: type: "object" properties: federalLaw94: maxItems: 200 type: "array" description: "Данные о госконтрактах за соответствующи\ й год." nullable: true items: required: - "year" type: "object" properties: year: type: "integer" description: "Значение года." format: "int32" tenders: type: "object" properties: admittedNumber: type: "integer" description: "Число допусков к тендеру." format: "int32" nullable: true notAdmittedNumber: type: "integer" description: "Число недопусков к тендеру." format: "int32" nullable: true winnerNumber: type: "integer" description: "Число выигрышей тендеров." format: "int32" nullable: true contracts: type: "object" properties: signedNumber: type: "integer" description: "Число подписанных контрактов" format: "int32" nullable: true sum: type: "string" description: "Контрактов подписано на сумму\ , рубли." format: "string" nullable: true federalLaw223: maxItems: 200 type: "array" description: "Данные о тендерах за соответствующий год\ ." nullable: true items: required: - "year" type: "object" properties: year: type: "integer" description: "Значение года." format: "int32" tenders: type: "object" properties: admittedNumber: type: "integer" description: "Число допусков к тендеру." format: "int32" nullable: true notAdmittedNumber: type: "integer" description: "Число недопусков к тендеру." format: "int32" nullable: true winnerNumber: type: "integer" description: "Число выигрышей тендеров." format: "int32" nullable: true contracts: type: "object" properties: signedNumber: type: "integer" description: "Число подписанных контрактов" format: "int32" nullable: true sum: type: "string" description: "Контрактов подписано на сумму\ , рубли." format: "string" nullable: true address: maxItems: 200 type: "array" description: "Местонахождение." items: type: "object" properties: postCode: pattern: "^(\\d{6})$" type: "string" nullable: true address: maxLength: 1000 type: "string" nullable: true streetName: maxLength: 1000 type: "string" nullable: true buildingNumber: maxLength: 512 type: "string" nullable: true fiasGUID: type: "string" format: "uuid" nullable: true isHouseFiasGUID: type: "boolean" nullable: true fiasCode: maxLength: 512 type: "string" nullable: true fiasRegion: maxLength: 512 type: "string" nullable: true fiasArea: maxLength: 512 type: "string" nullable: true fiasCity: maxLength: 512 type: "string" nullable: true fiasPlace: maxLength: 512 type: "string" nullable: true fiasPlan: maxLength: 512 type: "string" nullable: true fiasStreet: maxLength: 512 type: "string" nullable: true actualDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true buildingType: maxLength: 512 type: "string" nullable: true businessCenterName: maxLength: 512 type: "string" nullable: true fts: maxItems: 200 type: "array" items: type: "object" properties: endDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" description: "Контрактов подписано на сумму, рубли." format: "string" nullable: true income: type: "string" format: "string" nullable: true expenses: type: "string" format: "string" nullable: true taxes: type: "object" properties: sum: type: "string" format: "string" nullable: true tax: maxItems: 200 type: "array" nullable: true items: type: "object" properties: id: type: "integer" format: "int32" nullable: true name: type: "string" format: "string" nullable: true sum: type: "string" format: "string" nullable: true taxArrears: type: "object" properties: tax: maxItems: 200 type: "array" nullable: true items: required: - "id" type: "object" properties: id: type: "integer" description: "Идентификатор налога/сбора." format: "int64" name: type: "string" description: "Наименование налога/сбора." format: "string" nullable: true finesSum: type: "string" description: "Сумма задолженности по пени." format: "string" nullable: true penaltiesSum: type: "string" description: "Сумма задолженности по штраф\ ам." format: "string" nullable: true sum: type: "string" format: "string" nullable: true taxPenalties: type: "object" properties: sum: type: "string" format: "string" nullable: true includeInList: maxItems: 200 type: "array" items: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true bankruptcyMessage: maxItems: 1000 type: "array" items: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true expressExcerpt: required: - "companyType" - "frozenAccountDecisions" - "negativeLists" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН" nullable: true companyType: type: "string" description: "Тип компании." enum: - "entrepreneur" - "company" companyWithSameInfo: required: - "sameAddress" - "sameManager" - "samePhone" type: "object" properties: sameManager: type: "object" properties: manager: maxLength: 512 type: "string" nullable: true managerCountInCountry: type: "integer" format: "int32" nullable: true managerInnCount: type: "integer" format: "int32" nullable: true sameAddress: type: "object" properties: address: maxLength: 1000 type: "string" nullable: true addressCount: type: "integer" format: "int32" nullable: true samePhone: type: "object" properties: phoneCode: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператор\ а)." nullable: true phoneNumber: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true phoneCount: type: "integer" format: "int32" nullable: true negativeLists: maxItems: 200 type: "array" description: "Негативные списки, в которых состоит ком\ пания." items: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true status: required: - "code" - "isActing" type: "object" properties: isActing: type: "boolean" date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true text: type: "string" format: "string" nullable: true type: type: "string" format: "string" nullable: true code: type: "integer" format: "int32" groupId: type: "integer" format: "int32" nullable: true groupName: type: "string" format: "string" nullable: true description: "Статус." okvedInfo: required: - "okvedCount" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" nullable: true name: type: "string" format: "string" nullable: true okvedCount: type: "integer" format: "int32" netIncome: required: - "dateBegin" - "dateEnd" - "periodName" - "sum" type: "object" properties: periodName: maxLength: 512 type: "string" dateBegin: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" dateEnd: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" sum: maxLength: 512 type: "string" taxYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" financeYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" stateContractYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" activeProceedingsCount: type: "integer" description: "Количество активных исполнительных произ\ водств (долгов)." format: "int32" nullable: true bankruptcyMessage: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true frozenAccountDecisions: maxItems: 200 type: "array" description: "Есть решение о приостановлении операций\ \ по счетам." items: type: "object" properties: sparkId: required: - "isEven" - "isOne" - "isPowerOfTwo" - "isZero" - "sign" type: "object" properties: isPowerOfTwo: type: "boolean" readOnly: true isZero: type: "boolean" readOnly: true isOne: type: "boolean" readOnly: true isEven: type: "boolean" readOnly: true sign: type: "integer" format: "int32" readOnly: true reason: type: "object" properties: id: type: "integer" format: "int32" nullable: true name: maxLength: 1000 type: "string" nullable: true taxAuthority: type: "object" properties: code: maxLength: 512 type: "string" nullable: true name: maxLength: 1000 type: "string" nullable: true bank: type: "object" properties: sparkId: required: - "isEven" - "isOne" - "isPowerOfTwo" - "isZero" - "sign" type: "object" properties: isPowerOfTwo: type: "boolean" readOnly: true isZero: type: "boolean" readOnly: true isOne: type: "boolean" readOnly: true isEven: type: "boolean" readOnly: true sign: type: "integer" format: "int32" readOnly: true bik: pattern: "^(\\d{9}|0)$" type: "string" nullable: true name: maxLength: 512 type: "string" nullable: true number: maxLength: 512 type: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true arbitrationCasesInfo: required: - "count" - "year" type: "object" properties: year: type: "integer" format: "int32" count: type: "integer" format: "int32" description: "Выписка по организации." entrepreneurExcerpt: required: - "bankruptcyMessage" - "expressExcerpt" - "includeInList" - "okved" - "phoneList" - "submittedStatements" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrnip: pattern: "^\\d{15}$" type: "string" nullable: true okpo: pattern: "^(\\d{8}|\\d{10})$" type: "string" nullable: true birthDate: type: "string" format: "date" nullable: true birthPlace: type: "string" format: "string" nullable: true fullNameRus: type: "string" format: "string" nullable: true sex: type: "string" enum: - "man" - "woman" - "undefined" dateReg: type: "string" format: "date" nullable: true okato: required: - "value" type: "object" properties: value: type: "string" format: "string" code: pattern: "^(\\d{2,11})$" type: "string" nullable: true regionName: maxLength: 512 type: "string" description: "Название региона." nullable: true regionCode: type: "integer" description: "Код региона." format: "int32" nullable: true description: "ОКАТО." okopf: type: "object" properties: code: pattern: "^(\\d{5})$" type: "string" nullable: true name: maxLength: 512 type: "string" nullable: true phoneList: maxItems: 200 type: "array" items: type: "object" properties: code: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператора)." nullable: true number: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true description: "Номера телефонов." status: required: - "code" - "isActing" type: "object" properties: isActing: type: "boolean" date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true text: type: "string" format: "string" nullable: true type: type: "string" format: "string" nullable: true code: type: "integer" format: "int32" groupId: type: "integer" format: "int32" nullable: true groupName: type: "string" format: "string" nullable: true description: "Статус." includeInList: maxItems: 200 type: "array" items: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true federalTaxRegistrationPayment: type: "object" properties: regDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true regAuthority: maxLength: 1000 type: "string" nullable: true regAuthorityAddress: maxLength: 1000 type: "string" nullable: true regAuthorityCode: maxLength: 512 type: "string" nullable: true federalTaxRegistrationCurrent: type: "object" properties: regDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true regAuthority: maxLength: 1000 type: "string" nullable: true regAuthorityAddress: maxLength: 1000 type: "string" nullable: true regAuthorityCode: maxLength: 512 type: "string" nullable: true citizenship: required: - "code" - "name" type: "object" properties: code: type: "integer" format: "int32" name: type: "string" format: "string" okved: maxItems: 2500 type: "array" items: required: - "isMain" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" description: "Код." nullable: true name: maxLength: 1000 type: "string" description: "Наименование." nullable: true isMain: type: "boolean" description: "Признак основного ОКВЭД." isMainEgrul: type: "boolean" description: "Признак основного ОКВЭД по данным ЕГРЮ\ Л." nullable: true isMainRosstat: type: "boolean" description: "Признак основного ОКВЭД по данным Росс\ тата." nullable: true registrationInFunds: type: "object" properties: pensionFund: required: - "regAuthority" - "registerNumber" - "registrationDate" type: "object" properties: registrationDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" deregistrationDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true registerNumber: type: "string" format: "string" regAuthority: type: "string" format: "string" socialInsuranceFund: required: - "regAuthority" - "registerNumber" - "registrationDate" type: "object" properties: registrationDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" deregistrationDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true registerNumber: type: "string" format: "string" regAuthority: type: "string" format: "string" compulsoryMedicalInsuranceFund: required: - "regAuthority" - "registerNumber" - "registrationDate" type: "object" properties: registrationDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" deregistrationDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true registerNumber: type: "string" format: "string" regAuthority: type: "string" format: "string" submittedStatements: maxItems: 200 type: "array" items: type: "object" properties: form: type: "string" format: "string" nullable: true submissionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true availabilityDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" nullable: true grn: type: "string" format: "string" nullable: true decisionType: type: "string" format: "string" nullable: true stateContracts: type: "object" properties: federalLaw94: maxItems: 200 type: "array" description: "Данные о госконтрактах за соответствующи\ й год." nullable: true items: required: - "year" type: "object" properties: year: type: "integer" description: "Значение года." format: "int32" tenders: type: "object" properties: admittedNumber: type: "integer" description: "Число допусков к тендеру." format: "int32" nullable: true notAdmittedNumber: type: "integer" description: "Число недопусков к тендеру." format: "int32" nullable: true winnerNumber: type: "integer" description: "Число выигрышей тендеров." format: "int32" nullable: true contracts: type: "object" properties: signedNumber: type: "integer" description: "Число подписанных контрактов" format: "int32" nullable: true sum: type: "string" description: "Контрактов подписано на сумму\ , рубли." format: "string" nullable: true federalLaw223: maxItems: 200 type: "array" description: "Данные о тендерах за соответствующий год\ ." nullable: true items: required: - "year" type: "object" properties: year: type: "integer" description: "Значение года." format: "int32" tenders: type: "object" properties: admittedNumber: type: "integer" description: "Число допусков к тендеру." format: "int32" nullable: true notAdmittedNumber: type: "integer" description: "Число недопусков к тендеру." format: "int32" nullable: true winnerNumber: type: "integer" description: "Число выигрышей тендеров." format: "int32" nullable: true contracts: type: "object" properties: signedNumber: type: "integer" description: "Число подписанных контрактов" format: "int32" nullable: true sum: type: "string" description: "Контрактов подписано на сумму\ , рубли." format: "string" nullable: true arbitrationCases: type: "object" properties: cases: maxItems: 200 type: "array" nullable: true items: required: - "defendant" - "plaintiff" - "thirdOrOtherPerson" - "year" type: "object" properties: year: type: "integer" format: "int32" plaintiff: required: - "casesNumber" - "sum" type: "object" properties: casesNumber: type: "integer" format: "int32" sum: type: "string" format: "string" defendant: required: - "casesNumber" - "sum" type: "object" properties: casesNumber: type: "integer" format: "int32" sum: type: "string" format: "string" thirdOrOtherPerson: required: - "casesNumber" type: "object" properties: casesNumber: type: "integer" format: "int32" total: type: "integer" format: "int32" nullable: true considered: type: "integer" format: "int32" nullable: true appealed: type: "integer" format: "int32" nullable: true decisionsAndRulings: type: "integer" format: "int32" nullable: true completed: type: "integer" format: "int32" nullable: true executionProceedings: required: - "active" - "executed" type: "object" properties: active: type: "integer" description: "Количество непогашенных обязательств." format: "int32" executed: type: "integer" description: "Количество погашенных обязательств." format: "int32" bankruptcyMessage: maxItems: 1000 type: "array" items: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true expressExcerpt: required: - "companyType" - "frozenAccountDecisions" - "negativeLists" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН" nullable: true companyType: type: "string" description: "Тип компании." enum: - "entrepreneur" - "company" companyWithSameInfo: required: - "sameAddress" - "sameManager" - "samePhone" type: "object" properties: sameManager: type: "object" properties: manager: maxLength: 512 type: "string" nullable: true managerCountInCountry: type: "integer" format: "int32" nullable: true managerInnCount: type: "integer" format: "int32" nullable: true sameAddress: type: "object" properties: address: maxLength: 1000 type: "string" nullable: true addressCount: type: "integer" format: "int32" nullable: true samePhone: type: "object" properties: phoneCode: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператор\ а)." nullable: true phoneNumber: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true phoneCount: type: "integer" format: "int32" nullable: true negativeLists: maxItems: 200 type: "array" description: "Негативные списки, в которых состоит ком\ пания." items: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true status: required: - "code" - "isActing" type: "object" properties: isActing: type: "boolean" date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true text: type: "string" format: "string" nullable: true type: type: "string" format: "string" nullable: true code: type: "integer" format: "int32" groupId: type: "integer" format: "int32" nullable: true groupName: type: "string" format: "string" nullable: true description: "Статус." okvedInfo: required: - "okvedCount" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" nullable: true name: type: "string" format: "string" nullable: true okvedCount: type: "integer" format: "int32" netIncome: required: - "dateBegin" - "dateEnd" - "periodName" - "sum" type: "object" properties: periodName: maxLength: 512 type: "string" dateBegin: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" dateEnd: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" sum: maxLength: 512 type: "string" taxYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" financeYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" stateContractYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" activeProceedingsCount: type: "integer" description: "Количество активных исполнительных произ\ водств (долгов)." format: "int32" nullable: true bankruptcyMessage: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true frozenAccountDecisions: maxItems: 200 type: "array" description: "Есть решение о приостановлении операций\ \ по счетам." items: type: "object" properties: sparkId: required: - "isEven" - "isOne" - "isPowerOfTwo" - "isZero" - "sign" type: "object" properties: isPowerOfTwo: type: "boolean" readOnly: true isZero: type: "boolean" readOnly: true isOne: type: "boolean" readOnly: true isEven: type: "boolean" readOnly: true sign: type: "integer" format: "int32" readOnly: true reason: type: "object" properties: id: type: "integer" format: "int32" nullable: true name: maxLength: 1000 type: "string" nullable: true taxAuthority: type: "object" properties: code: maxLength: 512 type: "string" nullable: true name: maxLength: 1000 type: "string" nullable: true bank: type: "object" properties: sparkId: required: - "isEven" - "isOne" - "isPowerOfTwo" - "isZero" - "sign" type: "object" properties: isPowerOfTwo: type: "boolean" readOnly: true isZero: type: "boolean" readOnly: true isOne: type: "boolean" readOnly: true isEven: type: "boolean" readOnly: true sign: type: "integer" format: "int32" readOnly: true bik: pattern: "^(\\d{9}|0)$" type: "string" nullable: true name: maxLength: 512 type: "string" nullable: true number: maxLength: 512 type: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true arbitrationCasesInfo: required: - "count" - "year" type: "object" properties: year: type: "integer" format: "int32" count: type: "integer" format: "int32" description: "Выписка по ИП." companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." excerpt: required: - "checkResult" - "contractSummary" - "contracts" - "financialStatementsResponse" - "founders" - "history" - "leaders" - "licenseSummary" - "licenses" - "okvedSummary" - "relatedCompanies" - "relationSummary" - "requisites" - "trafficLightColors" type: "object" properties: requisites: type: "object" properties: legalForm: type: "string" format: "string" nullable: true organizationSizeDesc: type: "string" format: "string" nullable: true entityRegistrationDate: type: "string" format: "date" nullable: true regAuthorityAddressTxt: type: "string" format: "string" nullable: true regAuthorityName: type: "string" format: "string" nullable: true pfrRegistrationNumber: type: "string" format: "string" nullable: true pfrAuthorityName: type: "string" format: "string" nullable: true pfrRegistrationDate: type: "string" format: "date" nullable: true insRegistrationNumber: type: "string" format: "string" nullable: true insAuthorityName: type: "string" format: "string" nullable: true insRegistrationDate: type: "string" format: "date" nullable: true description: "Дополнительные реквизиты." okvedSummary: required: - "additional" - "count" - "main" type: "object" properties: count: type: "integer" format: "int64" main: maxItems: 100 type: "array" items: required: - "code" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" description: type: "string" format: "string" nullable: true description: "ОКВЭД." additional: maxItems: 100 type: "array" items: required: - "code" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" description: type: "string" format: "string" nullable: true description: "ОКВЭД." description: "ОКВЭДы." contractSummary: required: - "admittedCount" - "count" - "notAdmittedCount" type: "object" properties: count: type: "integer" format: "int64" admittedCount: type: "integer" format: "int64" notAdmittedCount: type: "integer" format: "int64" totalValue: type: "number" format: "double" nullable: true description: "Гос. контракты." licenseSummary: required: - "active" - "inactive" - "total" type: "object" properties: total: type: "integer" format: "int64" active: type: "integer" format: "int64" inactive: type: "integer" format: "int64" description: "Количество лицензий." trafficLightColors: required: - "greenCount" - "redCount" - "yellowCount" type: "object" properties: redCount: type: "integer" format: "int32" yellowCount: type: "integer" format: "int32" greenCount: type: "integer" format: "int32" description: "Результаты экспресс-проверки." innerCheckResult: required: - "activeProceedings" - "bankruptcyMessage" - "defendant" - "defendantDynamic" - "disqualifiedPersons" - "executedProceedings" - "finance" - "invalidLegalAddress" - "isNegative" - "plaintiff" - "sameAddressNumber" - "sameManager" - "taxDebt" - "taxReport" - "thirdOrOtherPerson" - "unfairSupplier" type: "object" properties: bankruptcyMessage: required: - "color" type: "object" properties: value: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\ d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\ d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." plaintiff: required: - "color" type: "object" properties: value: required: - "maxDate" - "minDate" - "totalCases" type: "object" properties: minDate: type: "integer" description: "Наименьший год с судебными делам\ и." format: "int32" maxDate: type: "integer" description: "Наибольший год с судебными делам\ и." format: "int32" totalCases: type: "integer" format: "int32" description: "Статистика по судебным делам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." thirdOrOtherPerson: required: - "color" type: "object" properties: value: required: - "maxDate" - "minDate" - "totalCases" type: "object" properties: minDate: type: "integer" description: "Наименьший год с судебными делам\ и." format: "int32" maxDate: type: "integer" description: "Наибольший год с судебными делам\ и." format: "int32" totalCases: type: "integer" format: "int32" description: "Статистика по судебным делам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." defendant: required: - "color" type: "object" properties: value: required: - "maxDate" - "minDate" - "totalCases" type: "object" properties: minDate: type: "integer" description: "Наименьший год с судебными делам\ и." format: "int32" maxDate: type: "integer" description: "Наибольший год с судебными делам\ и." format: "int32" totalCases: type: "integer" format: "int32" description: "Статистика по судебным делам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." defendantDynamic: required: - "color" type: "object" properties: value: required: - "lastYear" - "percent" - "prevLastYear" type: "object" properties: lastYear: type: "integer" format: "int32" prevLastYear: type: "integer" format: "int32" percent: type: "number" format: "double" description: "Динамика судебных дел в качестве отв\ етчика." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." executedProceedings: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." activeProceedings: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." sameManager: required: - "color" type: "object" properties: value: type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true sameManager: type: "object" properties: manager: maxLength: 512 type: "string" nullable: true managerCountInCountry: type: "integer" format: "int32" nullable: true managerInnCount: type: "integer" format: "int32" nullable: true description: "Массовый руководитель." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." sameAddressNumber: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." finance: required: - "color" type: "object" properties: value: type: "object" properties: balanceType: type: "integer" format: "int64" nullable: true periods: maxItems: 200 type: "array" description: "Бухгалтерская отчётность." nullable: true items: type: "object" properties: periodName: maxLength: 512 type: "string" description: "Отчётный период." nullable: true dateBegin: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\ d{2}:\\d{2})|Z)?)$" type: "string" description: "Начало периода." format: "string" nullable: true dateEnd: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\ d{2}:\\d{2})|Z)?)$" type: "string" description: "Конец периода." format: "string" nullable: true data: maxItems: 200 type: "array" nullable: true items: type: "object" properties: form: maxLength: 512 type: "string" description: "Форма." nullable: true section: maxLength: 512 type: "string" description: "Раздел." nullable: true name: maxLength: 512 type: "string" description: "Наименование." nullable: true code: maxLength: 512 type: "string" description: "Код." nullable: true value: maxLength: 512 type: "string" description: "Значение." nullable: true id: type: "integer" description: "Идентификатор списка\ ." format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." isNegative: required: - "color" - "value" type: "object" properties: value: required: - "negativeListsCount" type: "object" properties: negativeListsCount: type: "integer" format: "int32" description: "Статистика негативных списков." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." unfairSupplier: required: - "color" type: "object" properties: value: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." invalidLegalAddress: required: - "color" type: "object" properties: value: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." disqualifiedPersons: required: - "color" type: "object" properties: value: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." taxReport: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." taxDebt: required: - "color" type: "object" properties: value: required: - "statDate" - "sum" type: "object" properties: sum: type: "number" format: "double" statDate: type: "string" format: "date" description: "Налоговая задолженность." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." description: "Результат внутренней проверки компании:\n* `BankruptcyMessage`\ \ — сообщения о банкротстве;\n* `Plaintiff` — судебные д\ ела в качестве истца;\n* `ThirdOrOtherPerson` — судебные\ \ дела в качестве третьего лица;\n* `Defendant` — судебн\ ые дела в качестве ответчика;\n* `DefendantDynamic` — ди\ намика судебных дел в качестве ответчика;\n* `ExecutedProceedings`\ \ — завершённые исполнительные производства;\n* `ActiveProceedings`\ \ — активные исполнительные производства;\n* `SameManager`\ \ — массовый руководитель;\n* `SameAddressNumber` — масс\ овый юридический адрес;\n* `Finance` — бухгалтерская отч\ ётность;\n* `IsNegative` — негативные списки;\n* `UnfairSupplier`\ \ — реестр недобросовестных поставщиков;\n* `InvalidLegalAddress`\ \ — список компаний, отсутствующих по юридическому адрес\ у;\n* `DisqualifiedPersons` — реестр дисквалифицированны\ х лиц;\n* `ReferenceCheckRecommended` — рекомендация про\ верки в справочных источниках;\n* `DueDiligenceRecommended`\ \ — рекомендация проведения документальной проверки (Due\ \ Diligence);\n* `TaxReport` — налоговая отчётность;\n*\ \ `TaxDebt` — налоговая задолженность." checkResult: required: - "admittedContractsAsSupplier" - "authorizedCapitalAmount" - "confidantChangeDate" - "founderChangeDate" - "legalAddressChangeDate" - "legalForm" - "licensedOkvedCount" - "okvedCount" - "registrationDate" - "riskLevel" - "status" type: "object" properties: status: required: - "color" type: "object" properties: value: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." registrationDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." legalAddressChangeDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." founderChangeDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." confidantChangeDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." authorizedCapitalAmount: required: - "color" type: "object" properties: value: type: "number" format: "double" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." admittedContractsAsSupplier: required: - "color" - "value" type: "object" properties: value: required: - "count" type: "object" properties: count: type: "integer" format: "int64" totalValue: type: "number" format: "double" nullable: true description: "Статистика по контрактам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." legalForm: required: - "color" type: "object" properties: value: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." okvedCount: required: - "color" - "value" type: "object" properties: value: type: "integer" format: "int64" color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." licensedOkvedCount: required: - "color" - "value" type: "object" properties: value: type: "integer" format: "int64" color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." riskLevel: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." description: "Проверки:\n* `Status` — статус компании;\n*\ \ `RegistrationDate` — проверка даты регистрации на прев\ ышение трех лет;\n* `LegalAddressChangeDate` — проверка\ \ изменения юридического адреса за последний год;\n* `FounderChangeDate`\ \ — проверка изменения учредителя за последний год;\n* `ConfidantChangeDate`\ \ — проверка изменения руководителя за последний год;\n\ * `AuthorizedCapitalAmount` — проверка превышения уставн\ ого капитала минимального порога;\n* `AdmittedContractsAsSupplier`\ \ — участие в государственных закупках;\n* `LegalForm` —\ \ организационно-правовая форма организации;\n* `OkvedCount`\ \ — количество видов деятельности, превышающих порог;\n\ * `LicensedOkvedCount` — проверка соответствия лицензии\ \ коду ОКВЭД;\n* `RiskLevel` — уровень риска." relationSummary: required: - "relatedByConfidant" - "relatedByFounder" - "total" type: "object" properties: total: type: "integer" format: "int32" relatedByFounder: type: "integer" format: "int32" relatedByConfidant: type: "integer" format: "int32" description: "Связанные компании." relatedCompanies: maxItems: 4 type: "array" items: required: - "ogrn" type: "object" properties: name: type: "string" format: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true description: "Короткое описание связанной компании." leaders: maxItems: 100 type: "array" items: required: - "name" type: "object" properties: actualDate: type: "string" format: "date" nullable: true name: type: "string" format: "string" position: type: "string" format: "string" nullable: true description: "Руководитель." founders: maxItems: 10000 type: "array" items: required: - "name" type: "object" properties: name: type: "string" format: "string" nominalCostAmount: type: "number" format: "double" nullable: true sharePercent: type: "number" format: "double" nullable: true description: "Учредители." history: maxItems: 3 type: "array" items: required: - "oldParamValue" - "paramName" - "paramText" - "paramValue" type: "object" properties: paramText: type: "string" format: "string" changeDate: type: "string" format: "date" nullable: true paramName: type: "string" format: "string" oldParamValue: type: "string" format: "string" paramValue: type: "string" format: "string" description: "Изменённые данные." licenses: maxItems: 3 type: "array" items: required: - "activity" - "address" - "status" type: "object" properties: "no": type: "string" format: "string" nullable: true authorityName: type: "string" format: "string" nullable: true date: type: "string" format: "date" nullable: true startDate: type: "string" format: "date" nullable: true endDate: type: "string" format: "date" nullable: true address: maxItems: 1200 type: "array" items: type: "string" format: "string" activity: maxItems: 100 type: "array" items: type: "string" format: "string" status: type: "string" description: "Статус лицензии." enum: - "active" - "inactive" - "unknown" description: "Лицензия." contracts: maxItems: 3 type: "array" items: required: - "contractId" - "counterpartyOgrn" - "role" type: "object" properties: contractId: pattern: "^(\\d{19})$" type: "string" counterpartyOgrn: pattern: "^\\d{13,15}$" type: "string" purchaseObjectTypeName: type: "string" format: "string" nullable: true stageCode: type: "string" description: "Статус контракта:\\n* execution - испо\ лнение\\n* stopped - аннулировано\\n* completed -\ \ исполнение завершено\\n* canceled - исполнение п\ рекращено\\n* unknown - неизвестный статус" enum: - "execution" - "completed" - "canceled" - "stopped" - "unknown" role: type: "string" description: "Роль в контракте." enum: - "supplier" - "customer" price: type: "number" format: "double" nullable: true description: "Гос. контракты компании." financialStatementsResponse: type: "object" properties: reason: required: - "reasonCode" - "reasonText" type: "object" properties: reasonCode: type: "string" description: "Коды для причин отсутствия финансово\ й отчётности." enum: - "isEntrepreneur" - "lessThanYear" - "noData" reasonText: maxLength: 512 type: "string" description: "Данные о причине отсутствия финансовой о\ тчётности." financialStatementsData: required: - "accountsPayable" - "accountsReceivable" - "profit" - "revenue" - "year" type: "object" properties: year: type: "integer" format: "int32" revenue: required: - "name" - "values" type: "object" properties: name: maxLength: 512 type: "string" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true values: maxItems: 5 type: "array" items: required: - "year" type: "object" properties: year: type: "integer" format: "int32" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true description: "Данные за отчётный период." description: "Выручка." profit: required: - "name" - "values" type: "object" properties: name: maxLength: 512 type: "string" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true values: maxItems: 5 type: "array" items: required: - "year" type: "object" properties: year: type: "integer" format: "int32" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true description: "Данные за отчётный период." description: "Прибыль." accountsPayable: required: - "name" - "values" type: "object" properties: name: maxLength: 512 type: "string" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true values: maxItems: 5 type: "array" items: required: - "year" type: "object" properties: year: type: "integer" format: "int32" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true description: "Данные за отчётный период." description: "Кредиторский долг." accountsReceivable: required: - "name" - "values" type: "object" properties: name: maxLength: 512 type: "string" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true values: maxItems: 5 type: "array" items: required: - "year" type: "object" properties: year: type: "integer" format: "int32" value: type: "integer" format: "int64" nullable: true valueDiff: type: "integer" format: "int64" nullable: true description: "Данные за отчётный период." description: "Дебиторский долг." description: "Финансовая отчётность для excerpt." description: "Обёртка для данных по финансовой отчетности\ \ или для причины их отсутствия." description: "Общая информация о компании." description: "Выписка по компании." example: companyType: "company" companyExcerpt: shortName: null inn: "000000000000" ogrn: "1000000000000" okpo: "0000000000" isActing: true normName: "Название, ОАО" shortNameRus: "ОАО \"Название\"" shortNameEn: "OAO \"Name\"" dateFirstReg: "1999-01-01" fullNameRus: "ОТКРЫТОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\"" kpp: "000000000" bik: "000000000" email: "example@example.ru" www: "www.example.ru" registerNumber: null okato: value: "" code: "00086552000" regionName: "Москва" regionCode: 45 status: isActing: true date: "2023-04-24+03:00" text: null type: "Действующее" code: 24 groupId: 1 groupName: "Действующее" phones: - code: "342" number: "0000000" - code: "384" number: "0000000" - code: "385" number: "0000000" finance: balanceType: 1 periods: - periodName: "2015" dateBegin: "2015-01-01+03:00" dateEnd: "2015-12-31+03:00" data: - form: "Баланс" section: "Актив" name: "Нематериальные активы" code: "1110" value: "554779000" id: 1 - form: "Баланс" section: "Актив" name: "Основные средства" code: "1150" value: "11502405000" id: 5 - form: "Баланс" section: "Актив" name: "Долгосрочные финансовые вложения" code: "1170" value: "13980027000" id: 12 - periodName: "2016" dateBegin: "2016-01-01+03:00" dateEnd: "2016-12-31+03:00" data: - form: "Баланс" section: "Актив" name: "Нематериальные активы" code: "1110" value: "50345000" id: 1 - form: "Баланс" section: "Актив" name: "Основные средства" code: "1150" value: "10687759000" id: 5 - form: "Баланс" section: "Актив" name: "Доходные вложения в материальные ценности" code: "1160" value: "636050000" id: 9 - periodName: "2017" dateBegin: "2017-01-01+03:00" dateEnd: "2017-12-31+03:00" data: - form: "Баланс" section: "Актив" name: "Нематериальные активы" code: "1110" value: "69825000" id: 1 - form: "Баланс" section: "Актив" name: "Основные средства" code: "1150" value: "11072450000" id: 5 - form: "Баланс" section: "Актив" name: "Доходные вложения в материальные ценности" code: "1160" value: "566919000" id: 9 leaders: - actualDate: "2020-12-01+03:00" name: "Фамилия Имя Отчество" position: "генеральный директор" managementCompany: null managementCompanyINN: "000000000000" structure: countCoownerFCSM: 1 countCoownerRosstat: 1 countCoownerEGRUL: 1 countBranch: 0 countBranchRosstat: 36 countBranchEGRUL: 139 countCoownerDKCPFR: null countCoownerUkrStat: null countAffiliatedCompany: null countAffiliatedCompanyFCSM: 0 countAffiliatedCompanyRosstat: 22 countAffiliatedCompanyEGRUL: 23 nonprofitOrganizationRosstat: 3 activeBranchesRosstatNumber: null activeAffiliatedCompaniesNumber: null proceedings: active: 65 executed: 1326 charterCapital: value: "1110616000" date: "2000-01-01+04:00" currencyCode: null currencyName: null charterCapitalHistory: [] companyWithSameInfo: telephoneCount: value: 1 phoneCode: "342" phoneNumber: "2901202" phoneList: [] addressCount: 51 addressWithoutRoomCount: 60 addressNotAffiliatedCount: 51 addressFTSCount: 26 managerCountInCountry: 1 managerCountInRegion: 1 managerInnCount: 0 companyLiquidatedWithSameInfo: addressCount: 10 addressWithoutRoomCount: 10 arbitrationCases: cases: - year: 2006 plaintiff: casesNumber: 2 sum: "17369466" defendant: casesNumber: 0 sum: "0" thirdOrOtherPerson: casesNumber: 0 - year: 2005 plaintiff: casesNumber: 2 sum: "0" defendant: casesNumber: 0 sum: "0" thirdOrOtherPerson: casesNumber: 0 - year: 2004 plaintiff: casesNumber: 2 sum: "0" defendant: casesNumber: 0 sum: "0" thirdOrOtherPerson: casesNumber: 0 total: 703 considered: 35 appealed: 4 decisionsAndRulings: 13 completed: 651 federalTaxRegistrationPayment: regDate: "2010-01-25+03:00" regAuthority: "Инспекция Федеральной налоговой службы" regAuthorityAddress: "119048, Москва г, Доватора ул" regAuthorityCode: "7704" federalTaxRegistrationCurrent: regDate: "2008-10-12+04:00" regAuthority: "Межрайонная инспекция Федеральной налоговой слу\ жбы" regAuthorityAddress: "125373, Москва г, Походный проезд" regAuthorityCode: "7746" okved: - code: "51.10.1" name: "Перевозка" isMain: true isMainEgrul: true isMainRosstat: true - code: "18.12" name: "Прочие виды полиграфической деятельности" isMain: false isMainEgrul: false isMainRosstat: false - code: "33.16" name: "Ремонт и техническое обслуживание" isMain: false isMainEgrul: false isMainRosstat: false stateContracts: federalLaw94: - year: 2013 tenders: admittedNumber: 69 notAdmittedNumber: 0 winnerNumber: 69 contracts: signedNumber: 69 sum: "91800339" - year: 2012 tenders: admittedNumber: 75 notAdmittedNumber: 0 winnerNumber: 75 contracts: signedNumber: 75 sum: "4172264976" - year: 2011 tenders: admittedNumber: 45 notAdmittedNumber: 0 winnerNumber: 39 contracts: signedNumber: 39 sum: "2956994583" federalLaw223: [] address: - postCode: "119002" address: "г. Москва, ул. Арбат" streetName: "ул. Арбат" buildingNumber: "10" fiasGUID: "b30b63a1-c2be-4efc-9d0c-c9b6d7438e15" isHouseFiasGUID: false fiasCode: "770000000000000000000000000" fiasRegion: "77" fiasArea: "000" fiasCity: "000" fiasPlace: "000" fiasPlan: "0000" fiasStreet: "0758" actualDate: "2018-03-21+03:00" buildingType: "дом" businessCenterName: "Бизнес-центр" fts: [] includeInList: - isNegative: false id: 6 listName: "Компании, сдающие отчетность" - isNegative: false id: 7 listName: "Предприятия" - isNegative: false id: 8 listName: "Компании" bankruptcyMessage: [] expressExcerpt: inn: "000000000000" companyType: "company" companyWithSameInfo: sameManager: manager: "Фамилия Имя Отчество" managerCountInCountry: 1 managerInnCount: 0 sameAddress: address: "г. Москва, ул. Арбат" addressCount: 51 samePhone: phoneCode: "342" phoneNumber: "0000000" phoneCount: 1 negativeLists: [] status: isActing: true date: "2023-04-24+03:00" text: null type: "Действующее" code: 24 groupId: 1 groupName: "Действующее" okvedInfo: code: "50.00.0" name: "Перевозка" okvedCount: 21 netIncome: periodName: "2020" dateBegin: "2020-01-01+03:00" dateEnd: "2020-12-31+03:00" sum: "-96527133000" taxYears: minYear: 2015 maxYear: 2020 financeYears: minYear: 2015 maxYear: 2020 stateContractYears: minYear: 2006 maxYear: 2013 activeProceedingsCount: 65 bankruptcyMessage: idType: 7 messageType: "Тип сообщения" date: "2021-10-26Z" decisionDate: "2021-10-19Z" caseNumber: "А56-13391/2020" caseId: 23040734 frozenAccountDecisions: [] arbitrationCasesInfo: year: 2018 count: 23 entrepreneurExcerpt: ogrnip: "300000000000000" okpo: "0000000000" phoneList: [] status: isActing: true date: "2017-07-06+03:00" text: "Действующее" code: 24 groupId: 1 groupName: "Действующее" includeInList: - isNegative: false id: 26 listName: "Реестр субъекто" inn: "000000000000" federalTaxRegistrationCurrent: regAuthority: "Межрайонная ИФНС России №23 по Московской облас\ ти" regAuthorityAddress: "144000, Московская обл, г Электросталь" regAuthorityCode: "5081" federalTaxRegistrationPayment: regDate: "2017-07-06+03:00" regAuthority: "Межрайонная инспекция Федеральной налоговой слу\ жбы" regAuthorityAddress: "140000, Московская обл, Люберцы г" regAuthorityCode: "5027" okato: value: "" code: "00000000000" regionName: "Московская область" regionCode: 46 dateReg: "2017-07-06" okopf: code: "50102" name: "Индивидуальные предприниматели" fullNameRus: "Тест Тест Тест" sex: "man" citizenship: code: 643 name: "Российская Федерация" okved: - code: "63.91" name: "Деятельность информационных агентств" isMain: true registrationInFunds: pensionFund: registrationDate: "2017-07-07+03:00" registerNumber: "060027069206" regAuthority: "Государственное учреждение" submittedStatements: - form: "Р21001" submissionDate: "2017-07-03+03:00" availabilityDate: "2017-07-06+03:00" grn: "000000000000000" decisionType: "Решение о государственной регистрации" stateContracts: federalLaw94: - year: 2018 tenders: admittedNumber: 0 notAdmittedNumber: 1 winnerNumber: 0 contracts: signedNumber: 0 sum: "0" bankruptcyMessage: [] expressExcerpt: inn: "000000000000" companyType: "company" companyWithSameInfo: sameManager: manager: "Фамилия Имя Отчество" managerCountInCountry: 1 managerInnCount: 0 sameAddress: address: "г. Москва, ул. Арбат" addressCount: 51 samePhone: phoneCode: "342" phoneNumber: "0000000" phoneCount: 1 negativeLists: [] status: isActing: true date: "2023-04-24+03:00" text: null type: "Действующее" code: 24 groupId: 1 groupName: "Действующее" okvedInfo: code: "51.10.1" name: "Перевозка" okvedCount: 21 netIncome: periodName: "2020" dateBegin: "2020-01-01+03:00" dateEnd: "2020-12-31+03:00" sum: "-96527133000" taxYears: minYear: 2015 maxYear: 2020 financeYears: minYear: 2015 maxYear: 2020 stateContractYears: minYear: 2006 maxYear: 2013 activeProceedingsCount: 65 bankruptcyMessage: idType: 7 messageType: "Тип сообщения" date: "2021-10-26Z" decisionDate: "2021-10-19Z" caseNumber: "А56-13391/2020" caseId: 23040734 frozenAccountDecisions: [] arbitrationCasesInfo: year: 2018 count: 23 companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"НАЗВАНИЕ\"" fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"НАЗВАНИЕ\"" dateReg: "1996-06-21" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, г Москва, ул Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "relatedCompanies" - page: "feedback" - page: "financialStatements" excerpt: requisites: legalForm: "ПУБЛИЧНЫЕ АКЦИОНЕРНЫЕ ОБЩЕСТВА" organizationSizeDesc: "Описание" entityRegistrationDate: "2010-01-25" regAuthorityAddressTxt: "125373, гор. Москва, Походный Проезд" regAuthorityName: "Межрайонная Инспекция Федеральной Налоговой\ \ Службы" pfrRegistrationNumber: "0000000000000" pfrAuthorityName: "Отделение Фонда Пенсионного и Социального С\ трахования" pfrRegistrationDate: "2010-06-18" insRegistrationNumber: "000000000000000" insAuthorityName: "Отделение Фонда Пенсионного и Социального С\ трахования" insRegistrationDate: "2000-10-01" okvedSummary: count: 22 main: - code: "51.10.1" description: "Перевозка" additional: - code: "18.12" description: "Прочие виды деятельности" - code: "33.16" description: "Ремонт и техническое обслуживание" - code: "41.20" description: "Строительство" contractSummary: count: 164 admittedCount: 40 notAdmittedCount: 94 totalValue: 3.2823479357625E10 licenseSummary: total: 10 active: 10 inactive: 0 trafficLightColors: redCount: 1 yellowCount: 5 greenCount: 14 innerCheckResult: bankruptcyMessage: value: idType: 7 messageType: "Тип сообщения" date: "2011-10-26Z" decisionDate: "2011-10-19Z" caseNumber: "А56-00000/2010" caseId: 0 color: "green" plaintiff: value: minDate: 2004 maxDate: 2018 totalCases: 470 color: "yellow" thirdOrOtherPerson: value: minDate: 2007 maxDate: 2018 totalCases: 85 color: "yellow" defendant: value: minDate: 2007 maxDate: 2018 totalCases: 157 color: "yellow" defendantDynamic: value: lastYear: 2019 prevLastYear: 2018 percent: 50 color: "none" executedProceedings: value: 1326 color: "yellow" activeProceedings: value: 65 color: "red" sameManager: value: inn: "000000000000" sameManager: manager: "Фамилия Имя Отчество" managerCountInCountry: 1 managerInnCount: 1 color: "none" sameAddressNumber: value: 51 color: "yellow" finance: value: balanceType: 1 periods: - periodName: "2015" dateBegin: "2015-01-01+03:00" dateEnd: "2015-12-31+03:00" data: [] - periodName: "2016" dateBegin: "2016-01-01+03:00" dateEnd: "2016-12-31+03:00" data: [] - periodName: "2017" dateBegin: "2017-01-01+03:00" dateEnd: "2017-12-31+03:00" data: [] color: "green" isNegative: value: negativeListsCount: 0 color: "green" unfairSupplier: value: id: 1 isNegative: true listName: "Название" color: "green" invalidLegalAddress: value: id: 1 isNegative: true listName: "Название" color: "green" disqualifiedPersons: value: id: 1 isNegative: true listName: "Название" color: "green" taxReport: value: "2023-04-25" color: "none" taxDebt: value: sum: 10 statDate: "2000-01-01" color: "green" checkResult: status: value: "Действующая организация" color: "none" registrationDate: value: "1994-06-21" color: "green" legalAddressChangeDate: value: "2019-07-10" color: "green" founderChangeDate: value: "2021-10-25" color: "green" confidantChangeDate: value: "2022-04-18" color: "green" authorizedCapitalAmount: value: 3975771140 color: "green" admittedContractsAsSupplier: value: count: 40 totalValue: 27523079541 color: "green" legalForm: value: "Публичные акционерные общества" color: "green" okvedCount: value: 22 color: "none" licensedOkvedCount: value: 0 color: "none" riskLevel: value: 0 color: "none" relationSummary: total: 10 relatedByFounder: 0 relatedByConfidant: 0 relatedCompanies: - name: "ООО \"Название\"" ogrn: "1000000000000" inn: "000000000000" leaders: - actualDate: "2022-01-01" name: "Фамилия Имя Отчество" position: "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР" founders: [] history: - paramText: "организации" changeDate: "2022-09-06" paramName: "auth_cap" oldParamValue: "2444535550.00" paramValue: "3975771140.00" - paramText: "организации" changeDate: "2022-06-11" paramName: "lic_new" oldParamValue: "Л041-01162-50/00369716 от 9 апреля 2020" paramValue: "Л041-01162-50/00369716|2020-04-09|2020-04-09" licenses: - "no": "14761-АТ" authorityName: "МИНИСТЕРСТВО" date: "2020-07-29" startDate: "2020-07-30" endDate: null address: [] activity: - "РАЗРАБОТКА" status: "active" - "no": "Л041-01162-50/00369716" authorityName: "ФЕДЕРАЛЬНАЯ СЛУЖБА ПО НАДЗОРУ В СФЕРЕ ЗДРАВООХ\ РАНЕНИЯ" date: "2020-04-09" startDate: "2020-04-09" endDate: null address: [] activity: - "МЕДИЦИНСКАЯ ДЕЯТЕЛЬНОСТЬ" status: "active" - "no": "Л042-01137-77/00283899" authorityName: "ДЕПАРТАМЕНТ ЗДРАВООХРАНЕНИЯ" date: "2019-10-03" startDate: "2019-10-03" endDate: null address: [] activity: - "ФАРМАЦЕВТИЧЕСКАЯ ДЕЯТЕЛЬНОСТЬ" status: "active" contracts: - contractId: "0173200000000000071" counterpartyOgrn: "1000000000000" purchaseObjectTypeName: "Услуги" stageCode: "completed" role: "supplier" price: 612000 - contractId: "1490000000000000006" counterpartyOgrn: "1000000000000" purchaseObjectTypeName: "Услуги" stageCode: "execution" role: "supplier" price: 664976 - contractId: "1870000000000000002" counterpartyOgrn: "1000000000000" purchaseObjectTypeName: "Услуги" stageCode: "execution" role: "supplier" price: 6000000 financialStatementsResponse: reason: reasonCode: "lessThanYear" reasonText: "Компании меньше года" financialStatementsData: year: 2021 revenue: name: "Выручка" value: 378657216000 valueDiff: 148890851000 values: - year: 2019 value: 551767420000 valueDiff: null - year: 2020 value: 229766365000 valueDiff: -322001055000 - year: 2021 value: 378657216000 valueDiff: 148890851000 profit: name: "Прибыль" value: -45639139000 valueDiff: 50887994000 values: - year: 2019 value: 5286800000 valueDiff: null - year: 2020 value: -96527133000 valueDiff: -101813933000 - year: 2021 value: -45639139000 valueDiff: 50887994000 accountsPayable: name: "Кредиторский долг" value: 100062394000 valueDiff: -7293171000 values: - year: 2019 value: 95785513000 valueDiff: null - year: 2020 value: 107355565000 valueDiff: 11570052000 - year: 2021 value: 100062394000 valueDiff: -7293171000 accountsReceivable: name: "Дебиторский долг" value: 83489186000 valueDiff: 1918241000 values: - year: 2019 value: 104635508000 valueDiff: null - year: 2020 value: 81570945000 valueDiff: -23064563000 - year: 2021 value: 83489186000 valueDiff: 1918241000 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/express/excerpt: get: tags: - "Проверка контрагентов" summary: "Получить краткую выписку для проверки контрагента" description: "Метод для получения краткой выписки по контрагенту." operationId: "getApiV1CounterpartyExpressExcerpt" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyType" - "frozenAccountDecisions" - "negativeLists" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН" nullable: true companyType: type: "string" description: "Тип компании." enum: - "entrepreneur" - "company" companyWithSameInfo: required: - "sameAddress" - "sameManager" - "samePhone" type: "object" properties: sameManager: type: "object" properties: manager: maxLength: 512 type: "string" nullable: true managerCountInCountry: type: "integer" format: "int32" nullable: true managerInnCount: type: "integer" format: "int32" nullable: true sameAddress: type: "object" properties: address: maxLength: 1000 type: "string" nullable: true addressCount: type: "integer" format: "int32" nullable: true samePhone: type: "object" properties: phoneCode: pattern: "^\\d{3,5}$" type: "string" description: "Зоновый код (код города/оператора)." nullable: true phoneNumber: pattern: "^\\d{5,7}$" type: "string" description: "Местный номер." nullable: true phoneCount: type: "integer" format: "int32" nullable: true negativeLists: maxItems: 200 type: "array" description: "Негативные списки, в которых состоит компания." items: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true status: required: - "code" - "isActing" type: "object" properties: isActing: type: "boolean" date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true text: type: "string" format: "string" nullable: true type: type: "string" format: "string" nullable: true code: type: "integer" format: "int32" groupId: type: "integer" format: "int32" nullable: true groupName: type: "string" format: "string" nullable: true description: "Статус." okvedInfo: required: - "okvedCount" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" nullable: true name: type: "string" format: "string" nullable: true okvedCount: type: "integer" format: "int32" netIncome: required: - "dateBegin" - "dateEnd" - "periodName" - "sum" type: "object" properties: periodName: maxLength: 512 type: "string" dateBegin: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" dateEnd: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" sum: maxLength: 512 type: "string" taxYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" financeYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" stateContractYears: required: - "maxYear" - "minYear" type: "object" properties: minYear: type: "integer" format: "int32" maxYear: type: "integer" format: "int32" activeProceedingsCount: type: "integer" description: "Количество активных исполнительных производств (д\ олгов)." format: "int32" nullable: true bankruptcyMessage: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true frozenAccountDecisions: maxItems: 200 type: "array" description: "Есть решение о приостановлении операций по счета\ м." items: type: "object" properties: sparkId: required: - "isEven" - "isOne" - "isPowerOfTwo" - "isZero" - "sign" type: "object" properties: isPowerOfTwo: type: "boolean" readOnly: true isZero: type: "boolean" readOnly: true isOne: type: "boolean" readOnly: true isEven: type: "boolean" readOnly: true sign: type: "integer" format: "int32" readOnly: true reason: type: "object" properties: id: type: "integer" format: "int32" nullable: true name: maxLength: 1000 type: "string" nullable: true taxAuthority: type: "object" properties: code: maxLength: 512 type: "string" nullable: true name: maxLength: 1000 type: "string" nullable: true bank: type: "object" properties: sparkId: required: - "isEven" - "isOne" - "isPowerOfTwo" - "isZero" - "sign" type: "object" properties: isPowerOfTwo: type: "boolean" readOnly: true isZero: type: "boolean" readOnly: true isOne: type: "boolean" readOnly: true isEven: type: "boolean" readOnly: true sign: type: "integer" format: "int32" readOnly: true bik: pattern: "^(\\d{9}|0)$" type: "string" nullable: true name: maxLength: 512 type: "string" nullable: true number: maxLength: 512 type: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\d{2})|Z)?)$" type: "string" format: "string" nullable: true arbitrationCasesInfo: required: - "count" - "year" type: "object" properties: year: type: "integer" format: "int32" count: type: "integer" format: "int32" example: inn: "000000000000" companyType: "company" companyWithSameInfo: sameManager: manager: "Фамилия Имя Отчество" managerCountInCountry: 1 managerInnCount: 0 sameAddress: address: "г. Москва, ул. Арбат" addressCount: 51 samePhone: phoneCode: "342" phoneNumber: "0000000" phoneCount: 1 negativeLists: [] status: isActing: true date: "2023-04-24+03:00" text: null type: "Действующее" code: 24 groupId: 1 groupName: "Действующее" okvedInfo: code: "51.10.1" name: "Перевозка" okvedCount: 21 netIncome: periodName: "2020" dateBegin: "2020-01-01+03:00" dateEnd: "2020-12-31+03:00" sum: "-96527133000" taxYears: minYear: 2015 maxYear: 2020 financeYears: minYear: 2015 maxYear: 2020 stateContractYears: minYear: 2006 maxYear: 2013 activeProceedingsCount: 65 bankruptcyMessage: idType: 7 messageType: "Тип сообщения" date: "2021-10-26Z" decisionDate: "2021-10-19Z" caseNumber: "А56-13391/2020" caseId: 23040734 frozenAccountDecisions: [] arbitrationCasesInfo: year: 2018 count: 23 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/history: get: tags: - "Проверка контрагентов" summary: "Получить историю изменений" description: "Метод для получения истории изменений по компании." operationId: "getApiV1CounterpartyHistory" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "limit" in: "query" required: true style: "form" explode: true schema: maximum: 100 minimum: 1 type: "integer" format: "int32" - name: "offset" in: "query" required: true style: "form" explode: true schema: type: "integer" format: "int32" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "data" type: "object" properties: companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." data: required: - "items" - "total" type: "object" properties: total: type: "integer" format: "int64" items: maxItems: 100 type: "array" items: required: - "oldParamValue" - "paramName" - "paramText" - "paramValue" type: "object" properties: paramText: type: "string" format: "string" changeDate: type: "string" format: "date" nullable: true paramName: type: "string" format: "string" oldParamValue: type: "string" format: "string" paramValue: type: "string" format: "string" description: "Изменённые данные." example: companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"Название\"" fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"Название\"" dateReg: "1990-06-01" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, г Москва, ул Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "relatedCompanies" - page: "feedback" - page: "financialStatements" data: total: 125 items: - paramText: "организации" changeDate: "2022-09-06" paramName: "auth_cap" oldParamValue: "2444535550.00" paramValue: "3975771140.00" - paramText: "организации" changeDate: "2022-06-11" paramName: "lic_new" oldParamValue: "Л041-01162-50/00369716 от 9 апреля 2020" paramValue: "Л041-01162-50/00369716|2020-04-09|2020-04-09" - paramText: "организации" changeDate: "2022-06-10" paramName: "lic_del" oldParamValue: "ЛО-50-01-011924 от 9 апреля 2020" paramValue: "ЛО-50-01-011924|2020-04-09|2020-04-09" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/licenses: get: tags: - "Проверка контрагентов" summary: "Получить список лицензий контрагента" description: "Метод возвращает список лицензий контрагента." operationId: "getApiV1CounterpartyLicenses" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "limit" in: "query" required: true style: "form" explode: true schema: maximum: 100 minimum: 1 type: "integer" format: "int32" - name: "offset" in: "query" required: true style: "form" explode: true schema: type: "integer" format: "int32" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "data" type: "object" properties: companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." data: required: - "active" - "items" - "total" type: "object" properties: total: type: "integer" format: "int64" active: type: "integer" format: "int64" items: maxItems: 100 type: "array" items: required: - "activity" - "address" - "status" type: "object" properties: "no": type: "string" format: "string" nullable: true authorityName: type: "string" format: "string" nullable: true date: type: "string" format: "date" nullable: true startDate: type: "string" format: "date" nullable: true endDate: type: "string" format: "date" nullable: true address: maxItems: 1200 type: "array" items: type: "string" format: "string" activity: maxItems: 100 type: "array" items: type: "string" format: "string" status: type: "string" description: "Статус лицензии." enum: - "active" - "inactive" - "unknown" description: "Лицензия." example: companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"Название\"" fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"Название\"" dateReg: "1990-01-01" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, г Москва, ул Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "relatedCompanies" - page: "feedback" - page: "financialStatements" data: total: 10 active: 10 items: - "no": "14761-АТ" authorityName: "МИНИСТЕРСТВО" date: "2020-07-29" startDate: "2020-07-30" endDate: null address: [] activity: - "РАЗРАБОТКА" status: "active" - "no": "Л041-01162-50/00369716" authorityName: "ФЕДЕРАЛЬНАЯ СЛУЖБА ПО НАДЗОРУ В СФЕРЕ ЗДРАВООХ\ РАНЕНИЯ" date: "2020-04-09" startDate: "2020-04-09" endDate: null address: [] activity: - "МЕДИЦИНСКАЯ ДЕЯТЕЛЬНОСТЬ" status: "active" - "no": "Л042-01137-77/00283899" authorityName: "ДЕПАРТАМЕНТ ЗДРАВООХРАНЕНИЯ" date: "2019-10-03" startDate: "2019-10-03" endDate: null address: [] activity: - "ФАРМАЦЕВТИЧЕСКАЯ ДЕЯТЕЛЬНОСТЬ" status: "active" - "no": "АВ ГН-06-501-3715" authorityName: "ЦЕНТРАЛЬНЫЙ АППАРАТ ФЕДЕРАЛЬНОЙ СЛУЖБЫ" date: "2019-09-30" startDate: "2019-09-30" endDate: "2024-01-14" address: [] activity: - "ОБРАЩЕНИЕ" status: "active" - "no": "АН 77-000556" authorityName: "ЦЕНТРАЛЬНОЕ МЕЖРЕГИОНАЛЬНОЕ УПРАВЛЕНИЕ" date: "2019-07-03" startDate: "2019-07-03" endDate: null address: [] activity: - "ДЕЯТЕЛЬНОСТЬ ПО ПЕРЕВОЗКАМ" status: "active" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/okved: get: tags: - "Проверка контрагентов" summary: "Получить список ОКВЭДов контрагента" description: "Метод возвращает список ОКВЭДов контрагента.\n\nОКВЭД — общеро\ ссийский классификатор видов экономической деятельности, в котором все вид\ ы деятельности обозначены числовыми кодами." operationId: "getApiV1CounterpartyOkved" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "data" type: "object" properties: companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." data: required: - "additional" - "main" type: "object" properties: main: maxItems: 100 type: "array" items: required: - "code" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" description: type: "string" format: "string" nullable: true description: "ОКВЭД." additional: maxItems: 100 type: "array" items: required: - "code" type: "object" properties: code: pattern: "^\\d{2}((\\.\\d{1,2})?)((\\.\\d{1,2})?)$" type: "string" description: type: "string" format: "string" nullable: true description: "ОКВЭД." description: "ОКВЭДы компании." example: companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"Название\"" fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"Название\"" dateReg: "1994-06-21" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, г Москва, ул Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "relatedCompanies" - page: "feedback" - page: "financialStatements" data: main: - code: "51.10.1" description: "Перевозка" additional: - code: "00.12" description: "Прочие" - code: "00.11" description: "Ремонт" - code: "00.10" description: "Строительство" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/related_companies: get: tags: - "Проверка контрагентов" summary: "Получить общую информацию о связанных компаниях" description: "Метод для получения информации по связанным компаниям." operationId: "getApiV1CounterpartyRelatedCompanies" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "filter" in: "query" description: "Фильтр для статусов связанных компаний." required: false style: "form" explode: true schema: maxItems: 5 type: "array" items: type: "string" enum: - "operating" - "bankruptcy" - "reorganization" - "inLiquidationProcess" - "liquidated" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "data" type: "object" properties: companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." data: required: - "entrepreneurRelations" - "managers" - "relationSummary" type: "object" properties: entrepreneurRelations: maxItems: 100 type: "array" items: required: - "ogrn" - "positionType" - "statusPriority" type: "object" properties: fullName: maxLength: 1000 type: "string" nullable: true shortName: maxLength: 1000 type: "string" nullable: true statusGroup: maxLength: 512 type: "string" nullable: true statusPriority: type: "integer" format: "int32" inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true entityRegistrationDate: type: "string" format: "date" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" positionType: type: "string" description: "Должность физ. лица в компании." enum: - "entrepreneur" - "founder" - "confidant" - "founderAndConfidant" description: "Описание связанной компании." managers: maxItems: 100 type: "array" items: required: - "inn" - "name" - "positionType" - "relatedEnterprises" - "total" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" name: maxLength: 1000 type: "string" total: type: "integer" format: "int32" positionType: type: "string" description: "Должность физ. лица в компании." enum: - "entrepreneur" - "founder" - "confidant" - "founderAndConfidant" relatedEnterprises: maxItems: 100 type: "array" items: required: - "ogrn" - "positionType" - "statusPriority" type: "object" properties: fullName: maxLength: 1000 type: "string" nullable: true shortName: maxLength: 1000 type: "string" nullable: true statusGroup: maxLength: 512 type: "string" nullable: true statusPriority: type: "integer" format: "int32" inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true entityRegistrationDate: type: "string" format: "date" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" positionType: type: "string" description: "Должность физ. лица в компании." enum: - "entrepreneur" - "founder" - "confidant" - "founderAndConfidant" description: "Описание связанной компании." description: "Менеджер и связанные с ним компании." relationSummary: required: - "relatedByConfidant" - "relatedByFounder" - "total" type: "object" properties: total: type: "integer" format: "int32" relatedByFounder: type: "integer" format: "int32" relatedByConfidant: type: "integer" format: "int32" description: "Связанные компании." description: "Связанные компании." example: companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"Название\"" fullName: "Публичное Акционерное Общество \"Название\"" dateReg: "1990-06-21" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, гор. Москва, ул. Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "feedback" - page: "financialStatements" data: entrepreneurRelations: [] managers: [] relationSummary: total: 11 relatedByFounder: 0 relatedByConfidant: 0 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/related_companies_page: get: tags: - "Проверка контрагентов" summary: "Получить список связанных компаний" description: "Метод для получения списка связанных компаний." operationId: "getApiV1CounterpartyRelatedCompaniesPage" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "filter" in: "query" description: "Фильтр для статусов связанных компаний." required: false style: "form" explode: true schema: maxItems: 5 type: "array" items: type: "string" enum: - "operating" - "bankruptcy" - "reorganization" - "inLiquidationProcess" - "liquidated" - name: "limit" in: "query" required: true style: "form" explode: true schema: type: "integer" format: "int32" - name: "managerInn" in: "query" description: "ИНН менеджера связанной компании." required: false style: "form" explode: true schema: pattern: "^(\\d{12}|\\d{10})$" type: "string" - name: "offset" in: "query" required: true style: "form" explode: true schema: type: "integer" format: "int32" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "relations" type: "object" properties: relations: maxItems: 100 type: "array" items: required: - "ogrn" - "positionType" - "statusPriority" type: "object" properties: fullName: maxLength: 1000 type: "string" nullable: true shortName: maxLength: 1000 type: "string" nullable: true statusGroup: maxLength: 512 type: "string" nullable: true statusPriority: type: "integer" format: "int32" inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true entityRegistrationDate: type: "string" format: "date" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" positionType: type: "string" description: "Должность физ. лица в компании." enum: - "entrepreneur" - "founder" - "confidant" - "founderAndConfidant" description: "Описание связанной компании." description: "Подгружаемые связанные компании." example: relations: - fullName: "Акционерное Общество \"Название\"" shortName: "АО \"Название\"" statusGroup: "Действующая организация" statusPriority: 1 inn: "000000000000" kpp: "000000000" entityRegistrationDate: "1999-03-03" ogrn: "1000000000000" positionType: "founder" - fullName: "Общество с Ограниченной Ответственностью \"Название\"" shortName: "ООО \"Название\"" statusGroup: "Действующая организация" statusPriority: 1 inn: "000000000000" kpp: "000000000" entityRegistrationDate: "2010-01-01" ogrn: "1000000000000" positionType: "founder" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/counterparty/traffic_light: get: tags: - "Проверка контрагентов" summary: "Получить светофор факторов надёжности" description: "Метод для получения светофора факторов надёжности." operationId: "getApiV1CounterpartyTrafficLight" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ogrn" in: "query" description: "Основной государственный регистрационный номер." required: true style: "form" explode: true schema: pattern: "^\\d{13,15}$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "companyCard" - "data" type: "object" properties: companyCard: required: - "pages" - "requisites" - "statusType" type: "object" properties: statusType: type: "string" description: "Статус компании." enum: - "active" - "reorganizing" - "liquidating" - "liquidated" - "bankrupting" - "unknown" requisites: required: - "ogrn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true ogrn: pattern: "^\\d{13,15}$" type: "string" kpp: pattern: "^(\\d{9}|0)$" type: "string" nullable: true shortName: type: "string" format: "string" nullable: true fullName: type: "string" format: "string" nullable: true dateReg: type: "string" format: "date" nullable: true terminationDt: type: "string" format: "date" nullable: true status: type: "string" format: "string" nullable: true authorizedCapitalAmount: type: "number" format: "double" nullable: true ogrnAssignDate: type: "string" format: "date" nullable: true legalAddress: type: "string" format: "string" nullable: true city: type: "string" format: "string" nullable: true description: "Реквизиты." pages: maxItems: 20 type: "array" items: required: - "page" type: "object" properties: page: type: "string" description: "Код страницы." enum: - "okved" - "contract" - "license" - "history" - "trafficLight" - "relatedCompanies" - "feedback" - "financialStatements" - "enforcementProceedings" - "inspections" description: "Информация о странице." description: "Карточка компании." data: required: - "companyType" - "expressCheckResult" - "innerCheckResult" type: "object" properties: companyType: type: "string" description: "Тип компании." enum: - "entrepreneur" - "company" expressCheckResult: required: - "admittedContractsAsSupplier" - "authorizedCapitalAmount" - "confidantChangeDate" - "founderChangeDate" - "legalAddressChangeDate" - "legalForm" - "licensedOkvedCount" - "okvedCount" - "registrationDate" - "riskLevel" - "status" type: "object" properties: status: required: - "color" type: "object" properties: value: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." registrationDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." legalAddressChangeDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." founderChangeDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." confidantChangeDate: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." authorizedCapitalAmount: required: - "color" type: "object" properties: value: type: "number" format: "double" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." admittedContractsAsSupplier: required: - "color" - "value" type: "object" properties: value: required: - "count" type: "object" properties: count: type: "integer" format: "int64" totalValue: type: "number" format: "double" nullable: true description: "Статистика по контрактам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." legalForm: required: - "color" type: "object" properties: value: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." okvedCount: required: - "color" - "value" type: "object" properties: value: type: "integer" format: "int64" color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." licensedOkvedCount: required: - "color" - "value" type: "object" properties: value: type: "integer" format: "int64" color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." riskLevel: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." description: "Проверки:\n* `Status` — статус компании;\n*\ \ `RegistrationDate` — проверка даты регистрации на прев\ ышение трех лет;\n* `LegalAddressChangeDate` — проверка\ \ изменения юридического адреса за последний год;\n* `FounderChangeDate`\ \ — проверка изменения учредителя за последний год;\n* `ConfidantChangeDate`\ \ — проверка изменения руководителя за последний год;\n\ * `AuthorizedCapitalAmount` — проверка превышения уставн\ ого капитала минимального порога;\n* `AdmittedContractsAsSupplier`\ \ — участие в государственных закупках;\n* `LegalForm` —\ \ организационно-правовая форма организации;\n* `OkvedCount`\ \ — количество видов деятельности, превышающих порог;\n\ * `LicensedOkvedCount` — проверка соответствия лицензии\ \ коду ОКВЭД;\n* `RiskLevel` — уровень риска." innerCheckResult: required: - "activeProceedings" - "bankruptcyMessage" - "defendant" - "defendantDynamic" - "disqualifiedPersons" - "executedProceedings" - "finance" - "invalidLegalAddress" - "isNegative" - "plaintiff" - "sameAddressNumber" - "sameManager" - "taxDebt" - "taxReport" - "thirdOrOtherPerson" - "unfairSupplier" type: "object" properties: bankruptcyMessage: required: - "color" type: "object" properties: value: type: "object" properties: idType: type: "integer" format: "int64" nullable: true messageType: type: "string" format: "string" nullable: true date: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\ d{2})|Z)?)$" type: "string" format: "string" nullable: true decisionDate: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\d{2}:\\\ d{2})|Z)?)$" type: "string" format: "string" nullable: true caseNumber: type: "string" format: "string" nullable: true caseId: type: "integer" format: "int64" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." plaintiff: required: - "color" type: "object" properties: value: required: - "maxDate" - "minDate" - "totalCases" type: "object" properties: minDate: type: "integer" description: "Наименьший год с судебными делам\ и." format: "int32" maxDate: type: "integer" description: "Наибольший год с судебными делам\ и." format: "int32" totalCases: type: "integer" format: "int32" description: "Статистика по судебным делам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." thirdOrOtherPerson: required: - "color" type: "object" properties: value: required: - "maxDate" - "minDate" - "totalCases" type: "object" properties: minDate: type: "integer" description: "Наименьший год с судебными делам\ и." format: "int32" maxDate: type: "integer" description: "Наибольший год с судебными делам\ и." format: "int32" totalCases: type: "integer" format: "int32" description: "Статистика по судебным делам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." defendant: required: - "color" type: "object" properties: value: required: - "maxDate" - "minDate" - "totalCases" type: "object" properties: minDate: type: "integer" description: "Наименьший год с судебными делам\ и." format: "int32" maxDate: type: "integer" description: "Наибольший год с судебными делам\ и." format: "int32" totalCases: type: "integer" format: "int32" description: "Статистика по судебным делам." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." defendantDynamic: required: - "color" type: "object" properties: value: required: - "lastYear" - "percent" - "prevLastYear" type: "object" properties: lastYear: type: "integer" format: "int32" prevLastYear: type: "integer" format: "int32" percent: type: "number" format: "double" description: "Динамика судебных дел в качестве отв\ етчика." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." executedProceedings: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." activeProceedings: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." sameManager: required: - "color" type: "object" properties: value: type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" nullable: true sameManager: type: "object" properties: manager: maxLength: 512 type: "string" nullable: true managerCountInCountry: type: "integer" format: "int32" nullable: true managerInnCount: type: "integer" format: "int32" nullable: true description: "Массовый руководитель." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." sameAddressNumber: required: - "color" type: "object" properties: value: type: "integer" format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." finance: required: - "color" type: "object" properties: value: type: "object" properties: balanceType: type: "integer" format: "int64" nullable: true periods: maxItems: 200 type: "array" description: "Бухгалтерская отчётность." nullable: true items: type: "object" properties: periodName: maxLength: 512 type: "string" description: "Отчётный период." nullable: true dateBegin: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\ d{2}:\\d{2})|Z)?)$" type: "string" description: "Начало периода." format: "string" nullable: true dateEnd: pattern: "^\\d{4}-\\d{2}-\\d{2}(((\\+\\\ d{2}:\\d{2})|Z)?)$" type: "string" description: "Конец периода." format: "string" nullable: true data: maxItems: 200 type: "array" nullable: true items: type: "object" properties: form: maxLength: 512 type: "string" description: "Форма." nullable: true section: maxLength: 512 type: "string" description: "Раздел." nullable: true name: maxLength: 512 type: "string" description: "Наименование." nullable: true code: maxLength: 512 type: "string" description: "Код." nullable: true value: maxLength: 512 type: "string" description: "Значение." nullable: true id: type: "integer" description: "Идентификатор списка\ ." format: "int32" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." isNegative: required: - "color" - "value" type: "object" properties: value: required: - "negativeListsCount" type: "object" properties: negativeListsCount: type: "integer" format: "int32" description: "Статистика негативных списков." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." unfairSupplier: required: - "color" type: "object" properties: value: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." invalidLegalAddress: required: - "color" type: "object" properties: value: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." disqualifiedPersons: required: - "color" type: "object" properties: value: required: - "id" - "isNegative" type: "object" properties: isNegative: type: "boolean" id: type: "integer" format: "int32" listName: type: "string" format: "string" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." taxReport: required: - "color" type: "object" properties: value: type: "string" format: "date" nullable: true color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." taxDebt: required: - "color" type: "object" properties: value: required: - "statDate" - "sum" type: "object" properties: sum: type: "number" format: "double" statDate: type: "string" format: "date" description: "Налоговая задолженность." color: type: "string" description: "Цвет поля." enum: - "red" - "yellow" - "green" - "none" description: "Значение с цветом." description: "Результат внутренней проверки компании:\n* `BankruptcyMessage`\ \ — сообщения о банкротстве;\n* `Plaintiff` — судебные д\ ела в качестве истца;\n* `ThirdOrOtherPerson` — судебные\ \ дела в качестве третьего лица;\n* `Defendant` — судебн\ ые дела в качестве ответчика;\n* `DefendantDynamic` — ди\ намика судебных дел в качестве ответчика;\n* `ExecutedProceedings`\ \ — завершённые исполнительные производства;\n* `ActiveProceedings`\ \ — активные исполнительные производства;\n* `SameManager`\ \ — массовый руководитель;\n* `SameAddressNumber` — масс\ овый юридический адрес;\n* `Finance` — бухгалтерская отч\ ётность;\n* `IsNegative` — негативные списки;\n* `UnfairSupplier`\ \ — реестр недобросовестных поставщиков;\n* `InvalidLegalAddress`\ \ — список компаний, отсутствующих по юридическому адрес\ у;\n* `DisqualifiedPersons` — реестр дисквалифицированны\ х лиц;\n* `ReferenceCheckRecommended` — рекомендация про\ верки в справочных источниках;\n* `DueDiligenceRecommended`\ \ — рекомендация проведения документальной проверки (Due\ \ Diligence);\n* `TaxReport` — налоговая отчётность;\n*\ \ `TaxDebt` — налоговая задолженность." description: "Светофор надёжности внутренней проверки." example: companyCard: statusType: "active" requisites: inn: "000000000000" ogrn: "1000000000000" kpp: "000000000" shortName: "ПАО \"Название\"" fullName: "ПУБЛИЧНОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"Название\"" dateReg: "1990-01-01" terminationDt: "2020-11-20" status: "Действующая организация" authorizedCapitalAmount: 3975771140 ogrnAssignDate: "2000-01-01" legalAddress: "119019, г Москва, ул Арбат" city: "Москва" pages: - page: "okved" - page: "contract" - page: "license" - page: "history" - page: "trafficLight" - page: "relatedCompanies" - page: "feedback" - page: "financialStatements" data: companyType: "company" expressCheckResult: status: value: "Действующая организация" color: "none" registrationDate: value: "1994-06-21" color: "green" legalAddressChangeDate: value: "2019-07-10" color: "green" founderChangeDate: value: "2021-10-25" color: "green" confidantChangeDate: value: "2022-04-18" color: "green" authorizedCapitalAmount: value: 3975771140 color: "green" admittedContractsAsSupplier: value: count: 40 totalValue: 27523079541 color: "green" legalForm: value: "Публичные акционерные общества" color: "green" okvedCount: value: 22 color: "none" licensedOkvedCount: value: 0 color: "none" riskLevel: value: 0 color: "none" innerCheckResult: bankruptcyMessage: value: idType: 7 messageType: "Тип сообщения" date: "2021-10-26Z" decisionDate: "2021-10-19Z" caseNumber: "А56-13391/2020" caseId: 23040734 color: "green" plaintiff: value: minDate: 2004 maxDate: 2018 totalCases: 470 color: "yellow" thirdOrOtherPerson: value: minDate: 2007 maxDate: 2018 totalCases: 85 color: "yellow" defendant: value: minDate: 2007 maxDate: 2018 totalCases: 157 color: "yellow" defendantDynamic: value: lastYear: 2019 prevLastYear: 2018 percent: 50 color: "none" executedProceedings: value: 1326 color: "yellow" activeProceedings: value: 65 color: "red" sameManager: value: inn: "000000000000" sameManager: manager: "Фамилия Имя Отчество" managerCountInCountry: 1 managerInnCount: 1 color: "none" sameAddressNumber: value: 51 color: "yellow" finance: value: balanceType: 1 periods: - periodName: "2015" dateBegin: "2015-01-01+03:00" dateEnd: "2015-12-31+03:00" data: [] - periodName: "2016" dateBegin: "2016-01-01+03:00" dateEnd: "2016-12-31+03:00" data: [] - periodName: "2017" dateBegin: "2017-01-01+03:00" dateEnd: "2017-12-31+03:00" data: [] color: "green" isNegative: value: negativeListsCount: 0 color: "green" unfairSupplier: value: id: 1 isNegative: true listName: "Название" color: "green" invalidLegalAddress: value: id: 1 isNegative: true listName: "Название" color: "green" disqualifiedPersons: value: id: 1 isNegative: true listName: "Название" color: "green" taxReport: value: "2023-04-25" color: "none" taxDebt: value: sum: 10 statDate: "2000-01-01" color: "green" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "INVALID" errorMessage: "Некорректный ОГРН: 1000000000000" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "1b3c8ae867bc100d" errorCode: "NO_DATA" errorMessage: "Данные не найдены: ОГРН 000000000000000" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/credit-products/{brokerId}/applications/full: post: tags: - "Кредитные продукты" summary: "Создать полную заявку" description: "Метод для создания заявки на кредитный продукт банка. Запускае\ т процесс принятия решения по продукту.\n\nМетод асинхронный, решение и ст\ атус заявки передаются через вызов партнёра." operationId: "postApiV1Credit-productsBrokerIdApplicationsFull" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "brokerId" in: "path" description: "Уникальный идентификатор брокера." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" requestBody: content: application/json: schema: required: - "applicationPayload" - "files" type: "object" properties: process: type: "object" properties: processId: type: "string" description: "Идентификатор процесса." partnerId: type: "string" description: "Идентификатор партнёра." description: "Данные по процессу." partner: type: "object" properties: pointId: maxLength: 36 type: "string" description: "Уникальный идентификатор точки оформления заяв\ ки." personId: maxLength: 36 type: "string" description: "Уникальный идентификатор сотрудника." description: "Данные партнёра." applicationPayload: required: - "applicationId" - "clientInfo" type: "object" properties: applicationId: maxLength: 36 type: "string" description: "Уникальный идентификатор заявки." clientInfo: required: - "birthDate" - "documents" - "firstName" - "lastName" - "mobilePhone" type: "object" properties: firstName: maxLength: 50 pattern: "^[^\\s]+(\\s+[^\\s]+)*$" type: "string" description: "Имя." example: "Иван" lastName: maxLength: 50 pattern: "^[^\\s]+(\\s+[^\\s]+)*$" type: "string" description: "Фамилия." example: "Иванов" middleName: maxLength: 50 pattern: "^[^\\s]+(\\s+[^\\s]+)*$" type: "string" description: "Отчество." example: "Иванович" birthDate: pattern: "^((19|20)\\d\\d)-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$" type: "string" description: "Дата рождения." example: "1986-11-01" emailAddress: pattern: "^[a-zA-Z0-9_!#$%&'*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$" type: "string" description: "Адрес электронной почты." example: "i.ivanov@email.ru" education: type: "string" description: "Образование." example: "HIGHER" enum: - "SECONDARY_SPECIAL" - "INCOMPLETE_HIGHER" - "HIGHER" - "SECOND_HIGHER" - "ACADEMIC_DEGREE" maritalStatus: type: "string" description: "Семейное положение." example: "MARRIED_OFFICIAL" enum: - "WIDOW" - "DIVORCED" - "MARRIED_UNOFFICIAL" - "MARRIED_OFFICIAL" - "SINGLE" - "SEPARATED" workPhone: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Рабочий телефон." example: "79010101001" mobilePhone: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Мобильный телефон." example: "79010101001" documents: required: - "passport" type: "object" properties: passport: required: - "serialNumber" type: "object" properties: birthPlace: maxLength: 150 type: "string" description: "Место рождения." example: "Г. МОСКВА" serialNumber: maxLength: 20 type: "string" description: "Серия и номер документа." example: "1234567890" division: maxLength: 10 type: "string" description: "Код организации, выдавшей документ\ ." example: "123-456" date: pattern: "^((19|20)\\d\\d)-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$" type: "string" description: "Дата выдачи документа." example: "2020-09-01" organisationWhoGiven: maxLength: 200 type: "string" description: "Организация, выдавшая документ." registrationAddress: required: - "area" - "cityName" - "country" - "house" - "region" type: "object" properties: country: maxLength: 70 type: "string" description: "Страна." example: "РОССИЯ" correspondence: type: "boolean" description: "Корреспонденция." zipCode: maxLength: 30 type: "string" description: "Индекс." example: "150001" region: maxLength: 50 type: "string" description: "Регион, согласно КЛАДР." example: "ЯРОСЛАВСКАЯ" regionType: maxLength: 50 type: "string" description: "Тип региона." example: "ОБЛ" area: maxLength: 50 type: "string" description: "Район." areaType: maxLength: 50 type: "string" description: "Тип района." cityType: maxLength: 50 type: "string" description: "Тип населённого пункта, соглас\ но КЛАДР." example: "Г" cityName: maxLength: 50 type: "string" description: "Название населённого пункта." example: "ЯРОСЛАВЛЬ" placeType: maxLength: 50 type: "string" description: "Тип подчиненного населённого п\ ункта, согласно КЛАДР." placeName: maxLength: 50 type: "string" description: "Название подчинённого населенн\ ого пункта." streetType: maxLength: 50 type: "string" description: "Тип улицы, согласно КЛАДР." example: "ул" street: maxLength: 200 type: "string" description: "Название улицы." example: "ПРАВДЫ" house: maxLength: 30 type: "string" description: "Номер дома." example: "11" building: maxLength: 30 type: "string" description: "Корпус." structure: maxLength: 30 type: "string" description: "Строение." flat: maxLength: 12 type: "string" description: "Квартира." example: "10" description: "Адрес." residenceAddress: required: - "area" - "cityName" - "country" - "house" - "region" type: "object" properties: country: maxLength: 70 type: "string" description: "Страна." example: "РОССИЯ" correspondence: type: "boolean" description: "Корреспонденция." zipCode: maxLength: 30 type: "string" description: "Индекс." example: "150001" region: maxLength: 50 type: "string" description: "Регион, согласно КЛАДР." example: "ЯРОСЛАВСКАЯ" regionType: maxLength: 50 type: "string" description: "Тип региона." example: "ОБЛ" area: maxLength: 50 type: "string" description: "Район." areaType: maxLength: 50 type: "string" description: "Тип района." cityType: maxLength: 50 type: "string" description: "Тип населённого пункта, соглас\ но КЛАДР." example: "Г" cityName: maxLength: 50 type: "string" description: "Название населённого пункта." example: "ЯРОСЛАВЛЬ" placeType: maxLength: 50 type: "string" description: "Тип подчиненного населённого п\ ункта, согласно КЛАДР." placeName: maxLength: 50 type: "string" description: "Название подчинённого населенн\ ого пункта." streetType: maxLength: 50 type: "string" description: "Тип улицы, согласно КЛАДР." example: "ул" street: maxLength: 200 type: "string" description: "Название улицы." example: "ПРАВДЫ" house: maxLength: 30 type: "string" description: "Номер дома." example: "11" building: maxLength: 30 type: "string" description: "Корпус." structure: maxLength: 30 type: "string" description: "Строение." flat: maxLength: 12 type: "string" description: "Квартира." example: "10" description: "Адрес." description: "Паспорт." description: "Документы." previousJob: type: "object" properties: organization: maxLength: 300 type: "string" description: "Название организации." example: "АО «Тинькофф Банк»" jobPositionType: type: "string" description: "Тип занятости." example: "EMPLOYEE" enum: - "EMPLOYEE" - "SELF_EMPLOYED" - "COMMERCIAL_EMPLOYEE" - "GOVERNMENT_EMPLOYEE" - "STUDENT" - "PENSIONER" - "PENSIONER_WORKING" - "UNEMPLOYED" jobTitle: maxLength: 100 type: "string" description: "Название должности." example: "Специалист по работе с клиентами" startMonth: maximum: 12 minimum: 1 type: "integer" description: "Месяц начала работы. Если данных нет,\ \ не передавайте этот параметр." format: "int32" example: 3 startYear: maximum: 3000 minimum: 1900 type: "integer" description: "Год начала работы." format: "int32" example: 2011 averageMonthlyIncome: minimum: 1 type: "number" description: "Средний доход в месяц." example: 30000 workAddress: required: - "area" - "cityName" - "country" - "house" - "region" type: "object" properties: country: maxLength: 70 type: "string" description: "Страна." example: "РОССИЯ" correspondence: type: "boolean" description: "Корреспонденция." zipCode: maxLength: 30 type: "string" description: "Индекс." example: "150001" region: maxLength: 50 type: "string" description: "Регион, согласно КЛАДР." example: "ЯРОСЛАВСКАЯ" regionType: maxLength: 50 type: "string" description: "Тип региона." example: "ОБЛ" area: maxLength: 50 type: "string" description: "Район." areaType: maxLength: 50 type: "string" description: "Тип района." cityType: maxLength: 50 type: "string" description: "Тип населённого пункта, согласно К\ ЛАДР." example: "Г" cityName: maxLength: 50 type: "string" description: "Название населённого пункта." example: "ЯРОСЛАВЛЬ" placeType: maxLength: 50 type: "string" description: "Тип подчиненного населённого пункт\ а, согласно КЛАДР." placeName: maxLength: 50 type: "string" description: "Название подчинённого населенного\ \ пункта." streetType: maxLength: 50 type: "string" description: "Тип улицы, согласно КЛАДР." example: "ул" street: maxLength: 200 type: "string" description: "Название улицы." example: "ПРАВДЫ" house: maxLength: 30 type: "string" description: "Номер дома." example: "11" building: maxLength: 30 type: "string" description: "Корпус." structure: maxLength: 30 type: "string" description: "Строение." flat: maxLength: 12 type: "string" description: "Квартира." example: "10" description: "Адрес." description: "Текущее место работы." contacts: maximum: 5 minimum: 1 maxItems: 5 type: "array" items: required: - "firstName" - "lastName" - "mobilePhone" - "relation" properties: firstName: maxLength: 50 type: "string" description: "Имя." example: "Екатерина" lastName: maxLength: 50 type: "string" description: "Фамилия." example: "Ивановна" middleName: maxLength: 50 type: "string" description: "Отчество." example: "Петрова" relation: type: "string" description: "Тип отношений контактного лица с кли\ ентом." example: "MOTHER" enum: - "BROTHER" - "SISTER" - "MOTHER" - "FATHER" - "DAUGHTER" - "SON" - "HUSBAND" - "WIFE" - "OTHER_RELATIVE" - "FRIEND" - "COLLEAGUE" mobilePhone: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Мобильный телефон." example: "79010101001" description: "Информация о клиенте." description: "Данные по заявке." files: maxItems: 5 minItems: 1 type: "array" description: "Файлы." items: required: - "data" - "fileType" - "mimeType" type: "object" properties: data: type: "string" description: "Содержимое документа." format: "base64" mimeType: maxLength: 50 type: "string" description: "MIME-тип" example: "application/pdf" fileType: type: "string" description: "Тип документа." example: "BCI_PD" enum: - "PASSPORT_2_3P" - "PASSPORT_REG" - "PHOTO" - "BCI_PD" - "CONSENT_ECP" - "AGREEMENT" - "INDIV_CONDITIONS" description: "Документы" example: partner: pointId: "f2066320-7ac0-11ec-90d6-0242ac120004" personId: "f2066320-7ac0-11ec-90d6-0242ac120003" applicationPayload: applicationId: "applicationId" clientInfo: firstName: "Дмитрий" lastName: "Петров" middleName: "Валерьевич" birthDate: "1991-09-23" emailAddress: "ivanov@gmail.com" education: "HIGHER" maritalStatus: "SINGLE" workPhone: "+79123456789" mobilePhone: "+79123456789" documents: passport: birthPlace: "Г. МОСКВА" serialNumber: "1234567890" division: "123-456" date: "2020-09-01" organisationWhoGiven: "Отделом УФМС по всем городам всех обл\ астей необъятной нашей Родины" registrationAddress: country: "РОССИЯ" correspondence: true zipCode: "150001" region: "ЯРОСЛАВСКАЯ" regionType: "ОБЛ" area: "Москва" areaType: "Город" cityType: "Г" cityName: "ЯРОСЛАВЛЬ" placeType: "тер. СНТ" placeName: "ВМЗ N3" streetType: "ул" street: "ПРАВДЫ" house: "11" building: "1" structure: "2" flat: "10" residenceAddress: country: "РОССИЯ" correspondence: true zipCode: "150001" region: "ЯРОСЛАВСКАЯ" regionType: "ОБЛ" area: "Москва" areaType: "Город" cityType: "Г" cityName: "ЯРОСЛАВЛЬ" placeType: "тер. СНТ" placeName: "ВМЗ N3" streetType: "ул" street: "ПРАВДЫ" house: "11" building: "1" structure: "2" flat: "10" previousJob: organization: "АО «Тинькофф Банк»" jobPositionType: "STUDENT" jobTitle: "Специалист по работе с клиентами" startMonth: 3 startYear: 2011 averageMonthlyIncome: 30000 workAddress: country: "РОССИЯ" correspondence: true zipCode: "150001" region: "ЯРОСЛАВСКАЯ" regionType: "ОБЛ" area: "Москва" areaType: "Город" cityType: "Г" cityName: "ЯРОСЛАВЛЬ" placeType: "тер. СНТ" placeName: "ВМЗ N3" streetType: "ул" street: "ПРАВДЫ" house: "11" building: "1" structure: "2" flat: "10" contacts: - firstName: "Екатерина" lastName: "Ивановна" middleName: "Петрова" relation: "WIFE" mobilePhone: "+79010101001" files: - data: "iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAYAAABWdVznAAABaUlEQVQokZVSTUsCURS9b8bxKy3TrEhxYQtDCKplqwiEoK39hXZtXFW2KRJa9RvaBC2C6A+0rGiTmwJDkqQMs5TMYcT5eJ03RpTYooHz7r3nnsPj3TuMc07/+RziuJ3NhhFWgQhwBpwkr3Mm+GXki0ALOABXYjczmzEU54H5RET2uan9UCO1UDkGV/bGxzLuaIi4blDj4q4ObkHckBmGeGguTmRx8k+OkzcWThsfGvmnosRkRtwiYpwF65eFbWFIKgNuMt812yDe5Az5yRn0kaG2uxwg4XahFYa8WnpJMZdiN4RBRPrOLTtq91VhyAvDjlp8XjI6+rQrNkJiaLx7kJifyPVKg/TyaxHlGhPE15QOpdHBlDQRIHLK9gi5aZH12CBebV6hXMGUyuznHmBcR9g1E2HZ8igkPzVJqrX2wW1A3BEa1rs4mNIIR3rIIytvWg7CrV8C+2E9wG6ywGm/nuOPP2AP8PRrfAILd8GBXj/H8gAAAABJRU5ErkJggg==" mimeType: "image/png" fileType: "BCI_PD" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/credit-products/{brokerId}/applications/{applicationId}: delete: tags: - "Кредитные продукты" summary: "Отменить заявку" description: "Метод позволяет запустить процесс отмены заявки на кредитный п\ родукт.\n\nМетод асинхронный. Отменить заявку возможно до окончательной пр\ оверки подписанных документов." operationId: "deleteApiV1Credit-productsBrokerIdApplicationsApplicationid" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "applicationId" in: "path" description: "Уникальный идентификатор заявки." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" - name: "brokerId" in: "path" required: true style: "simple" explode: false schema: maxLength: 36 type: "string" description: "Уникальный идентификатор брокера." responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/credit-products/{brokerId}/applications/{applicationId}/activate-product: post: tags: - "Кредитные продукты" summary: "Активировать карту" description: "Метод запускает процесс активации карты на кредитный продукт.\ \ Метод асинхронный." operationId: "postApiV1Credit-productsBrokerIdApplicationsApplicationidActivate-product" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "applicationId" in: "path" description: "Уникальный идентификатор заявки." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" - name: "brokerId" in: "path" required: true style: "simple" explode: false schema: maxLength: 36 type: "string" description: "Уникальный идентификатор брокера." responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/credit-products/{brokerId}/applications/{applicationId}/confirm-offer: post: tags: - "Кредитные продукты" summary: "Привязать карту к счёту" description: "Метод для привязки карты из пула карт, имеющихся у партнёра, к\ \ счёту клиента. Возможна повторная привязка.\n\nМетод асинхронный." operationId: "postApiV1Credit-productsBrokerIdApplicationsApplicationidConfirm-offer" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "applicationId" in: "path" description: "Уникальный идентификатор заявки." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" - name: "brokerId" in: "path" description: "Уникальный идентификатор брокера." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" requestBody: content: application/json: schema: required: - "card" - "eventType" type: "object" properties: card: type: "object" properties: ucid: type: "integer" description: "UCID карты." format: "int64" example: 1145707389 ean: type: "integer" description: "EAN карты." format: "int64" example: 2989714752437 description: "Данные карты." eventType: type: "string" description: "Тип события." enum: - "LINK_CARD" - "LINK_CARD_UPDATE" example: card: ucid: 1145707389 ean: "2989714752437" eventType: "LINK_CARD" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/credit-products/{brokerId}/applications/{applicationId}/documents: get: tags: - "Кредитные продукты" summary: "Сгенерировать документы" description: "Метод для генерации документов, нужных для оформления кредитно\ го продукта. Метод синхронный.\n\nДопускается повторная генерация документ\ ов. При вызове генерируется весь необходимый комплект документов." operationId: "getApiV1Credit-productsBrokerIdApplicationsApplicationidDocuments" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "applicationId" in: "path" description: "Уникальный идентификатор заявки." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" - name: "brokerId" in: "path" required: true style: "simple" explode: false schema: maxLength: 36 type: "string" description: "Уникальный идентификатор брокера." responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: base64: type: "string" description: "Данные, закодированные в base64." format: "base64" example: base64: "iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAYAAABWdVznAAABaUlEQVQokZVSTUsCURS9b8bxKy3TrEhxYQtDCKplqwiEoK39hXZtXFW2KRJa9RvaBC2C6A+0rGiTmwJDkqQMs5TMYcT5eJ03RpTYooHz7r3nnsPj3TuMc07/+RziuJ3NhhFWgQhwBpwkr3Mm+GXki0ALOABXYjczmzEU54H5RET2uan9UCO1UDkGV/bGxzLuaIi4blDj4q4ObkHckBmGeGguTmRx8k+OkzcWThsfGvmnosRkRtwiYpwF65eFbWFIKgNuMt812yDe5Az5yRn0kaG2uxwg4XahFYa8WnpJMZdiN4RBRPrOLTtq91VhyAvDjlp8XjI6+rQrNkJiaLx7kJifyPVKg/TyaxHlGhPE15QOpdHBlDQRIHLK9gi5aZH12CBebV6hXMGUyuznHmBcR9g1E2HZ8igkPzVJqrX2wW1A3BEa1rs4mNIIR3rIIytvWg7CrV8C+2E9wG6ywGm/nuOPP2AP8PRrfAILd8GBXj/H8gAAAABJRU5ErkJggg==" "202": description: "Ответ в случае неготовности документа" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: message: pattern: "^Документ пока не готов, попробуйте позже$" type: "string" example: message: "Документ пока не готов, попробуйте позже" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" post: tags: - "Кредитные продукты" summary: "Загрузить документы" description: "Метод для загрузки документов, нужных для оформления кредитног\ о продукта. Метод синхронный." operationId: "postApiV1Credit-productsBrokerIdApplicationsApplicationidDocuments" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "applicationId" in: "path" description: "Уникальный идентификатор заявки." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" - name: "brokerId" in: "path" required: true style: "simple" explode: false schema: maxLength: 36 type: "string" description: "Уникальный идентификатор брокера." requestBody: content: application/json: schema: type: "object" properties: documents: maxItems: 5 minItems: 1 type: "array" description: "Документы." items: required: - "data" - "fileType" - "mimeType" type: "object" properties: data: type: "string" description: "Данные документа, закодированные в base64." format: "base64" mimeType: maxLength: 50 type: "string" description: "MIME-тип." example: "application/pdf" fileType: type: "string" description: "Тип документа." example: "BCI_PD" enum: - "PASSPORT_2_3P" - "PASSPORT_REG" - "PHOTO" - "BCI_PD" - "CONSENT_ECP" - "AGREEMENT" - "INDIV_CONDITIONS" documentExemplarId: maxLength: 50 type: "string" description: "Идентификатор документа (значение баркода) б\ ез префикса и постфикса." description: "Документы." example: documents: - data: "iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAYAAABWdVznAAABaUlEQVQokZVSTUsCURS9b8bxKy3TrEhxYQtDCKplqwiEoK39hXZtXFW2KRJa9RvaBC2C6A+0rGiTmwJDkqQMs5TMYcT5eJ03RpTYooHz7r3nnsPj3TuMc07/+RziuJ3NhhFWgQhwBpwkr3Mm+GXki0ALOABXYjczmzEU54H5RET2uan9UCO1UDkGV/bGxzLuaIi4blDj4q4ObkHckBmGeGguTmRx8k+OkzcWThsfGvmnosRkRtwiYpwF65eFbWFIKgNuMt812yDe5Az5yRn0kaG2uxwg4XahFYa8WnpJMZdiN4RBRPrOLTtq91VhyAvDjlp8XjI6+rQrNkJiaLx7kJifyPVKg/TyaxHlGhPE15QOpdHBlDQRIHLK9gi5aZH12CBebV6hXMGUyuznHmBcR9g1E2HZ8igkPzVJqrX2wW1A3BEa1rs4mNIIR3rIIytvWg7CrV8C+2E9wG6ywGm/nuOPP2AP8PRrfAILd8GBXj/H8gAAAABJRU5ErkJggg==" mimeType: "image/png" fileType: "PHOTO" documentExemplarId: "KNR3R8XB86S" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: documents: maxItems: 20 type: "array" description: "Документы." items: properties: documentId: maxLength: 50 type: "string" description: "Идентификатор документа." fileType: type: "string" description: "Тип документа." example: "BCI_PD" enum: - "PASSPORT_2_3P" - "PASSPORT_REG" - "PHOTO" - "BCI_PD" - "CONSENT_ECP" - "AGREEMENT" - "INDIV_CONDITIONS" example: documents: - documentId: "49614593" fileType: "PASSPORT_2_3P" - documentId: "49614594" fileType: "INDIV_CONDITIONS" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/credit-products/{brokerId}/applications/{applicationId}/documents/check: post: tags: - "Кредитные продукты" summary: "Проверка документов" description: "Запускает проверку документов после подписания с клиентом. Мет\ од асинхронный.\n\nПри переподписаниях или исправлениях допускается повтор\ ная проверка." operationId: "postApiV1Credit-productsBrokerIdApplicationsApplicationidDocumentsCheck" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "applicationId" in: "path" description: "Уникальный идентификатор заявки." required: true style: "simple" explode: false schema: maxLength: 36 type: "string" - name: "brokerId" in: "path" required: true style: "simple" explode: false schema: maxLength: 36 type: "string" description: "Уникальный идентификатор брокера." requestBody: content: application/json: schema: required: - "eventType" type: "object" properties: eventType: type: "string" description: "Тип события." enum: - "SIGNING" - "RESIGNING" example: eventType: "SIGNING" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/employees/add/by-requisites: post: tags: - "Зарплатный проект" summary: "Добавить сотрудника по реквизитам" description: " Метод для добавления сотрудников по реквизитам.\n\nЗапрос аси\ нхронный. Его результат можно получить через вызов метода Получить результат добавления сотрудника по реквизитам, передав в нём\ \ соответствующий correlationId.\n\nРекомендуем вызывать метод не ч\ аще одного раза в 10 минут." operationId: "addEmployeeRecipientsByRequisites" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "correlationId" - "employees" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запро\ сом получения ответа." format: "uuid" employees: maxItems: 2000 type: "array" description: "Список сотрудников на добавление." items: required: - "bankInfo" - "firstName" - "lastName" - "number" type: "object" properties: number: type: "integer" description: "Идентификатор сотрудника на стороне клиента." firstName: maxLength: 100 type: "string" description: "Имя (кириллица)." lastName: maxLength: 100 type: "string" description: "Фамилия (кириллица)." middleName: maxLength: 100 type: "string" description: "Отчество (кириллица)." birthDate: type: "string" description: "Дата рождения." format: "date" passportSerial: maxLength: 50 type: "string" description: "Серия паспорта." passportNumber: maxLength: 50 type: "string" description: "Номер паспорта." mobileNumber: maxLength: 50 type: "string" description: "Номер мобильного телефона." email: maxLength: 100 type: "string" description: "Электронная почта." bankInfo: required: - "accountNumber" type: "object" properties: bankBic: maxLength: 50 type: "string" description: "БИК банка. По умолчанию — Тинькофф." accountNumber: maxLength: 50 type: "string" description: "Номер счёта." description: "Данные о счёте." required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с зап\ росом получения ответа." format: "uuid" example: correlationId: "17de62bb-e448-45b1-a670-d71cf0d60785" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/employees/add/by-requisites/result: get: tags: - "Зарплатный проект" summary: "Получить результат добавления сотрудника по реквизитам" description: "\nМетод возвращает результат запроса для метода Добавить сотрудника по реквизитам. Ответ на запрос создания хранится\ \ в течение двух дней." operationId: "addEmployeeRecipientsByRequisitesResult" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "correlationId" in: "query" required: true style: "form" explode: true schema: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "employeesResults" type: "object" properties: employeesResults: maxItems: 2000 type: "array" description: "Список результатов добавления сотрудников." items: required: - "firstName" - "lastName" - "number" - "status" type: "object" properties: number: type: "integer" description: "Номер сотрудника, переданный клиентом при\ \ создании." employeeId: type: "integer" description: "Идентификатор сотрудника. Может не прийти\ , если при создании сотрудника возникли ошибки." firstName: maxLength: 100 type: "string" description: "Имя (кириллица)." lastName: maxLength: 100 type: "string" description: "Фамилия (кириллица)." middleName: maxLength: 100 type: "string" description: "Отчество (кириллица)." status: type: "string" description: "Статус создания:\n* `QUEUED` — самозанятый\ \ стоит в очереди на создание;\n* `CREATED` — самозаня\ тый создан в выплатах;\n* `ERROR` — самозанятый не был\ \ создан в выплатах. Ошибки перечислены в параметре errors. " enum: - "QUEUED" - "CREATED" - "ERROR" errors: maxItems: 100 type: "array" description: "Список ошибок." items: required: - "errorDescription" type: "object" properties: fieldName: maxLength: 400 type: "string" description: "Название поля, в котором есть ошибка\ ." errorDescription: maxLength: 400 type: "string" description: "Описание ошибки." example: employeesResults: - number: 123 firstName: "Иван" lastName: "Демидов" middleName: "Иванович" status: "ERROR" errors: - fieldName: "Инн" errorDescription: "Не указан инн" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/addresses: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить адреса" description: "Метод для получения адресов физического лица. Пользователь дол\ жен дать согласие на получение информации о паспортных данных." operationId: "getApiV2IndividualAddresses" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "addressType" in: "query" required: false style: "form" explode: true schema: type: "string" description: "Тип адреса:\n" enum: - "RESIDENCE_ADDRESS" - "REGISTRATION_ADDRESS" - "WORK_ADDRESS" - "DELIVERY_ADDRESS" responses: "200": description: "Адреса получены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: addresses: maxItems: 100 type: "array" description: "Адреса физического лица." items: required: - "addressType" - "primary" type: "object" properties: addressType: type: "string" description: "Тип адреса:\n" enum: - "RESIDENCE_ADDRESS" - "REGISTRATION_ADDRESS" - "WORK_ADDRESS" - "DELIVERY_ADDRESS" apartment: maxLength: 20 type: "string" description: "Квартира." building: maxLength: 20 type: "string" description: "Строение." city: maxLength: 1000 type: "string" description: "Город." claddrCode: maxLength: 100 type: "string" description: "Код адреса в КЛАДР." country: maxLength: 1000 type: "string" description: "Страна." district: maxLength: 1000 type: "string" description: "Район." fiasCode: maxLength: 100 type: "string" description: "Код адреса в ФИАС." house: maxLength: 20 type: "string" description: "Номер дома." housing: maxLength: 20 type: "string" description: "Корпус." latitude: type: "number" description: "Широта." format: "double" longitude: type: "number" description: "Долгота." format: "double" primary: type: "boolean" description: "Является основным адресом." region: maxLength: 1000 type: "string" description: "Регион." settlement: maxLength: 1000 type: "string" description: "Населённый пункт." street: maxLength: 1000 type: "string" description: "Улица." zipCode: maxLength: 10 type: "string" description: "Индекс." example: addresses: - addressType: "REGISTRATION_ADDRESS" apartment: "100" city: "Г ЯРОСЛАВЛЬ" claddrCode: "1200000600010530123" country: "РОССИЯ" fiasCode: "567845f8-72vb-45f3-ad16-bd4d12e06162" house: "120" latitude: 57.1234 longitude: 39.5678 primary: false region: "ЯРОСЛАВСКАЯ ОБЛ" street: "УЛ ПРАВДЫ" zipCode: "150001" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/blacklist/status: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Проверка на наличие в чёрных списках" description: "Метод возвращает информацию о том, находится ли пользователь в\ \ чёрных списках.\nПользователь должен дать согласие на получение информац\ ии о наличии в чёрных списках.\n\n\nВ поле scope у токена дол\ жен быть доступ вида opensme/individual/blacklist/status/get.\n\ \ " operationId: "getApiV1IndividualBlacklistStatus" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ApiBlacklistResponse" example: isBlacklisted: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/detail-counters: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить значение счётчика услуги клиента" description: "Метод возвращает текущее значение счётчика услуги партнёра для\ \ клиента." operationId: "getApiV1IndividualDetailCounters" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Информация о счётчике" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "clientInfo" - "counterInfo" type: "object" properties: clientInfo: required: - "grade" - "isFulfillConditions" type: "object" properties: grade: type: "string" description: "Грейд клиента:\n* `NONE` — без грейда;\n* `FIRST`\ \ — первый;\n* `SECOND` — второй;\n* `THIRD` — третий;\n\ * `FOURTH` — четвёртый." enum: - "NONE" - "FIRST" - "SECOND" - "THIRD" - "FOURTH" isFulfillConditions: type: "boolean" description: "Признак выполнения клиентом условий бесплатн\ ости тарифа." description: "Объект данных о состоянии клиента." counterInfo: required: - "count" - "isInfinity" - "period" type: "object" properties: count: type: "number" description: "Текущее состояние счётчика (количество досту\ пных услуг)." isInfinity: type: "boolean" description: "Признак бесконечного счётчика." period: required: - "repeatability" - "validFrom" - "validUntil" type: "object" properties: validFrom: pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$" type: "string" description: "Дата начала периода в формате `yyyy-mm-dd'T'HH:mm:ss`." validUntil: pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$" type: "string" description: "Дата окончания периода в формате `yyyy-mm-dd'T'HH:mm:ss`." repeatability: type: "string" description: "Тип периода:\n* `MONTH` — месяц;\n* `YEAR`\ \ — год." enum: - "MONTH" - "YEAR" description: "Объект данных о состоянии счётчика услуги." description: "Объект данных о состоянии счётчика услуги." description: "Результат получения информации о счётчике услуги кли\ ента" example: clientInfo: grade: "NONE" isFulfillConditions: true counterInfo: count: 1 isInfinity: true period: validFrom: "2023-01-15T12:00:00" validUntil: "2023-02-15T12:00:00" repeatability: "MONTH" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при некорректном запросе: value: errorId: "1" errorMessage: "Запрос не прошёл валидацию" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии премиальной подписки у клиента: value: errorId: "422" errorMessage: "У клиента нет активной премиальной подписки" errorCode: "NO_BUNDLE" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" post: tags: - "Tinkoff ID. Информация о пользователе" summary: "Изменить значение счётчика услуги клиента" description: "Метод для получения типа операции и значения, которые должны б\ ыть применены к счётчику услуги партнёра по клиенту." operationId: "setApiV1IndividualDetailCounters" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "count" type: "object" properties: count: type: "integer" description: "Значение операции." extraFields: required: - "description" type: "object" properties: description: maxLength: 256 type: "string" description: "Объект дополнительной информации от партнёра." examples: Корректный запрос: value: count: 1 Корректный запрос c extraFields: value: count: 1 extraFields: description: "test" required: true responses: "200": description: "Информация о счётчике" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "count" - "isInfinity" type: "object" properties: count: type: "integer" description: "Итоговое значение счётчика услуги." isInfinity: type: "boolean" description: "Признак бесконечного счётчика." description: "Результат получения информации о счётчике услуги кли\ ента." examples: Успешный ответ: value: count: 2 isInfinity: true "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при некорректном запросе: value: errorId: "1" errorMessage: "Запрос не прошёл валидацию" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии премиальной подписки у клиента: value: errorId: "422" errorMessage: "У клиента нет активной премиальной подписки" errorCode: "NO_BUNDLE" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/passport: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить паспортные данные" description: "Метод для получения паспортных данных пользователя. Пользовате\ ль должен дать согласие на получение информации о паспортных данных." operationId: "getApiV2Passport" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "idType" in: "query" required: false style: "form" explode: true schema: maxItems: 6 type: "array" items: type: "string" description: "Тип документа:\n" enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_INTERNATIONAL_PASSPORT" - "RF_INTERNATIONAL_PASSPORT" - "BIRTH_CERTIFICATE" - "RF_RESIDENCE_PERMIT" responses: "200": description: "Паспортные данные получены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: maxLength: 1000 type: "string" description: "Место рождения." citizenship: maxLength: 100 type: "string" description: "Гражданство." issueDate: type: "string" description: "Дата выдачи." format: "date" maritalStatus: maxLength: 1000 type: "string" description: "Семейное положение." marriageDate: type: "string" description: "Дата регистрации брака." format: "date" numberOfChildren: type: "integer" description: "Количество детей." resident: type: "boolean" description: "Является гражданином РФ." serialNumber: maxLength: 30 type: "string" description: "Серия и номер." unitCode: maxLength: 40 type: "string" description: "Код подразделения." unitName: maxLength: 2000 type: "string" description: "Название подразделения." validTo: type: "string" description: "Время действия паспорта." format: "date" idType: type: "string" description: "Тип документа:\n" enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_INTERNATIONAL_PASSPORT" - "RF_INTERNATIONAL_PASSPORT" - "BIRTH_CERTIFICATE" - "RF_RESIDENCE_PERMIT" description: "Паспортные данные гражданина РФ." example: birthDate: "2020-09-01" birthPlace: "Г. МОСКВА" citizenship: "РФ" issueDate: "2020-09-01" maritalStatus: "Женат/замужем" marriageDate: "2020-09-01" numberOfChildren: 0 resident: true serialNumber: "1234567890" unitCode: "123-456" unitName: "УМВД РОССИИ ПО Г. МОСКВЕ" validTo: "2020-09-01" idType: "PASSPORT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/passport-check-smev: post: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Отправить запрос на проверку паспорта в СМЭВ 3.0" description: "Метод для отправки запроса на проверку паспорта.\n\nКогда вы о\ тправляете запрос на проверку в СМЭВ 3.0, в ответе возвращается `requestID`\ \ — идентификатор заявки по пользователю на проверку." operationId: "postApiV1PassportCheckSmev" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Запрос на проверку паспортных данных отправлен" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "requestId" type: "object" properties: requestId: type: "string" description: "Идентификатор запроса проверки в СМЭВ 3.0 для по\ лучения результата." format: "uuid" description: "Запрос на проверку паспортных данных отправлен в СМЭ\ В." example: requestId: "30109424-c045-4831-9307-31121a0d2045" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Паспортные данные не найдены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "123456abcdef" errorMessage: "Паспортные данные не найдены" errorCode: "PASSPORT_NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/passport-check-smev/status: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить результат проверки паспорта в СМЭВ 3.0" description: "Метод для получения статуса или результата проверки. Вы переда\ ёте requestID, который получили через метод POST, и в ответе получаете ста\ тус проверки заявки.\n \n\n Общие рекомендации:\n - Нет ограничения количе\ ства запросов на проверку заявки.\n - Выполняйте запрос на проверку каждой\ \ заявки не чаще 1 раза в 3 секунды.\n - Создавать новую заявку, пока не п\ олучен ответ по старой, не нужно — банк вернёт вам requestId уже активной\ \ заявки. Это механизм защиты от перегрузки. \n\n Из статуса `IN_PROGRESS`\ \ заявка перейдёт в `VALID`/`INVALID` или по истечении внутреннего таймаут\ а (5 минут) get status с этим `requestID` начнёт возвращать `NOT FOUND`." operationId: "getApiV1PassportCheckSmev" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "requestId" in: "query" description: "Идентификатор, полученный в результате выполнения POST-запро\ са." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "21b09221-33bb-42f4-99d0-66578722ee66" responses: "200": description: "Запрос найден, статус получен" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "result" type: "object" properties: result: type: "string" description: "Статус или результат проверки паспортных данных\ \ в СМЭВ 3.0:\n * `IN_PROGRESS` — процесс проверки ещё не за\ кончен. Повторите запрос через некоторое время.\n * `VALID`\ \ — паспорт действителен.\n * `INVALID` — паспорт недействит\ елен или не существует." enum: - "IN_PROGRESS" - "VALID" - "INVALID" description: "Статус проверки паспортных данных в СМЭВ 3.0 получен\ ." example: result: "IN_PROGRESS" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Запрос на проверку не найден" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "123456abcdef" errorMessage: "Запрос на проверку с указанным идентификатором не н\ айден" errorCode: "REQUEST_NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/passport-check-smev4: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Отправить запрос на проверку паспорта в СМЭВ 4.0" description: "Метод для отправки запроса на проверку паспорта через СМЭВ 4." operationId: "postApiV1PassportCheckSmev4" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Валиден ли паспорт пользователя по версии СМЭВ 4" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "result" type: "object" properties: result: type: "string" description: "Статус или результат проверки паспортных данных\ \ в СМЭВ 4.0:\n * `VALID` — паспорт действителен;\n * `INVALID`\ \ — паспорт недействителен или не существует." enum: - "VALID" - "INVALID" example: result: "VALID" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/passport-short: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить паспортные данные с проверкой в ФНС" description: "Метод для получения паспортных данных пользователя с проверкой\ \ в ФНС. Пользователь должен дать согласие на получение информации о паспо\ ртных данных." operationId: "getApiV2PassportShort" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Паспортные данные подтверждены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: birthDate: type: "string" description: "Дата рождения." format: "date" citizenship: maxLength: 100 type: "string" description: "Гражданство." issueDate: type: "string" description: "Дата выдачи." format: "date" serialNumber: pattern: "^(\\d{10})$" type: "string" description: "Серия и номер." unitCode: maxLength: 20 type: "string" description: "Код подразделения." unitName: maxLength: 2000 type: "string" description: "Название подразделения." description: "Подтверждённые актуальные паспортные данные граждани\ на РФ." example: birthDate: "1993-11-22" citizenship: "РФ" issueDate: "2012-02-02" serialNumber: "1122334455" unitCode: "999-666" unitName: "ТП №666 ОТДЕЛА УФМС РОССИИ ПО ПАРКУ ГОРЬКОГО" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Паспортные данные не подтверждены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "123456abcdef" errorMessage: "Паспортные данные не найдены" errorCode: "PASSPORT_NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/foreignagent/status: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить признак иностранного агента" description: "Метод возвращает информацию о том, является ли пользователь ин\ остранным агентом.\nПользователь должен дать согласие на получение информа\ ции о признаке иностранного агента.\n\n\nВ поле scope у токен\ а должен быть доступ вида opensme/individual/foreignagent/status/get.\n\ \ " operationId: "getApiV1IndividualForeignagentStatus" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ApiForeignAgentResponse" example: isForeignAgent: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/identification/status: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить информацию об идентификации пользователя" description: "Метод возвращает информацию о том, идентифицирован ли пользова\ тель.\n\n\nЧтобы использовать метод, нужен доступ — opensme/individual/identification/status/get\ \ — Информация об идентификации пользователя.\n " operationId: "getApiV1IndividualIdentificationStatus" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/IdentificationStatusResponse" example: isIdentified: true "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/pdl/status: get: tags: - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" summary: "Получить признак публичного должностного лица" description: "Метод возвращает информацию о том, является ли пользователь пу\ бличным должностным лицом.\nПользователь должен дать согласие на получение\ \ информации о признаке публичного должностного лица.\n\n\nВ поле scope\ \ у токена должен быть доступ вида opensme/individual/pdl/status/get.\n\ \ " operationId: "getApiV1IndividualPdlStatus" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ApiPDLResponse" example: isPublicOfficialPerson: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/loyalty/offers/view/bulk: post: tags: - "Cпецпредложения и кэшбэк" summary: "Зафиксировать факты просмотра офферов клиентом" description: "Метод для фиксации факта просмотра офферов клиентом." operationId: "postApiV1LoyaltyOffersViewBulk" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "phoneNumber" type: "object" properties: phoneNumber: type: "string" description: "Номер телефона клиента в формате `E.164`." offerIds: type: "array" description: "ID просмотренных офферов." items: type: "integer" format: "int64" example: phoneNumber: "79990001122" offerIds: - 11111 - 22222 - 33333 required: true responses: "200": description: "Факты просмотра офферов клиентом зафиксированы" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}: delete: tags: - "Управление сделками" summary: "Удалить сделку" description: "\nПозволяет удалить сделку, которая находится в статусе `DRAFT`.\n\ \n\nОграничение на использование метода — 10 запросов в секунду.\n\n\nЧтоб\ ы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "deleteApiV1Nominal-accountsDealsDealid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/is-valid: get: tags: - "Управление сделками" summary: "Получить статус проверки на возможность проведения платежей по сде\ лке" description: "\nМетод позволяет проверить возможность совершения платежа в с\ делке — сверяет сумму депонирования с суммой в настройках, проверяет хвата\ ет ли указанных средств на виртуальных счетах депонентов." operationId: "getApiV1Nominal-accountsDealsDealidIs-valid" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "isValid" type: "object" properties: isValid: type: "boolean" description: "Флаг возможности проведения платежей по сделке." reasons: type: "array" description: "Описание причин невозможности проведения платеже\ й по сделке." items: type: "object" properties: code: type: "string" description: "Код ошибки." description: type: "string" description: "Описание ошибки." details: type: "object" additionalProperties: type: "string" description: "Дополнительная информация об ошибке." example: isValid: false reasons: - code: "NO_STEPS_IN_DEAL" description: "Deal contains no steps." details: stepId: "306f557f-2b3c-460d-8429-1d61c59836df" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных." headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Deaal not found" errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}: put: tags: - "Управление этапами сделок" summary: "Обновить этап" description: "\nПозволяет внести изменения в этап сделки. Только для сделок\ \ в статусе `DRAFT`.\n\n\nОграничение на использование метода — 10 запросо\ в в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "putApiV1Nominal-accountsDealsDealidStepsStepid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/StepRequest" example: description: "Описание этапа сделки" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/StepResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" stepNumber: 1 description: "Описание этапа сделки" status: "NEW" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] delete: tags: - "Управление этапами сделок" summary: "Удалить этап" description: "\nПозволяет удалить этап. Только для сделок в статусе `DRAFT`.\n\ \n\nОграничение на использование метода — 10 запросов в секунду.\n\n\nЧтоб\ ы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "deleteApiV1Nominal-accountsDealsDealidStepsStepid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/payments/{paymentId}: get: tags: - "Биллинг" summary: "Получить платёж по ID платежа" description: "Метод позволяет получить платёж по ID платежа." operationId: "getApiV1Nominal-accountsPaymentsPaymentid" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "paymentId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор платежа." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: oneOf: - required: - "accountNumber" - "amount" - "bankDetails" - "beneficiaryId" - "paymentId" - "purpose" - "status" - "type" type: "object" properties: type: type: "string" description: "Тип платежа:\n* `REGULAR` — обычный;\n* `TAX`\ \ — налоговый." enum: - "REGULAR" - "TAX" paymentId: type: "string" description: "Идентификатор платежа." format: "uuid" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." bankDetails: oneOf: - required: - "cardId" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS`\ \ — по реквизитам счёта;\n* `CARD` — на карту;\n* `SBP`\ \ — через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" cardId: maxLength: 256 minLength: 1 type: "string" description: "Идентификатор карты в системе банка." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." description: "Банковские реквизиты." - required: - "accountNumber" - "bankName" - "bik" - "corrAccountNumber" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS`\ \ — по реквизитам счёта;\n* `CARD` — на карту;\n* `SBP`\ \ — через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя. С 01.01.2021 г. пр\ и перечислении налоговых платежей в этом поле нужно\ \ указывать новые значения БИК банков получателя. [П\ одробнее](https://spmag.ru/articles/polya-platezhnogo-porucheniya-v-2021-godu-obrazec)" kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП получателя." inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН. Укажите 0, чтобы не заполнять." name: maxLength: 160 type: "string" description: "Наименование получателя." bankName: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка получателя. С 01.01.2021\ \ г. при заполнении платежёк на перечисление налогов\ \ в этом поле нужно указывать название счёта казначе\ йства после названия банка через знак «//»." accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта. С 01.01.2021 г.\ \ для бюджетных платежей в этом поле нужно указывать\ \ новые номера казначейских счетов." corrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя\ . С 01.01.2021 г. при уплате налогов указывается ном\ ер счёта банка получателя, который входит в состав е\ диного казначейского счёта (ЕКС). Раньше это поле за\ полнялось нулями." description: "Банковские реквизиты." - required: - "bankId" - "phoneNumber" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS`\ \ — по реквизитам счёта;\n* `CARD` — на карту;\n* `SBP`\ \ — через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" phoneNumber: pattern: "(\\+7)([0-9]){10}" type: "string" description: "Номер мобильного телефона." bankId: pattern: "\\d{12}" type: "string" description: "Идентификатор банка в системе быстрых пл\ атежей." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." description: "Банковские реквизиты." dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа сделки." format: "uuid" recipientId: type: "string" description: "Идентификатор реципиента." format: "uuid" amount: type: "number" description: "Сумма платежа." status: type: "string" description: "Статус платежа. \n\n![payment-statuses](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/payment-statuses.svg)\n\ * `PENDING` — ожидает обработки;\n* `IN_PROGRESS` — в проц\ ессе;\n* `FAILED` — неуспешен;\n* `CANCELLED` — отменён;\n\ * `SUCCEEDED` — успешно завершён." enum: - "PENDING" - "IN_PROGRESS" - "FAILED" - "CANCELLED" - "SUCCEEDED" errorMessage: type: "string" description: "Описание ошибки при неуспешном платеже." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." operationId: type: "string" description: "Уникальный ID операции." format: "uuid" - required: - "accountNumber" - "amount" - "bankDetails" - "beneficiaryId" - "paymentId" - "purpose" - "status" - "tax" - "type" - "uin" type: "object" properties: type: type: "string" description: "Тип платежа:\n* `REGULAR` — обычный;\n* `TAX`\ \ — налоговый." enum: - "REGULAR" - "TAX" paymentId: type: "string" description: "Идентификатор платежа." format: "uuid" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счета." bankDetails: oneOf: - required: - "cardId" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS`\ \ — по реквизитам счёта;\n* `CARD` — на карту;\n* `SBP`\ \ — через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" cardId: maxLength: 256 minLength: 1 type: "string" description: "Идентификатор карты в системе банка." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." description: "Банковские реквизиты." - required: - "accountNumber" - "bankName" - "bik" - "corrAccountNumber" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS`\ \ — по реквизитам счёта;\n* `CARD` — на карту;\n* `SBP`\ \ — через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя. С 01.01.2021 г. пр\ и перечислении налоговых платежей в этом поле нужно\ \ указывать новые значения БИК банков получателя. [П\ одробнее](https://spmag.ru/articles/polya-platezhnogo-porucheniya-v-2021-godu-obrazec)" kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП получателя." inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН. Укажите 0, чтобы не заполнять." name: maxLength: 160 type: "string" description: "Наименование получателя." bankName: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка получателя. С 01.01.2021\ \ г. при заполнении платежёк на перечисление налогов\ \ в этом поле нужно указывать название счёта казначе\ йства после названия банка через знак «//»." accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта. С 01.01.2021 г.\ \ для бюджетных платежей в этом поле нужно указывать\ \ новые номера казначейских счетов." corrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя\ . С 01.01.2021 г. при уплате налогов указывается ном\ ер счёта банка получателя, который входит в состав е\ диного казначейского счёта (ЕКС). Раньше это поле за\ полнялось нулями." description: "Банковские реквизиты." - required: - "bankId" - "phoneNumber" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS`\ \ — по реквизитам счёта;\n* `CARD` — на карту;\n* `SBP`\ \ — через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" phoneNumber: pattern: "(\\+7)([0-9]){10}" type: "string" description: "Номер мобильного телефона." bankId: pattern: "\\d{12}" type: "string" description: "Идентификатор банка в системе быстрых пл\ атежей." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." description: "Банковские реквизиты." amount: type: "number" description: "Сумма платежа." status: type: "string" description: "Статус платежа. \n\n![payment-statuses](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/payment-statuses.svg)\n\ * `PENDING` — ожидает обработки;\n* `IN_PROGRESS` — в проц\ ессе;\n* `FAILED` — неуспешен;\n* `CANCELLED` — отменён;\n\ * `SUCCEEDED` — успешно завершён." enum: - "PENDING" - "IN_PROGRESS" - "FAILED" - "CANCELLED" - "SUCCEEDED" errorMessage: type: "string" description: "Описание ошибки при неуспешном платеже." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." operationId: type: "string" description: "Уникальный ID операции." format: "uuid" uin: pattern: "0|[А-Яа-яA-Za-z0-9]{4}|[А-ЯA-Z0-9]{20}|[А-ЯA-Z0-9]{25}" type: "string" description: "Уникальный идентификатор платежа." tax: required: - "docDate" - "docNumber" - "evidence" - "kbk" - "oktmo" - "payerStatus" - "period" type: "object" properties: payerStatus: pattern: "\\d{2}" type: "string" description: "Статус составителя расчетного документа. П\ оле платежки 101. ВАЖНО: При оплате налога за третьих\ \ лиц указывается налоговый статус человека, за которо\ го происходит оплата. Поле может принимать следующие з\ начения: \ \ Подробнее: [Статус плательщика в платежном поручении\ \ в 2021 году — Бухонлайн (buhonline.ru)](https://www.buhonline.ru/pub/beginner/2019/10/15119_status-platelshhika-v-platezhke-2021)" kbk: pattern: "\\d{20}|0" type: "string" description: "Код бюджетной классификации. Поле платежки\ \ 104. Подробнее: https://buhguru.com/spravka-info/kbk-2021.html" oktmo: pattern: "\\d{8}|\\d{11}" type: "string" description: "Код ОКТМО территории, на которой мобилизую\ тся денежные средства от уплаты налога, сбора и иного\ \ платежа. Поле платежки 105.\nПодробнее: https://nalog-nalog.ru/uplata_nalogov/rekvizity_dlya_uplaty_nalogov_vznosov/oktmo_v_platezhnom_poruchenii_nyuansy/" evidence: pattern: "[A-Za-zА-Яа-я]{2}|00|0" type: "string" description: "Основание налогового платежа. Поле платежк\ и 106. Поле может принимать следующие значения: Подробнее: [Н\ овые правила заполнения поля 106 платежных поручений с\ \ 1 октября 2021 года (26-2.ru)](https://www.26-2.ru/art/356241-polya-106-platejnyh-1-oktyabrya-2021)" period: pattern: "([A-Za-zА-Яа-я]{2}|\\d{2})\\.\\d{2}\\.\\d{4}|0" type: "string" description: "Налоговый период. Поле платежки 107.\nФорм\ ат — ДД.ММ.ГГГГ, первые два символа могут быть буквами\ \ или цифрами; а также поле может быть передано 0.\nПо\ дробнее: https://www.nalog.ru/rn40/news/tax_doc_news/6181298/" docNumber: pattern: "[A-Za-zА-Яа-я]{2}\\d{13}|\\d{2};\\d{1,20}|[A-Za-zА\ -Яа-я]{2}|0{1}" type: "string" description: "Номер налогового документа. Поле платежки\ \ 108. Подробнее: [Как заполнить поля платежного поруч\ ения и не ошибиться (azbuha.ru)](https://azbuha.ru/uchet-denezhnyx-sredstv/kak-zapolnit-polya-platezhnogo-porucheniya/#:~:text=%D0%92%20%D0%BF%D0%BE%D0%BB%D0%B5%20108%20%D1%81%D1%82%D0%B0%D0%B2%D0%B8%D1%82%D1%81%D1%8F%20%C2%AB0%C2%BB%2C,%D0%9F%D0%BE%D0%BB%D0%B5%20109%20%C2%AB%D0%94%D0%B0%D1%82%D0%B0%20%D0%BE%D1%81%D0%BD%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%B0%C2%BB)" docDate: pattern: "\\d{2}\\.\\d{2}\\.\\d{4}|0" type: "string" description: "Дата налогового документа. Поле платежки 109.\ \ Формат — ДД.ММ.ГГГГ или 0.\nПодробнее :https://www.nalog.ru/rn40/news/tax_doc_news/4604512/" thirdParty: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН третьего лица." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП третьего лица." description: "Реквизиты для оплаты налогов за третьих ли\ ц. [Подробнее](https://glavkniga.ru/situations/s509587)." description: "Реквизиты для уплаты налогов и иных бюджетных\ \ платежей." examples: Успешный обычный платёж по реквизитам счёта: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Неуспешный обычный платёж по реквизитам счёта: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Проверьте номер счёта банка получателя — возмож\ но, вы указали неправильные цифры" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Успешный обычный платёж по карточным реквизитам: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "CARD" cardId: "70000000707" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Неуспешный обычный платёж по карточным реквизитам: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "CARD" cardId: "70000000707" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Transaction not permitted to card" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Успешный обычный платёж через СБП: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "SBP" phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Неуспешный обычный платёж через СБП: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "SBP" phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Specified bank is not SBP member" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Успешный налоговый платёж: value: type: "TAX" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 status: "SUCCEEDED" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по\ \ исполнительному листу от 01.08.2021 по делу N 2-2733/2021" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" Неуспешный налоговый платёж: value: type: "TAX" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 status: "FAILED" errorMessage: "Проверьте номер счёта банка получателя — возмож\ но, вы указали неправильные цифры" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по\ \ исполнительному листу от 01.08.2021 по делу N 2-2733/2021" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных." headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Ошибка при обработке данных" errorCode: "UNPROCESSABLE_ENTITY" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/nominal-accounts/virtual-accounts/transfers: get: tags: - "Биллинг" summary: "Получить список переводов между виртуальными счетами" description: "Метод позволяет получить информацию о переводах средств между\ \ виртуальными счетами бенефициаров в рамках одного номинального счёта." operationId: "getApiV1Nominal-accountsVirtualAccountsTransfers" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "accountNumber" in: "query" required: true style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." - name: "dealId" in: "query" required: false style: "form" explode: true schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "fromBeneficiaryId" in: "query" required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара-отправителя." format: "uuid" - name: "limit" in: "query" description: "Количество переводов, которое нужно вывести. По умолчанию —\ \ 50." required: false style: "form" explode: true schema: type: "integer" - name: "offset" in: "query" description: "Количество переводов, которое нужно пропустить. По умолчанию\ \ — 0." required: false style: "form" explode: true schema: type: "integer" - name: "toBeneficiaryId" in: "query" required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара-получателя." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество переводов для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество переводов для вывода." format: "int32" size: type: "integer" description: "Количество переводов в ответе." format: "int32" total: type: "integer" description: "Всего переводов, подходящих под условия запроса." format: "int32" results: maxItems: 50 type: "array" description: "Список переводов." items: required: - "accountNumber" - "amount" - "from" - "to" - "transferId" type: "object" properties: type: type: "string" description: "Тип перевода." enum: - "DIRECT" - "TO_DEAL" - "FROM_DEAL" transferId: type: "string" description: "Идентификатор перевода." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." from: oneOf: - required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Отправитель." - required: - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа." format: "uuid" to: oneOf: - required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Получатель." - required: - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа." format: "uuid" amount: type: "number" description: "Сумма платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." example: offset: 0 limit: 50 size: 3 total: 3 results: - type: "DIRECT" transferId: "a769f88b-b215-4a92-8473-c6b6ca60d0d0" accountNumber: "40702810110011000777" from: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" to: beneficiaryId: "49e46893-9a7e-409b-8c79-647aecaae555" purpose: "Назначение платежа" amount: 322 - type: "TO_DEAL" transferId: "a769f88b-b215-4a92-8473-c6b6ca60d0d1" accountNumber: "40702810110011000777" from: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" to: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" amount: 322 - type: "FROM_DEAL" transferId: "a769f88b-b215-4a92-8473-c6b6ca60d0d2" accountNumber: "40702810110011000777" from: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" to: beneficiaryId: "49e46893-9a7e-409b-8c79-647aecaae555" purpose: "Назначение платежа" amount: 322 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных." headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Ошибка при обработке данных" errorCode: "UNPROCESSABLE_ENTITY" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" post: tags: - "Биллинг" summary: "Перевод между виртуальными счетами" description: "Метод позволяет перевести средства с виртуального счёта одного\ \ бенефициара на виртуальный счёт другого бенефициара." operationId: "postApiV1Nominal-accountsVirtualAccountsTransfers" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности." format: "uuid" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: description: "Детали перевода" content: application/json: schema: required: - "accountNumber" - "amount" - "from" - "to" type: "object" properties: accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." from: required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Отправитель." to: required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Получатель." amount: type: "number" description: "Сумма платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." example: accountNumber: "40702810110011000777" from: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" to: beneficiaryId: "023428b8-f490-4456-a58e-d97460db3923" amount: 100 purpose: "Назначение платежа" responses: "201": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "accountNumber" - "amount" - "from" - "to" - "transferId" type: "object" properties: type: type: "string" description: "Тип перевода." enum: - "DIRECT" - "TO_DEAL" - "FROM_DEAL" transferId: type: "string" description: "Идентификатор перевода." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." from: oneOf: - required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Отправитель." - required: - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа." format: "uuid" to: oneOf: - required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Получатель." - required: - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа." format: "uuid" amount: type: "number" description: "Сумма платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." example: type: "DIRECT" transferId: "894c5178-4d7f-41da-b4d3-1433c67ce26b" accountNumber: "40702810110011000777" from: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" to: beneficiaryId: "023428b8-f490-4456-a58e-d97460db3923" amount: 100 purpose: "Назначение платежа" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных." headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: UnprocessableEntity: value: errorId: "retw6789" errorMessage: "Ошибка при обработке данных" errorCode: "UNPROCESSABLE_ENTITY" InsufficientFunds: value: errorId: "cde4zxc5" errorMessage: "Beneficiary has insufficient funds on virtual account\ \ of type = REGULAR." errorCode: "INSUFFICIENT_FUNDS" InvalidAmount: value: errorId: "235b1ca1" errorMessage: "Beneficiary's virtual account of type = REGULAR\ \ cannot be increased by 100." errorCode: "INVALID_AMOUNT" InvalidScoringStatus: value: errorId: "5d1b1e59" errorMessage: "Beneficiary scoring is still in progress or has\ \ been failed for some beneficiaries." errorCode: "INVALID_SCORING_STATUS" errorDetails: beneficiaryIds: - "61f656e0-0a86-4ec2-bd43-232499f7ad66" BeneficiaryNotFound: value: errorId: "fece684e" errorMessage: "Beneficiary scoring is still in progress or has\ \ been failed for some beneficiaries." errorCode: "NOT_FOUND" errorDetails: beneficiaryIds: - "61f656e0-0a86-4ec2-bd43-232499f7ad66" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/nominal-accounts/virtual-accounts/transfers/{transferId}: get: tags: - "Биллинг" summary: "Получить информацию о переводе между виртуальными счетами" description: "Метод позволяет получить информацию о переводе средств с вирту\ ального счёта одного бенефициара на виртуальный счёт другого бенефициара." operationId: "getApiV1Nominal-accountsVirtualAccountsTransfersTransferId" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "transferId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор перевода." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "accountNumber" - "amount" - "from" - "to" - "transferId" type: "object" properties: type: type: "string" description: "Тип перевода." enum: - "DIRECT" - "TO_DEAL" - "FROM_DEAL" transferId: type: "string" description: "Идентификатор перевода." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." from: oneOf: - required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Отправитель." - required: - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа." format: "uuid" to: oneOf: - required: - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" description: "Получатель." - required: - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа." format: "uuid" amount: type: "number" description: "Сумма платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." examples: Прямой перевод между бенефициарами: value: type: "DIRECT" transferId: "894c5178-4d7f-41da-b4d3-1433c67ce26b" accountNumber: "40702810110011000777" from: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" to: beneficiaryId: "023428b8-f490-4456-a58e-d97460db3923" amount: 100 purpose: "Назначение платежа" Перевод от бенефициара в сделку: value: type: "TO_DEAL" transferId: "a769f88b-b215-4a92-8473-c6b6ca60d0d1" accountNumber: "40702810110011000777" from: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" to: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" amount: 322 Перевод из сделки бенефициару: value: type: "FROM_DEAL" transferId: "a769f88b-b215-4a92-8473-c6b6ca60d0d2" accountNumber: "40702810110011000777" from: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" to: beneficiaryId: "49e46893-9a7e-409b-8c79-647aecaae555" purpose: "Назначение платежа" amount: 322 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных." headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Ошибка при обработке данных" errorCode: "UNPROCESSABLE_ENTITY" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/openapi/invoice/{invoiceId}/info: get: tags: - "Выставление счетов" summary: "Получить информацию о выставленном счёте" description: "Метод для получения статуса выставленного счёта." operationId: "getApiV1InvoiceInvoiceIdInfo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "invoiceId" in: "path" description: "Идентификатор выставленного счёта." required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор выставленного счёта." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "status" type: "object" properties: status: type: "string" description: "Статус выставленного счёта: \n\n* `DRAFT` — черн\ овик;\n* `SUBMITTED` — отправлен;\n* `EXECUTED` — оплачен." enum: - "DRAFT" - "SUBMITTED" - "EXECUTED" example: status: "SUBMITTED" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "56554da5f4" errorMessage: "Счёт не найден" errorCode: "INVOICE_NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/payment/status: post: tags: - "Платежи" summary: "Получить список статусов платёжных документов" description: " Метод позволяет узнать статус черновика платежа, созданного ч\ ерез метод [Создать черновик платёжного поручения](https://developer.tinkoff.ru/docs/api/post-api-v-1-payment-create).\n\ \nМаксимальное количество черновиков для отправки в одном массиве — 100." operationId: "paymentStatus" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "documentIds" type: "object" properties: documentIds: maxItems: 100 minItems: 1 type: "array" description: "Идентификаторы документов." items: type: "string" description: "Идентификатор документа (платежа)." format: "uuid" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "result" - "resultError" type: "object" properties: result: maxItems: 100 minItems: 0 type: "array" items: required: - "documentId" - "status" type: "object" properties: documentId: type: "string" description: "Идентификатор документа (платежа)." format: "uuid" status: type: "string" description: "Статус платежа:\n * `DRAFT` — черновик пла\ тежа, доступно изменение реквизитов;\n* `DELETED` — уд\ алён;\n* `UNSIGNED` — находится в процессе подписания\ ;\n* `SIGNED` — полностью подписан и готов к отправке\ ;\n* `SUBMITTED` — отправлен на исполнение;\n* `EXECUTED`\ \ — исполнен процессинговой системой;\n* `CANCELLED` —\ \ отменён клиентом;\n* `DECLINED` — отклонено процесси\ нговой системой." enum: - "DRAFT" - "DELETED" - "UNSIGNED" - "SIGNED" - "SUBMITTED" - "EXECUTED" - "CANCELLED" - "DECLINED" comment: pattern: ".*" type: "string" description: "Комментарий от Payment Gate." resultError: maxItems: 100 minItems: 0 type: "array" items: required: - "documentId" - "errorCode" - "errorMessage" type: "object" properties: documentId: type: "string" description: "Идентификатор документа (платежа)." format: "uuid" errorCode: maxLength: 400 type: "string" description: "Код ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Пример успешного ответа: value: result: - documentId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" status: "EXECUTED" comment: "Платёж исполнен" resultError: - documentId: "a970f653-9ac4-4896-84e3-afe02d78bd05" errorCode: "PAYMENT_NOT_FOUND" errorMessage: "Документ не найден" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/product/rating: get: tags: - "Рейтинги продуктов" summary: "Получение рейтингов, отсортированных по дате изменения" description: "Метод отдаёт рейтинги, отсортированные по дате изменения — от\ \ более старых к новым." operationId: "getRatingsPage" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "cursor" in: "query" description: "Курсор страницы." required: false style: "form" explode: true schema: type: "string" format: "string" example: "iYWNrPXRydWU=" - name: "size" in: "query" description: "Размер страницы — от 1 до 500." required: false style: "form" explode: true schema: maximum: 500 minimum: 1 type: "integer" example: 10 responses: "200": description: "Страница с рейтингами продукта" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "content" type: "object" properties: content: maxItems: 500 type: "array" description: "Список элементов страницы." items: required: - "apiKey" - "feedbackRating" - "productId" type: "object" properties: apiKey: maxLength: 300 type: "string" description: "Указатель на магазин." productId: maxLength: 300 type: "string" description: "Идентификатор продукта." feedbackRating: required: - "rating" - "totalFeedbackWithFiles" - "totalFiles" - "totalRatings" - "totalText" type: "object" properties: rating: type: "number" description: "Агрегированный рейтинг, среднее арифме\ тическое." totalRatings: type: "integer" description: "Общее количество оценок." format: "int64" totalText: type: "integer" description: "Общее количество текстовых отзывов." format: "int64" totalFiles: type: "integer" description: "Общее количество изображений из отзыво\ в." format: "int64" totalFeedbackWithFiles: type: "integer" description: "Общее количество отзывов с изображения\ ми." format: "int64" description: "Агрегированный рейтинг, основанный на осно\ вной информации из отзыва." description: "Агрегированный рейтинг на товар." cursor: required: - "nextPage" type: "object" properties: nextPage: type: "string" description: "Токен (строка в Base64) для получения следую\ щей страницы. Для получения первой страницы отправляется\ \ пустая строка." format: "string" description: "Данные курсора для пагинации." description: "Страница с данными курсорной пагинации." example: content: - apiKey: "вкусно и точка" productId: "гамбургер" feedbackRating: rating: 5 totalRatings: 3 totalText: 2 totalFiles: 1 totalFeedbackWithFiles: 1 cursor: nextPage: "iYWNrPXRydWU=" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/requests: get: tags: - "Платёжные требования" summary: "Получить список платёжных требований" description: "Метод возвращает список платёжных требований." operationId: "getApiV1PaymentRequests-PaymentRequests" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "endDate" in: "query" description: "Дата окончания периода (включительно), за который нужно выве\ сти платёжные требования. Формат — `YYYY-MM-DD`." required: false style: "form" explode: true schema: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" - name: "limit" in: "query" description: "Максимальное количество платёжных требований, которое нужно\ \ вывести. Значение по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" format: "int32" default: 50 - name: "offset" in: "query" description: "Количество платёжных требований, которые нужно пропустить. З\ начение по умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" format: "int32" default: 0 - name: "startDate" in: "query" description: "Дата начала периода (включительно), за который нужно вывести\ \ платёжные требования. Формат — `YYYY-MM-DD`." required: false style: "form" explode: true schema: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: offset: type: "integer" description: "Количество платёжных требований, которое было пр\ опущено." format: "int32" limit: type: "integer" description: "Максимальное количество платёжных требований, ко\ торое могло быть выведено." format: "int32" size: type: "integer" description: "Количество платёжных требований в ответе." format: "int32" total: type: "integer" description: "Общее количество платёжных требований." format: "int32" results: maxItems: 50 type: "array" description: "Результат." nullable: true items: required: - "creationDate" - "direction" - "docType" - "id" - "status" type: "object" properties: id: type: "string" description: "ID платёжного требования." format: "uuid" creationDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: "Дата создания платёжного требования в форм\ ате `YYYY-MM-DD`." docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" direction: type: "string" description: " Направление платёжного требования.\n\n`Debit`\ \ — списание.\n\n`Credit` — пополнение." enum: - "Debit" - "Credit" status: type: "string" description: " Статус платёжного требования.\n\n`Pending`\ \ — обрабатывается банком.\n\n`Sent` — отправлено в др\ угой банк, ожидает обработки.\n\n`Declined` — отклонен\ о плательщиком. Только для требований, требующих акцеп\ та плательщиком.\n\n`Card` — требование поступило плат\ ельщику, ожидает списания.\n\n`Outdated` — истёк срок\ \ получения акцепта. Только для требований, требующих\ \ акцепта плательщиком.\n\n`Accepted` — подтверждено п\ лательщиком. Подтверждается автоматически, если есть а\ ктивное соглашение о заранее данном акцепте.\n\n`Completed`\ \ — успешно исполнено.\n\n`Partial` — оплачено частичн\ о. При поступлении денежных средств или снятия огранич\ ений со счёта плательщика оставшаяся часть спишется ав\ томатически.\n\n`RevokeRequested` — получатель отправи\ л запрос на отзыв платёжного требования.\n\n`Revoked`\ \ — отозвано получателем.\n\n`Archived` — статус после\ \ отмены или оплаты требования.\n\n`Error` — ошибка об\ работки." enum: - "Pending" - "Sent" - "Revoked" - "Archived" - "Error" - "Declined" - "Card" - "Accepted" - "Outdated" - "Partial" - "RevokeRequested" - "Completed" example: offset: 0 limit: 50 size: 1 total: 1 results: - id: "3fa85f64-5717-4562-b3fc-2c963f66afa6" creationDate: "2022-11-10" docType: "PaymentRequest" direction: "Credit" status: "Sent" "400": description: "Некорректно заполнено поле" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "VALIDATION_ERROR" errorMessage: "offset: value must be greater than 0" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" post: tags: - "Платёжные требования" summary: "Создать платёжное требование" description: " Позволяет завести платёжное требование.\n\nТребование спишетс\ я безакцептно, если соглашение о безакцептном списании на момент генерации\ \ требования активно и вы указываете:\n* `WithoutAcceptance` в условии пла\ тежа — параметр `paymentCondition`;\n* номер соглашения о безакцептном спи\ сании в назначении платежа — параметр `purpose`;\n* ID соглашения о безакц\ ептном списании — параметр `agreementId`.\n\nВ ином случае банк попросит а\ кцепт плательщика для списания платежа." operationId: "postApiV1PaymentRequests-CreatePaymentRequest" parameters: - name: "Idempotency-Key" in: "header" description: "Ключ идемпотентности. [Подробнее](https://cloud.yandex.ru/docs/api-design-guide/concepts/idempotency)." required: true style: "simple" explode: false schema: maxLength: 64 minLength: 1 type: "string" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: description: "Реквизиты платёжного требования." content: application/json: schema: required: - "amount" - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest` — п\ латёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа:\n\n`WithAcceptance` — с акцептом\ ;\n\n`WithoutAcceptance` — без акцепта." nullable: true enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата отсылки (вручения) плательщику предусмотренн\ ых договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика. Если КПП нет, передавайте `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." documentNumber: maximum: 999999 minimum: 1 type: "number" description: "Номер платёжного требования." format: "decimal" nullable: true purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." agreementId: type: "string" description: "ID соглашения о безакцептных списаниях." format: "uuid" nullable: true example: amount: 1000.55 docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" documentNumber: 123456 purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithAcceptance" acceptTerm: 6 agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" docDispatchDate: "2022-11-10" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "id" type: "object" properties: id: type: "string" description: "ID созданного платёжного требования." format: "uuid" readOnly: true example: id: "3fa85f64-5717-4562-b3fc-2c963f66afa6" "400": description: "Не найдена форма для соглашения о безакцептных списаниях" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/requests/{requestId}: get: tags: - "Платёжные требования" summary: "Получить детали платёжного требования" description: "Метод для получения деталей платёжного требования — ID, дата с\ оздания, тип платёжного документа и другие.\n\nТакже вы можете получать ин\ формацию об изменении статуса платёжного требования, когда его статус меня\ ется — для этого используйте вебхук Обновление статуса платёжного тр\ ебования." operationId: "getApiV1PaymentRequests-PaymentDetails" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "requestId" in: "path" description: "ID платёжного требования." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "amount" - "creationDate" - "direction" - "docType" - "id" - "payerAccount" - "payerINN" - "payerName" - "purpose" - "recipientAccount" - "status" type: "object" properties: id: type: "string" description: "ID платёжного требования." format: "uuid" creationDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата создания платёжного требования в формате `YYYY-MM-DD`." docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest` —\ \ платёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа:\n\n`WithAcceptance` — с акцепт\ ом;\n\n`WithoutAcceptance` — без акцепта." nullable: true enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата отсылки (вручения) плательщику предусмотре\ нных договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." nullable: true payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП плательщика" nullable: true payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." nullable: true payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." nullable: true recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." documentNumber: maximum: 999999 minimum: 1 type: "number" description: "Номер платёжного требования." format: "decimal" nullable: true agreementId: type: "string" description: "ID соглашения о безакцептных списаниях." format: "uuid" nullable: true direction: type: "string" description: " Направление платёжного требования.\n\n`Debit` —\ \ списание.\n\n`Credit` — пополнение." enum: - "Debit" - "Credit" status: type: "string" description: " Статус платёжного требования.\n\n`Pending` — об\ рабатывается банком.\n\n`Sent` — отправлено в другой банк, о\ жидает обработки.\n\n`Declined` — отклонено плательщиком. То\ лько для требований, требующих акцепта плательщиком.\n\n`Card`\ \ — требование поступило плательщику, ожидает списания.\n\n\ `Outdated` — истёк срок получения акцепта. Только для требов\ аний, требующих акцепта плательщиком.\n\n`Accepted` — подтве\ рждено плательщиком. Подтверждается автоматически, если есть\ \ активное соглашение о заранее данном акцепте.\n\n`Completed`\ \ — успешно исполнено.\n\n`Partial` — оплачено частично. При\ \ поступлении денежных средств или снятия ограничений со счё\ та плательщика оставшаяся часть спишется автоматически.\n\n\ `RevokeRequested` — получатель отправил запрос на отзыв плат\ ёжного требования.\n\n`Revoked` — отозвано получателем.\n\n\ `Archived` — статус после отмены или оплаты требования.\n\n\ `Error` — ошибка обработки." enum: - "Pending" - "Sent" - "Revoked" - "Archived" - "Error" - "Declined" - "Card" - "Accepted" - "Outdated" - "Partial" - "RevokeRequested" - "Completed" ruleId: type: "string" description: "ID платёжного правила." format: "uuid" nullable: true example: id: "3fa85f64-5717-4562-b3fc-2c963f66afa6" creationDate: "2022-11-10" docType: "PaymentRequest" amount: 599.99 paymentCondition: "WithoutAcceptance" acceptTerm: 6 docDispatchDate: "2022-11-10" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" documentNumber: 123456 purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" direction: "Credit" status: "Sent" ruleId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" "400": description: "Не найдена форма для соглашения о безакцептных списаниях" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/requests/{requestId}/file: get: tags: - "Платёжные требования" summary: "Получить платёжное требование в PDF" description: " Метод для получения PDF-файла с деталями платёжного требовани\ я. Файл закодирован в `base64`." operationId: "getApiV1PaymentRequests-PaymentPdf" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "requestId" in: "path" description: "ID платёжного требования." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "content" properties: content: type: "string" description: "Base64-encoded файл в формате PDF, содержащий де\ тали платёжного требования." format: "byte" example: content: "UERGIGZpbGUgc2hvdWxkIGJlIGhlcmU=" "400": description: "Платёжное требование не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/requests/{requestId}/revoke: post: tags: - "Платёжные требования" summary: "Отозвать платёжное требование" description: "Метод для отзыва платёжного требования.\n\nНельзя отозвать пла\ тёжное требование в статусе `Archived`." operationId: "postApiV1PaymentRequests-RevokeRequest" parameters: - name: "Idempotency-Key" in: "header" description: "Ключ идемпотентности. [Подробнее](https://cloud.yandex.ru/docs/api-design-guide/concepts/idempotency)." required: true style: "simple" explode: false schema: maxLength: 64 minLength: 1 type: "string" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "requestId" in: "path" description: "ID платёжного требования." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Платёжное требование не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка обработки сущности" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Попытка отозвать входящее платежное требование: value: errorId: "bcadsa12" errorCode: "REVOKE_FORBIDDEN" errorMessage: "Unable to revoke payment request" Требование не может быть отозвано: value: errorId: "bcadsa12" errorCode: "INVALID_STATE" errorMessage: "Invalid state" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/rules: get: tags: - "Правила" summary: "Получить список платёжных правил для указанного соглашения" description: " Метод для получения списка платёжных правил, созданных для ук\ азанного соглашения.\n\nВ поле scope у токена должен быть дос\ туп opensme/inn/[{inn}]/kpp/[{kpp}]/nonacceptance-debits/manage\ \ — Управление соглашениями о безакцептных списаниях.\n\nЗаме\ чание: возвращает только правила с типом `Recurrent`. Для получения информ\ ации о триггерных правилах вызывайте метод [`/api/v2/rules`](https://developer.tinkoff.ru/docs/api/get-api-v-2-nonacceptance-rule-list). " operationId: "getApiV1Nonacceptance-RuleList" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "agreementId" in: "query" description: "ID соглашения, в рамках которого заключены правила." required: true style: "form" explode: true schema: type: "string" format: "uuid" - name: "limit" in: "query" description: "Максимальное количество правил, которое нужно вывести. Значе\ ние по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" format: "int32" default: 50 - name: "offset" in: "query" description: "Количество правил, которые нужно пропустить. Значение по умо\ лчанию — 0." required: false style: "form" explode: true schema: type: "integer" format: "int32" default: 0 responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: offset: type: "integer" description: "Количество правил, которое было пропущено." format: "int32" limit: type: "integer" description: "Максимальное количество правил, которое могло бы\ ть выведено." format: "int32" size: type: "integer" description: "Количество правил в ответе." format: "int32" total: type: "integer" description: "Общее количество правил." format: "int32" results: maxItems: 50 type: "array" description: "Результат." nullable: true items: required: - "amount" - "cronExpr" - "id" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррент\ ное правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" readOnly: true amount: type: "number" description: "Сумма платежа." format: "decimal" cronExpr: maxLength: 200 minLength: 9 type: "string" description: "CRON-выражение регулярности платежа." format: "string" example: offset: 0 limit: 50 size: 1 total: 1 results: - id: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Recurrent" amount: 1000.55 cronExpr: "0 12 * * *" "400": description: "Соглашение не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" post: tags: - "Правила" summary: "Создать платёжное правило" description: " Метод для создания платёжного правила.\n\nЗадать правило можн\ о двумя способами:\n* Регулярное списание по расписанию. Правило может вып\ олняться не чаще одного раза в 24 часа — например, каждый день в 12:00 мск\ .\n* Списание по событию. Когда происходит событие, соответствующее заданн\ ым параметрам, система автоматически генерирует платёжное требование, кото\ рое позволит списать средства вам на счёт. Например, если вам нужно списыв\ ать роялти с ваших франчайзи, мы можем автоматически списывать определённы\ й процент от всех пополнений по торговому эквайрингу и зачислять вам на сч\ ёт.\n\nВ рамках одного правила доступна одна из обязательных категорий поп\ олнения — внесение наличных на счёт контрагента, торговый эквайринг, интер\ нет-эквайринг, входящие переводы от контрагентов и вариант списания — фикс\ ированная сумма или процент от платежа. Возможные комбинации параметров:\n\ 1. Категория пополнения: входящие переводы от контрагентов.\nВозможные ком\ бинации: данные компаний-инициаторов платежей и/или счетов, на которые при\ ходят пополнения.\n2. Категория пополнения: любая, кроме входящих переводо\ в от контрагентов.\nВозможные комбинации: счета, на которые приходят попол\ нения.\n\nЕсли денег на счёте плательщика не хватает, платёж встаёт в карт\ отеку. Остаток списывается при следующих поступлениях." operationId: "postApiV1Nonacceptance-CreateRule" parameters: - name: "Idempotency-Key" in: "header" description: "Ключ идемпотентности. [Подробнее](https://cloud.yandex.ru/docs/api-design-guide/concepts/idempotency)." required: true style: "simple" explode: false schema: type: "string" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: description: "Параметры платёжного правила." content: application/json: schema: oneOf: - title: "Рекуррентное правило" required: - "agreementId" - "cronExpr" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное пр\ авило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" agreementId: type: "string" description: "ID соглашения." format: "uuid" cronExpr: maxLength: 200 minLength: 9 type: "string" description: "CRON-выражение регулярности платежа. Например, \"\ 0 12 * * *\" — каждый день в 12:00 мск." format: "string" requisites: required: - "amount" - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — без\ \ акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных д\ оговором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передайте\ \ `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" - title: "Триггерное правило" required: - "agreementId" - "amount" - "replenishmentFilter" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное пр\ авило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" agreementId: type: "string" description: "ID соглашения." format: "uuid" amount: type: "object" properties: fixed: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде фиксированного значения\ ." format: "decimal" nullable: true percent: multipleOf: 0.00010 maximum: 1 minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде процента от суммы попол\ нения. Значение 0.0001 соответствует 0.01%, а 1.0000 - 100%." format: "decimal" nullable: true description: "Сумма платежа.\n\nВозможно представление в одном\ \ из двух видов: фиксированный или процентный. Заполнять нео\ бходимо только одно из полей: либо `fixed`, либо `percent`." replenishmentFilter: required: - "category" type: "object" properties: payers: maxItems: 50 type: "array" description: "Данные компаний-инициаторов пополнений.\n\nП\ ри заполнении данного поля списание будет происходить, т\ олько когда инициатором пополнения является одна из комп\ аний, указанных в поле.\n\nЗаполнение поля обязательно д\ ля правил с `category` = `CounterpartyIncome`. В иных сл\ учаях поле не заполняется." nullable: true items: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." description: "Компания-инициатор операции пополнения" category: type: "string" description: "Категория операций пополнения, по которым бу\ дут производиться списания.\n\n`CashIn` - операции внесе\ ния наличных на счёт контрагента.\n\n`MerchantAcq` - опе\ рации, проведённые по торговому эквайрингу.\n\n`InternetAcq`\ \ - операции, проведённые по интернет-эквайрингу.\n\n`CounterpartyIncome`\ \ - операции по входящим переводам от контрагентов. " enum: - "CashIn" - "MerchantAcq" - "InternetAcq" - "CounterpartyIncome" accounts: maxItems: 50 type: "array" description: "Счета для операций пополнения.\n\nПри заполн\ ении данного поля списание будет происходить, только ког\ да совершается пополнение одного из указанных в поле сче\ тов. " nullable: true items: pattern: "^(\\d{20})$" type: "string" description: "Счёт, на который должны приходить пополнен\ ия." description: "Условия, при которых должны проводиться списания\ \ по операциям пополнения.\n\nРаботает по принципу «И»: если\ \ заполнены несколько полей, то списания будут происходить,\ \ только когда для каждого этих полей будет выполнено указан\ ное условие.\n\nНапример, если в `category` указано `CounterpartyIncome`,\ \ в `payers` указана компания с ИНН = 7777777777, а в `accounts`\ \ указан счёт 40000000000000000000, то списание будет происх\ одить, только когда производится входящий перевод от компани\ и с ИНН = 7777777777 на счёт 40000000000000000." requisites: required: - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — без\ \ акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных д\ оговором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передайте\ \ `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" examples: Рекуррентное правило: value: type: "Recurrent" cronExpr: "0 12 * * *" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" requisites: amount: 1000.55 docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило (процентная сумма, внесение наличных): value: type: "Trigger" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" amount: percent: 0.0815 replenishmentFilter: accounts: - "12345678900987654321" - "98765432100123456789" category: "CashIn" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило (фиксированная сумма, переводы от контрагентов): value: type: "Trigger" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" amount: fixed: 1000.55 replenishmentFilter: payers: - inn: "7777777777" kpp: "987654321" - inn: "8888888888" kpp: "0" accounts: - "12345678900987654321" - "98765432100123456789" category: "CounterpartyIncome" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "ruleId" type: "object" properties: ruleId: type: "string" description: "ID правила." format: "uuid" example: ruleId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Соглашение не найдено: value: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" Некорректно заполнено поле: value: errorId: "bcadsa12" errorCode: "VALIDATION_ERROR" errorMessage: "acceptTerm: value must be greater than 0" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Соглашение имеет невалидный статус" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "INVALID_STATE" errorMessage: "Invalid state" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/rules/{ruleId}: get: tags: - "Правила" summary: "Получить детали платёжного правила" description: "Метод позволяет получить детальную информацию о платёжном прав\ иле по ID." operationId: "getApiV1Nonacceptance-RuleDetails" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ruleId" in: "path" description: "ID платёжного правила." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: oneOf: - title: "Рекуррентное правило" required: - "agreementId" - "cronExpr" - "id" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное\ \ правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" agreementId: type: "string" description: "ID соглашения." format: "uuid" requisites: required: - "amount" - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — бе\ з акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных\ \ договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передай\ те `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" cronExpr: maxLength: 200 minLength: 9 type: "string" description: "CRON-выражение регулярности платежа. Например\ , «0 12 * * *» — каждый день в 12:00 мск." format: "string" - title: "Триггерное правило" required: - "agreementId" - "amount" - "id" - "replenishmentFilter" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное\ \ правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" agreementId: type: "string" description: "ID соглашения." format: "uuid" amount: type: "object" properties: fixed: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде фиксированного значен\ ия." format: "decimal" nullable: true percent: multipleOf: 0.00010 maximum: 1 minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде процента от суммы поп\ олнения. Значение 0.0001 соответствует 0.01%, а 1.0000\ \ - 100%." format: "decimal" nullable: true description: "Сумма платежа.\n\nВозможно представление в одн\ ом из двух видов: фиксированный или процентный. Заполнять\ \ необходимо только одно из полей: либо `fixed`, либо `percent`." replenishmentFilter: required: - "category" type: "object" properties: payers: maxItems: 50 type: "array" description: "Данные компаний-инициаторов пополнений.\n\n\ При заполнении данного поля списание будет происходить\ , только когда инициатором пополнения является одна из\ \ компаний, указанных в поле.\n\nЗаполнение поля обяза\ тельно для правил с `category` = `CounterpartyIncome`.\ \ В иных случаях поле не заполняется." nullable: true items: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." description: "Компания-инициатор операции пополнения" category: type: "string" description: "Категория операций пополнения, по которым\ \ будут производиться списания.\n\n`CashIn` - операции\ \ внесения наличных на счёт контрагента.\n\n`MerchantAcq`\ \ - операции, проведённые по торговому эквайрингу.\n\n\ `InternetAcq` - операции, проведённые по интернет-эква\ йрингу.\n\n`CounterpartyIncome` - операции по входящим\ \ переводам от контрагентов. " enum: - "CashIn" - "MerchantAcq" - "InternetAcq" - "CounterpartyIncome" accounts: maxItems: 50 type: "array" description: "Счета для операций пополнения.\n\nПри запо\ лнении данного поля списание будет происходить, только\ \ когда совершается пополнение одного из указанных в п\ оле счетов. " nullable: true items: pattern: "^(\\d{20})$" type: "string" description: "Счёт, на который должны приходить пополн\ ения." description: "Условия, при которых должны проводиться списан\ ия по операциям пополнения.\n\nРаботает по принципу «И»: е\ сли заполнены несколько полей, то списания будут происходи\ ть, только когда для каждого этих полей будет выполнено ук\ азанное условие.\n\nНапример, если в `category` указано `CounterpartyIncome`,\ \ в `payers` указана компания с ИНН = 7777777777, а в `accounts`\ \ указан счёт 40000000000000000000, то списание будет прои\ сходить, только когда производится входящий перевод от ком\ пании с ИНН = 7777777777 на счёт 40000000000000000." requisites: required: - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — бе\ з акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных\ \ договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передай\ те `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" examples: Рекуррентное правило: value: id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Recurrent" cronExpr: "0 12 * * *" requisites: amount: 1000.55 docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило: value: id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Trigger" amount: fixed: null percent: 0.0815 replenishmentFilter: payers: - inn: "7777777777" kpp: "987654321" - inn: "8888888888" kpp: "0" category: "CounterpartyIncome" accounts: - "12345678900987654321" - "98765432100123456789" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 "400": description: "Правило не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" put: tags: - "Правила" summary: "Изменить платёжное правило" description: " Метод позволяет обновить конфигурацию платёжного правила.\n\n\ Важные детали работы с рекуррентными правилами:\n\nПосле изменения правила\ \ следующее списание выполняется не раньше, чем через 24 часа после послед\ него платежа. Например, списание настроено раз в месяц на 14 число в 10:00.\ \ Сейчас 15 декабря, последнее списание было 14 декабря. Рассмотрим нескол\ ько случаев:\n* Вы хотите изменить расписание на списание раз в месяц 16 ч\ исла. Тогда следующее списание произойдёт 16 декабря — между предыдущим сп\ исанием 14 числа и новым списанием 16 пройдёт больше 24 часов.\n* Вы хотит\ е изменить расписание на списание раз в месяц 15 числа в 15:00. Тогда след\ ующее списание произойдёт 15 декабря в 15:00 — между предыдущим списанием\ \ 14 числа в 10:00 и новым списанием 15 числа в 15:00 пройдёт больше 24 ча\ сов.\n* Вы хотите изменить расписание на списание раз в месяц 15-го числа\ \ в 9:00. Тогда следующее списание произойдёт 15 января в 9:00 — между пре\ дыдущим списанием 14 декабря в 10:00 и новым списанием 15 декабря в 9:00 п\ ройдёт меньше 24 часов, поэтому будет взята следующая по расписанию дата —\ \ 15 января." operationId: "putApiV1Nonacceptance-UpdateRule" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ruleId" in: "path" description: "ID платёжного правила." required: true style: "simple" explode: false schema: type: "string" format: "uuid" requestBody: description: "Параметры платёжного правила." content: application/json: schema: oneOf: - title: "Рекуррентное правило" required: - "cronExpr" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное пр\ авило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" requisites: required: - "amount" - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — без\ \ акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных д\ оговором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передайте\ \ `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" cronExpr: maxLength: 200 minLength: 9 type: "string" description: "CRON-выражение регулярности платежа. Например, «\ 0 12 * * *» — каждый день в 12:00 мск." format: "string" - title: "Триггерное правило" required: - "amount" - "replenishmentFilter" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное пр\ авило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" amount: type: "object" properties: fixed: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде фиксированного значения\ ." format: "decimal" nullable: true percent: multipleOf: 0.00010 maximum: 1 minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде процента от суммы попол\ нения. Значение 0.0001 соответствует 0.01%, а 1.0000 - 100%." format: "decimal" nullable: true description: "Сумма платежа.\n\nВозможно представление в одном\ \ из двух видов: фиксированный или процентный. Заполнять нео\ бходимо только одно из полей: либо `fixed`, либо `percent`." replenishmentFilter: required: - "category" type: "object" properties: payers: maxItems: 50 type: "array" description: "Данные компаний-инициаторов пополнений.\n\nП\ ри заполнении данного поля списание будет происходить, т\ олько когда инициатором пополнения является одна из комп\ аний, указанных в поле.\n\nЗаполнение поля обязательно д\ ля правил с `category` = `CounterpartyIncome`. В иных сл\ учаях поле не заполняется." nullable: true items: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." description: "Компания-инициатор операции пополнения" category: type: "string" description: "Категория операций пополнения, по которым бу\ дут производиться списания.\n\n`CashIn` - операции внесе\ ния наличных на счёт контрагента.\n\n`MerchantAcq` - опе\ рации, проведённые по торговому эквайрингу.\n\n`InternetAcq`\ \ - операции, проведённые по интернет-эквайрингу.\n\n`CounterpartyIncome`\ \ - операции по входящим переводам от контрагентов. " enum: - "CashIn" - "MerchantAcq" - "InternetAcq" - "CounterpartyIncome" accounts: maxItems: 50 type: "array" description: "Счета для операций пополнения.\n\nПри заполн\ ении данного поля списание будет происходить, только ког\ да совершается пополнение одного из указанных в поле сче\ тов. " nullable: true items: pattern: "^(\\d{20})$" type: "string" description: "Счёт, на который должны приходить пополнен\ ия." description: "Условия, при которых должны проводиться списания\ \ по операциям пополнения.\n\nРаботает по принципу «И»: если\ \ заполнены несколько полей, то списания будут происходить,\ \ только когда для каждого этих полей будет выполнено указан\ ное условие.\n\nНапример, если в `category` указано `CounterpartyIncome`,\ \ в `payers` указана компания с ИНН = 7777777777, а в `accounts`\ \ указан счёт 40000000000000000000, то списание будет происх\ одить, только когда производится входящий перевод от компани\ и с ИНН = 7777777777 на счёт 40000000000000000." requisites: required: - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — без\ \ акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных д\ оговором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передайте\ \ `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" examples: Рекуррентное правило: value: type: "Recurrent" cronExpr: "0 12 * * *" requisites: amount: 1000.55 docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило (процентная сумма, внесение наличных): value: type: "Trigger" amount: percent: 0.0815 replenishmentFilter: category: "CashIn" accounts: - "12345678900987654321" - "98765432100123456789" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило (фиксированная сумма, переводы от контрагентов): value: type: "Trigger" amount: fixed: 1000.55 replenishmentFilter: payers: - inn: "7777777777" kpp: "987654321" - inn: "8888888888" kpp: "0" category: "CounterpartyIncome" accounts: - "12345678900987654321" - "98765432100123456789" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: oneOf: - title: "Рекуррентное правило" required: - "agreementId" - "cronExpr" - "id" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное\ \ правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" agreementId: type: "string" description: "ID соглашения." format: "uuid" requisites: required: - "amount" - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — бе\ з акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных\ \ договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передай\ те `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" cronExpr: maxLength: 200 minLength: 9 type: "string" description: "CRON-выражение регулярности платежа. Например\ , «0 12 * * *» — каждый день в 12:00 мск." format: "string" - title: "Триггерное правило" required: - "agreementId" - "amount" - "id" - "replenishmentFilter" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное\ \ правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" agreementId: type: "string" description: "ID соглашения." format: "uuid" amount: type: "object" properties: fixed: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде фиксированного значен\ ия." format: "decimal" nullable: true percent: multipleOf: 0.00010 maximum: 1 minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде процента от суммы поп\ олнения. Значение 0.0001 соответствует 0.01%, а 1.0000\ \ - 100%." format: "decimal" nullable: true description: "Сумма платежа.\n\nВозможно представление в одн\ ом из двух видов: фиксированный или процентный. Заполнять\ \ необходимо только одно из полей: либо `fixed`, либо `percent`." replenishmentFilter: required: - "category" type: "object" properties: payers: maxItems: 50 type: "array" description: "Данные компаний-инициаторов пополнений.\n\n\ При заполнении данного поля списание будет происходить\ , только когда инициатором пополнения является одна из\ \ компаний, указанных в поле.\n\nЗаполнение поля обяза\ тельно для правил с `category` = `CounterpartyIncome`.\ \ В иных случаях поле не заполняется." nullable: true items: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." description: "Компания-инициатор операции пополнения" category: type: "string" description: "Категория операций пополнения, по которым\ \ будут производиться списания.\n\n`CashIn` - операции\ \ внесения наличных на счёт контрагента.\n\n`MerchantAcq`\ \ - операции, проведённые по торговому эквайрингу.\n\n\ `InternetAcq` - операции, проведённые по интернет-эква\ йрингу.\n\n`CounterpartyIncome` - операции по входящим\ \ переводам от контрагентов. " enum: - "CashIn" - "MerchantAcq" - "InternetAcq" - "CounterpartyIncome" accounts: maxItems: 50 type: "array" description: "Счета для операций пополнения.\n\nПри запо\ лнении данного поля списание будет происходить, только\ \ когда совершается пополнение одного из указанных в п\ оле счетов. " nullable: true items: pattern: "^(\\d{20})$" type: "string" description: "Счёт, на который должны приходить пополн\ ения." description: "Условия, при которых должны проводиться списан\ ия по операциям пополнения.\n\nРаботает по принципу «И»: е\ сли заполнены несколько полей, то списания будут происходи\ ть, только когда для каждого этих полей будет выполнено ук\ азанное условие.\n\nНапример, если в `category` указано `CounterpartyIncome`,\ \ в `payers` указана компания с ИНН = 7777777777, а в `accounts`\ \ указан счёт 40000000000000000000, то списание будет прои\ сходить, только когда производится входящий перевод от ком\ пании с ИНН = 7777777777 на счёт 40000000000000000." requisites: required: - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance` — бе\ з акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмотренных\ \ договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, передай\ те `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" examples: Рекуррентное правило: value: id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Recurrent" cronExpr: "0 12 * * *" requisites: amount: 1000.55 docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило (процентная сумма, внесение наличных): value: id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Trigger" amount: fixed: null percent: 0.0815 replenishmentFilter: payers: null category: "CashIn" accounts: - "12345678900987654321" - "98765432100123456789" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 Триггерное правило (фиксированная сумма, переводы от контрагентов): value: id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Trigger" amount: fixed: 1000.55 percent: null replenishmentFilter: payers: - inn: "7777777777" kpp: "987654321" - inn: "8888888888" kpp: "0" category: "CounterpartyIncome" accounts: - "12345678900987654321" - "98765432100123456789" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 "400": description: "Правило не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" delete: tags: - "Правила" summary: "Удалить правило" description: " Метод позволяет удалить платёжное правило по ID.\n\nПри расто\ ржении соглашения правила также перестают действовать." operationId: "deleteApiV1Nonacceptance-DeleteRule" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ruleId" in: "path" description: "ID платёжного правила." required: true style: "simple" explode: false schema: type: "string" format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Правило не найдено" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/self-employed/recipients/add/by-requisites: post: tags: - "Выплаты самозанятым" summary: "Добавить самозанятого по реквизитам" description: " Метод для добавления самозанятых по реквизитам.\n\nЗапрос аси\ нхронный. Его результат можно получить через вызов метода Получить результат создания черновиков анкет сотрудников, передав в н\ ём соответствующий correlationId." operationId: "addSelfEmployedRecipientsByRequisites" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "correlationId" - "recipients" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запро\ сом получения ответа." format: "uuid" recipients: maxItems: 2000 type: "array" description: "Список самозанятых на добавление." items: required: - "bankInfo" - "firstName" - "lastName" - "number" type: "object" properties: number: type: "integer" description: "Идентификатор самозанятого на стороне клиент\ а." firstName: maxLength: 100 type: "string" description: "Имя (кириллица)." lastName: maxLength: 100 type: "string" description: "Фамилия (кириллица)." middleName: maxLength: 100 type: "string" description: "Отчество (кириллица)." mobileNumber: maxLength: 50 type: "string" description: "Номер мобильного телефона." inn: maxLength: 50 type: "string" description: "ИНН." bankInfo: required: - "accountNumber" type: "object" properties: bankBic: maxLength: 50 type: "string" description: "БИК банка. По умолчанию — Тинькофф." accountNumber: maxLength: 50 type: "string" description: "Номер счёта." description: "Данные о счёте." required: true responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с зап\ росом получения ответа." format: "uuid" example: correlationId: "17de62bb-e448-45b1-a670-d71cf0d60785" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/recipients/add/by-requisites/result: get: tags: - "Выплаты самозанятым" summary: "Получить результат добавления самозанятого по реквизитам" description: "\nМетод возвращает результат запроса для метода Добавить самозанятого по реквизитам. Ответ на запрос создания хранитс\ я в течение двух дней." operationId: "addSelfEmployedRecipientsByRequisitesResult" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "correlationId" in: "query" required: true style: "form" explode: true schema: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "recipientResults" type: "object" properties: recipientResults: maxItems: 2000 type: "array" description: "Список результатов добавления самозанятых." items: required: - "firstName" - "lastName" - "number" - "status" type: "object" properties: number: type: "integer" description: "Номер самозанятого, переданный клиентом пр\ и создании." recipientId: type: "integer" description: "Идентификатор самозанятого. Может не прийт\ и, если при создании самозанятого возникли ошибки." firstName: maxLength: 100 type: "string" description: "Имя (кириллица)." lastName: maxLength: 100 type: "string" description: "Фамилия (кириллица)." middleName: maxLength: 100 type: "string" description: "Отчество (кириллица)." status: type: "string" description: "Статус создания:\n* `QUEUED` — самозанятый\ \ стоит в очереди на создание;\n* `CREATED` — самозаня\ тый создан в выплатах;\n* `ERROR` — самозанятый не был\ \ создан в выплатах. Ошибки перечислены в параметре errors. " enum: - "QUEUED" - "CREATED" - "ERROR" errors: maxItems: 100 type: "array" description: "Список ошибок." items: type: "object" properties: fieldName: maxLength: 400 type: "string" description: "Название поля, в котором есть ошибка\ ." errorDescription: maxLength: 400 type: "string" description: "Описание ошибки." example: recipientResults: - number: 123 recipientId: 123 firstName: "Иван" lastName: "Демидов" middleName: "Иванович" status: "ERROR" errors: - fieldName: "Инн" errorDescription: "Не указан инн" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/taxpayers/payment-documents-requests: post: tags: - "Самозанятые" summary: "Создать запрос на получение платёжных документов по самозанятым" description: "Метод для создания запроса на получение платёжных документов и\ з ФНС." operationId: "postApiV1Self-employedTaxpayersPaymentDocumentsRequests" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности." format: "uuid" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: description: "Детали запроса." content: application/json: schema: required: - "innList" type: "object" properties: innList: maxItems: 100 minItems: 1 type: "array" description: "Список ИНН самозанятых, для которых запрашиваются\ \ платёжные документы." items: pattern: "^(\\d{12})$" type: "string" description: "ИНН." example: innList: - "173527033406" - "266445718640" responses: "201": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "createdAt" - "paymentDocumentsRequestId" - "status" type: "object" properties: paymentDocumentsRequestId: type: "string" description: "Идентификатор запроса." format: "uuid" status: type: "string" description: "Статус запроса." enum: - "IN_PROGRESS" - "COMPLETED" createdAt: type: "string" description: "Дата и время создания запроса в UTC. Возвращаетс\ я в формате ISO-8601." format: "date-time" results: maxItems: 100 minItems: 1 type: "array" description: "Результаты запроса платёжных документов." items: required: - "inn" type: "object" properties: inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН самозанятого." fnsErrorCode: maxLength: 256 type: "string" description: "Код ошибки ФНС." documentList: maxItems: 3 type: "array" description: "Список платёжных документов." items: required: - "address" - "amount" - "code101" - "code106" - "code107" - "code110" - "createdAt" - "documentIndex" - "dueDate" - "fullName" - "inn" - "sourceId" - "type" type: "object" properties: type: type: "string" description: "Тип начисления: TAX — н\ алоговое начисление, DEBT — задолже\ нность, PENALTY — пени." enum: - "TAX" - "DEBT" - "PENALTY" documentIndex: type: "string" description: "Индекс документа (УИН)." format: "string" fullName: type: "string" description: "ФИО." format: "string" address: type: "string" description: "Адрес места жительства." format: "string" inn: type: "string" description: "ИНН налогоплательщика." format: "string" amount: type: "number" description: "Сумма к оплате." recipientBankName: type: "string" description: "Банк получателя." format: "string" recipientBankBik: type: "string" description: "БИК банка получателя." format: "string" recipientBankAccountNumber: type: "string" description: "Номер счёта банка получателя." format: "string" recipient: type: "string" description: "Получатель." format: "string" recipientAccountNumber: type: "string" description: "Номер счёта получателя." format: "string" recipientInn: type: "string" description: "ИНН получателя." format: "string" recipientKpp: type: "string" description: "КПП получателя." format: "string" kbk: type: "string" description: "КБК налогового начисления или КРСБ." format: "string" oktmo: type: "string" description: "ОКТМО налогового начисления или КРСБ\ ." format: "string" code101: type: "string" description: "Код для поля 101: статус плательщика\ . Подробнее по [ссылке](https://www.nalog.gov.ru/html/sites/www.rn77.nalog.ru/2022/2kvartal/Slaydi27042022.pdf)." format: "string" code106: type: "string" description: "Код для поля 106, основание платежа\ . [Подробнее](https://www.nalog.gov.ru/html/sites/www.rn77.nalog.ru/2022/2kvartal/Slaydi27042022.pdf)." format: "string" code107: type: "string" description: "Код для поля 107, показатель налогов\ ого периода. [Подробнее](https://www.nalog.gov.ru/html/sites/www.rn77.nalog.ru/2022/2kvartal/Slaydi27042022.pdf)." format: "string" code110: type: "string" description: "Код для поля 110, вид платежа. Запол\ няется фиксированным значением '0'." format: "string" dueDate: type: "string" description: "Оплатить до. Для ТП — 28 число месяц\ а, следующего за отчётным; для ЗД — дата формиро\ вания документа." format: "string" createdAt: type: "string" description: "Дата и время создания документа в UTC.\ \ Возвращается в формате ISO-8601." format: "date-time" sourceId: type: "string" description: "Внутренний идентификатор источника д\ окумента в ПП НПД. Для TAX — внутре\ нний идентификатор налогового начисления, для DEBT\ \ и PENALTY — внутренний идентифика\ тор КРСБ." format: "string" examples: Пример ответа IN_PROGRESS: value: paymentDocumentsRequestId: "e7bd838c-b376-449d-9074-8591bbb2647e" status: "IN_PROGRESS" createdAt: "2022-05-20T09:20:19Z" Пример ответа COMPLETED: value: paymentDocumentsRequestId: "e7bd838c-b376-449d-9074-8591bbb2647e" status: "COMPLETED" results: - inn: "173527033406" fnsErrorCode: "TAXPAYER_NOT_FOUND" - inn: "266445718640" documentList: - type: "DEBT" documentIndex: "18209997220000044478" fullName: "Дементьева Жанна Сергеевна" address: "603093, РОССИЯ, , , г Нижний Новгород, , ул Роди\ онова, 23А, , офис 307" inn: "266445718640" amount: 1000 recipientBankName: "Отделение Барнаул г. Барнаул" recipientBankBik: "040173001" recipientBankAccountNumber: "66076855480672434823" recipient: "УФК по Алтайскому краю" recipientAccountNumber: "03100810350041010001" recipientInn: "7733535730" recipientKpp: "773301001" kbk: "18210506000011000110" oktmo: "78237857" code101: "13" code106: "ЗД" code107: "27.07.2022" code110: "0" dueDate: "2022-07-27" createdAt: "2022-05-27T12:48:00.651Z" sourceId: "12292" createdAt: "2022-07-20T09:20:19Z" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "cde4zxc5" errorMessage: "One or more validation errors occurred." errorCode: "VALIDATION_ERROR" errorDetails: innList[0]: inn: "'inn' must be valid INN, i.e. contain 12 characters\ \ each of which is a digit and at least one of which is\ \ not '0'" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/self-employed/taxpayers/payment-documents-requests/{paymentDocumentsRequestId}: get: tags: - "Самозанятые" summary: "Получить запрос на получение платёжных документов по самозанятым" description: "Метод для получения запроса на получение платёжных документов\ \ по самозанятым из ФНС." operationId: "getApiV1Self-employedTaxpayersPaymentDocumentsRequestsPaymentDocumentsRequestId" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "paymentDocumentsRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "createdAt" - "paymentDocumentsRequestId" - "status" type: "object" properties: paymentDocumentsRequestId: type: "string" description: "Идентификатор запроса." format: "uuid" status: type: "string" description: "Статус запроса." enum: - "IN_PROGRESS" - "COMPLETED" createdAt: type: "string" description: "Дата и время создания запроса в UTC. Возвращаетс\ я в формате ISO-8601." format: "date-time" results: maxItems: 100 minItems: 1 type: "array" description: "Результаты запроса платёжных документов." items: required: - "inn" type: "object" properties: inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН самозанятого." fnsErrorCode: maxLength: 256 type: "string" description: "Код ошибки ФНС." documentList: maxItems: 3 type: "array" description: "Список платёжных документов." items: required: - "address" - "amount" - "code101" - "code106" - "code107" - "code110" - "createdAt" - "documentIndex" - "dueDate" - "fullName" - "inn" - "sourceId" - "type" type: "object" properties: type: type: "string" description: "Тип начисления: TAX — н\ алоговое начисление, DEBT — задолже\ нность, PENALTY — пени." enum: - "TAX" - "DEBT" - "PENALTY" documentIndex: type: "string" description: "Индекс документа (УИН)." format: "string" fullName: type: "string" description: "ФИО." format: "string" address: type: "string" description: "Адрес места жительства." format: "string" inn: type: "string" description: "ИНН налогоплательщика." format: "string" amount: type: "number" description: "Сумма к оплате." recipientBankName: type: "string" description: "Банк получателя." format: "string" recipientBankBik: type: "string" description: "БИК банка получателя." format: "string" recipientBankAccountNumber: type: "string" description: "Номер счёта банка получателя." format: "string" recipient: type: "string" description: "Получатель." format: "string" recipientAccountNumber: type: "string" description: "Номер счёта получателя." format: "string" recipientInn: type: "string" description: "ИНН получателя." format: "string" recipientKpp: type: "string" description: "КПП получателя." format: "string" kbk: type: "string" description: "КБК налогового начисления или КРСБ." format: "string" oktmo: type: "string" description: "ОКТМО налогового начисления или КРСБ\ ." format: "string" code101: type: "string" description: "Код для поля 101: статус плательщика\ . Подробнее по [ссылке](https://www.nalog.gov.ru/html/sites/www.rn77.nalog.ru/2022/2kvartal/Slaydi27042022.pdf)." format: "string" code106: type: "string" description: "Код для поля 106, основание платежа\ . [Подробнее](https://www.nalog.gov.ru/html/sites/www.rn77.nalog.ru/2022/2kvartal/Slaydi27042022.pdf)." format: "string" code107: type: "string" description: "Код для поля 107, показатель налогов\ ого периода. [Подробнее](https://www.nalog.gov.ru/html/sites/www.rn77.nalog.ru/2022/2kvartal/Slaydi27042022.pdf)." format: "string" code110: type: "string" description: "Код для поля 110, вид платежа. Запол\ няется фиксированным значением '0'." format: "string" dueDate: type: "string" description: "Оплатить до. Для ТП — 28 число месяц\ а, следующего за отчётным; для ЗД — дата формиро\ вания документа." format: "string" createdAt: type: "string" description: "Дата и время создания документа в UTC.\ \ Возвращается в формате ISO-8601." format: "date-time" sourceId: type: "string" description: "Внутренний идентификатор источника д\ окумента в ПП НПД. Для TAX — внутре\ нний идентификатор налогового начисления, для DEBT\ \ и PENALTY — внутренний идентифика\ тор КРСБ." format: "string" examples: Пример ответа IN_PROGRESS: value: paymentDocumentsRequestId: "e7bd838c-b376-449d-9074-8591bbb2647e" status: "IN_PROGRESS" createdAt: "2022-05-20T09:20:19Z" Пример ответа COMPLETED: value: paymentDocumentsRequestId: "e7bd838c-b376-449d-9074-8591bbb2647e" status: "COMPLETED" results: - inn: "173527033406" fnsErrorCode: "TAXPAYER_NOT_FOUND" - inn: "266445718640" documentList: - type: "DEBT" documentIndex: "18209997220000044478" fullName: "Дементьева Жанна Сергеевна" address: "603093, РОССИЯ, , , г Нижний Новгород, , ул Роди\ онова, 23А, , офис 307" inn: "266445718640" amount: 1000 recipientBankName: "Отделение Барнаул г. Барнаул" recipientBankBik: "040173001" recipientBankAccountNumber: "66076855480672434823" recipient: "УФК по Алтайскому краю" recipientAccountNumber: "03100810350041010001" recipientInn: "7733535730" recipientKpp: "773301001" kbk: "18210506000011000110" oktmo: "78237857" code101: "13" code106: "ЗД" code107: "27.07.2022" code110: "0" dueDate: "2022-07-27" createdAt: "2022-05-27T12:48:00.651Z" sourceId: "12292" createdAt: "2022-07-20T09:20:19Z" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cde4zxc5" errorMessage: "One or more validation errors occurred." errorCode: "VALIDATION_ERROR" errorDetails: paymentDocumentsRequestId: "'paymentDocumentsRequestId' must not\ \ be empty" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/statement: get: tags: - "Счета и выписки" summary: "Получить выписку по счёту" description: " Метод для получения списка операций по счёту за определённый\ \ период по указанным критериям поиска. Данные доступны с июня 2023 года.\n\ \nЧтобы оперативно отслеживать статус оплаты, вы также можете воспользоват\ ься вебхуком Операция по счёту.\n\nПоля с датой и временем в запро\ се и ответе передаются в формате ISO 8601 по UTC.\n\nОперации получаются п\ орциями. Максимальный размер порции регулируется параметром limit.\ \ Если в текущем запросе не удаётся вернуть все операции, в ответе будет з\ аполнено поле nextCursor с указателем на последнюю операцию в\ \ ответе. Чтобы получить очередную порцию операций, повторите запрос — в п\ оле cursor укажите значение, полученное из nextCursor.\n\ \nЧтобы в ответе вернулись балансы, передайте параметр withBalances\ \ со значением true. Они вернутся только для первого запроса\ \ — для следующих запросов очередной порции операций при заполнении поля `cursor`\ \ балансы не возвращаются.\n\nПодробнее про сценарий Операции по счёту" operationId: "getApiV1Statement" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "accountNumber" in: "query" description: "Номер счёта." required: true style: "form" explode: true schema: pattern: "^(\\d{20})$" type: "string" example: "40702810510000710417" - name: "categories" in: "query" description: "Категории операций. Подробнее о категориях." required: false style: "form" explode: true schema: maxItems: 50 type: "array" items: maxLength: 50 type: "string" example: "fee" example: "fee" - name: "cursor" in: "query" description: "Указатель на последнюю операцию, полученную в предыдущем зап\ росе.\n\nМаксимальное количество операций в запросе — 5000, значение по\ \ умолчанию — 1000. Если количество операций больше лимита, этот парамет\ р вернётся в последней строке ответа — его нужно передать в следующем за\ просе." required: false style: "form" explode: true schema: maxLength: 100 type: "string" - name: "from" in: "query" description: "Дата начала периода, включительно." required: true style: "form" explode: true schema: type: "string" format: "date-time" example: "2022-02-01T21:00:00Z" - name: "inns" in: "query" description: "ИНН контрагентов." required: false style: "form" explode: true schema: maxItems: 50 type: "array" items: pattern: "^(\\d{10}|\\d{12})$" type: "string" example: "17499237465" example: "17499237465" - name: "limit" in: "query" description: "Максимальное количество операций, которое нужно получить за\ \ один вызов метода." required: false style: "form" explode: true schema: maximum: 5000 minimum: 1 type: "integer" format: "int32" default: 1000 - name: "operationStatus" in: "query" description: "Статус операции для фильтрации: все операции, только авториз\ ации или только подтвержденные транзакции." required: false style: "form" explode: true schema: type: "string" enum: - "All" - "Authorization" - "Transaction" example: "Transaction" - name: "to" in: "query" description: "Дата окончания периода, не включительно." required: false style: "form" explode: true schema: type: "string" format: "date-time" example: "2022-02-02T21:00:00Z" - name: "ucid" in: "query" description: "UCID карты — её уникальный идентификатор. Его можно получить\ \ через метод Получить список карт компании." required: false style: "form" explode: true schema: type: "integer" format: "int64" example: 1234567890 - name: "withBalances" in: "query" description: "Если передан `true`, возвращаются балансы." required: false style: "form" explode: true schema: type: "boolean" responses: "200": description: "Список операций" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "operations" type: "object" properties: balances: type: "object" properties: balanceBegin: type: "number" description: "Баланс на начало периода." format: "decimal" balanceEnd: type: "number" description: "Баланс на конец периода." format: "decimal" credit: type: "number" description: "Обороты по кредиту за весь период." format: "decimal" nullable: true debit: type: "number" description: "Обороты по дебету за весь период." format: "decimal" nullable: true creditAuthorizations: type: "number" description: "Обороты по кредиту для авторизаций за весть\ \ период." format: "decimal" nullable: true debitAuthorizations: type: "number" description: "Обороты по дебету для авторизаций за весь пе\ риод." format: "decimal" nullable: true operationsCount: type: "integer" description: "Количество операций за весь период." format: "int32" balances: maxItems: 2000 type: "array" description: "Балансы и обороты по дням." items: type: "object" properties: date: type: "string" description: "Дата, на которую предоставлены балансы\ \ и обороты." format: "date" balanceBegin: type: "number" description: "Баланс на начало дня." format: "decimal" balanceEnd: type: "number" description: "Баланс на конец дня." format: "decimal" credit: type: "number" description: "Обороты по кредиту." format: "decimal" nullable: true debit: type: "number" description: "Обороты по дебету." format: "decimal" nullable: true creditAuthorizations: type: "number" description: "Обороты по кредиту для авторизаций." format: "decimal" nullable: true debitAuthorizations: type: "number" description: "Обороты по дебету для авторизаций." format: "decimal" nullable: true operationsCount: type: "integer" description: "Количество операций." format: "int32" description: "Балансы и обороты." operations: maxItems: 11000 type: "array" description: "Список операций." items: required: - "operationDate" - "operationId" type: "object" properties: operationDate: type: "string" description: "Дата операции. В зависимости от статуса оп\ ерации равна дате проведения по балансу или дате автор\ изации." format: "date-time" operationId: type: "string" description: "Уникальный ID операции." format: "uuid" operationStatus: type: "string" description: "Статус операции: авторизация или подтвержд\ енная транзакция." nullable: true enum: - "Authorization" - "Transaction" accountNumber: maxLength: 500 type: "string" description: "Номер счёта." nullable: true bic: maxLength: 500 type: "string" description: "БИК." nullable: true typeOfOperation: maxLength: 500 type: "string" description: "Тип операции: `Сredit` — поступления, `Debit`\ \ — списания." nullable: true category: maxLength: 500 type: "string" description: "Категория операции. Подробнее о категориях." nullable: true trxnPostDate: type: "string" description: "Дата транзакции." format: "date-time" nullable: true authorizationDate: type: "string" description: "Дата авторизации." format: "date-time" nullable: true drawDate: type: "string" description: "Дата списано." format: "date-time" nullable: true chargeDate: type: "string" description: "Дата поступило." format: "date-time" nullable: true docDate: type: "string" description: "Дата создания документа." format: "date-time" nullable: true documentNumber: maxLength: 500 type: "string" description: "Номер платёжного документа." nullable: true payVo: maxLength: 500 type: "string" description: "Вид операции (строка). Подробнее о видах платежа." nullable: true vo: pattern: "^(\\d{2})$" type: "string" description: "Вид операции (номер). Подробнее о видах платежа." nullable: true priority: type: "integer" description: "Очерёдность платежа." format: "int32" nullable: true operationAmount: type: "number" description: "Сумма в валюте операции." format: "decimal" nullable: true operationCurrencyDigitalCode: maxLength: 500 type: "string" description: "Числовой код валюты операции." nullable: true accountAmount: type: "number" description: "Сумма в валюте счёта." format: "decimal" nullable: true accountCurrencyDigitalCode: maxLength: 500 type: "string" description: "Числовой код валюты счёта." nullable: true rubleAmount: type: "number" description: "Сумма в рублях по курсу ЦБ на дату операци\ и." format: "decimal" nullable: true description: maxLength: 500 type: "string" description: "Описание операции." nullable: true payPurpose: maxLength: 500 type: "string" description: "Назначение платежа." nullable: true payer: type: "object" properties: acct: maxLength: 500 type: "string" description: "Номер счёта плательщика." nullable: true inn: maxLength: 500 type: "string" description: "ИНН плательщика." nullable: true kpp: maxLength: 500 type: "string" description: "КПП плательщика." nullable: true name: maxLength: 500 type: "string" description: "Наименование плательщика." nullable: true bicRu: maxLength: 500 type: "string" description: "БИК банка плательщика." nullable: true bicSwift: maxLength: 500 type: "string" description: "SWIFT-код банка плательщика." nullable: true bankName: maxLength: 500 type: "string" description: "Название банка плательщика." nullable: true corAcct: maxLength: 500 type: "string" description: "Корреспондентский счёт плательщика." nullable: true description: "Информация о плательщике." receiver: type: "object" properties: acct: maxLength: 500 type: "string" description: "Номер счёта получателя." nullable: true inn: maxLength: 500 type: "string" description: "ИНН получателя." nullable: true kpp: maxLength: 500 type: "string" description: "КПП получателя." nullable: true name: maxLength: 500 type: "string" description: "Наименование получателя." nullable: true bicRu: maxLength: 500 type: "string" description: "БИК получателя." nullable: true bicSwift: maxLength: 500 type: "string" description: "SWIFT-код банка получателя." nullable: true bankName: maxLength: 500 type: "string" description: "Название банка получателя." nullable: true corAcct: maxLength: 500 type: "string" description: "Корреспондентский счёт получателя." nullable: true description: "Информация о получателе." counterParty: type: "object" properties: account: maxLength: 500 type: "string" description: "Номер счёта контрагента." nullable: true inn: maxLength: 500 type: "string" description: "ИНН контрагента." nullable: true kpp: maxLength: 500 type: "string" description: "КПП контрагента." nullable: true name: maxLength: 500 type: "string" description: "Наименование контрагента." nullable: true bankName: maxLength: 500 type: "string" description: "Название банка контрагента." nullable: true bankBic: maxLength: 500 type: "string" description: "БИК банка контрагента." nullable: true bankSwiftCode: maxLength: 500 type: "string" description: "SWIFT-код банка контрагента." nullable: true corrAccount: maxLength: 500 type: "string" description: "Корреспондентский счёт контрагента." nullable: true description: "Информация о контрагенте." cardNumber: maxLength: 500 type: "string" description: "Маскированный номер карты." nullable: true ucid: type: "integer" description: "UCID карты — её уникальный идентификатор.\ \ Его можно получить через метод Получить список карт компании." format: "int64" nullable: true mcc: maxLength: 500 type: "string" description: "МСС операции." nullable: true merch: type: "object" properties: name: maxLength: 500 type: "string" description: "Название мерчанта." nullable: true address: maxLength: 500 type: "string" description: "Адрес мерчанта." nullable: true city: maxLength: 500 type: "string" description: "Место совершения (город)." nullable: true index: maxLength: 500 type: "string" description: "Почтовый индекс мерчанта." nullable: true country: maxLength: 500 type: "string" description: "Место совершения (страна)." nullable: true description: "Информация о мерчанте." rrn: maxLength: 500 type: "string" description: "RRN." nullable: true acquirerId: maxLength: 500 type: "string" description: "ID эквайера." nullable: true tax: type: "object" properties: kbk: maxLength: 500 type: "string" description: "КБК-код бюджетной классификации." nullable: true oktmo: maxLength: 500 type: "string" description: "Код ОКТМО." nullable: true payerStatus: maxLength: 500 type: "string" description: "Статус отправителя." nullable: true evidence: maxLength: 500 type: "string" description: "Основание налогового платежа." nullable: true period: maxLength: 500 type: "string" description: "Налоговый период / Код таможенного орг\ ана." nullable: true nalType: maxLength: 500 type: "string" description: "Тип налогового документа." nullable: true docNumber: maxLength: 500 type: "string" description: "Номер налогового документа." nullable: true docDate: maxLength: 500 type: "string" description: "Дата налогового документа." nullable: true uin: maxLength: 500 type: "string" description: "Код УИН." nullable: true thirdPartyInn: maxLength: 500 type: "string" description: "ИНН налогоплательщика." nullable: true thirdPartyKpp: maxLength: 500 type: "string" description: "КПП налогоплательщика." nullable: true description: "Информация по налогам." nextCursor: maxLength: 100 type: "string" description: "Указатель последней полученной операции, если ве\ рнулись не все операции из-за ограничения на количество." description: "Результат получения операций для выписки." example: balances: balanceBegin: 0 balanceEnd: 484.5 credit: 484.5 debit: 0 creditAuthorizations: 0 debitAuthorizations: 0 operationsCount: 1 balances: - date: "2022-02-02" balanceBegin: 0 balanceEnd: 484.5 credit: 484.5 debit: 0 creditAuthorizations: 0 debitAuthorizations: 0 operationsCount: 1 operations: - operationDate: "2022-02-02T20:07:04Z" operationId: "64be58f9-c7fc-0027-96ba-763ec56a2317" operationStatus: "Transaction" accountNumber: "40702810510000710417" bic: "044525974" typeOfOperation: "Сredit" category: "fee" trxnPostDate: "2021-03-29T18:37:02Z" authorizationDate: "2021-03-29T15:29:15Z" drawDate: "2022-02-02T20:07:04Z" chargeDate: "2022-02-02T20:07:04Z" docDate: "2022-02-02T20:07:04Z" documentNumber: "175926" payVo: "payment-order" vo: "17" priority: 5 operationAmount: 484.5 operationCurrencyDigitalCode: "643" accountAmount: 484.5 accountCurrencyDigitalCode: "643" rubleAmount: 176.54 description: "Перевод собственных средств на счёт. НДС не облага\ ется" payPurpose: "Оплата услуг по договору 17369058. НДС не облагаетс\ я" payer: acct: "40702810510000710417" name: "ИП Котиков Александр Михайлович" inn: "17499237465" kpp: "0" bicRu: "0044525974" bicSwift: "CHASUS33" bankName: "АО \"ТИНЬКОФФ БАНК\"" corAcct: "30102810945250000974" receiver: acct: "40702810510000710417" name: "ИП Котиков Александр Михайлович" inn: "17499237465" kpp: "0" bicRu: "044525974" bicSwift: "CHASUS33" bankName: "АО \"ТИНЬКОФФ БАНК\"" corAcct: "30102810945250000974" counterParty: account: "40702810510000710417" bankBic: "044525974" bankName: "АО \"ТИНЬКОФФ БАНК\"" bankSwiftCode: "CHASUS33" corrAccount: "30002340500001234056" inn: "366109554501" kpp: "0" name: "Межрайонная ИФНС России № 17 по Воронежской области" cardNumber: "5534*****6400" ucid: 1053539419 mcc: "0010" merch: address: "13 VOLODARSKOGO STR" city: "MOSCOW" index: "183038" country: "RUS" name: "Tinkoff.cc_trans" rrn: "8408475" acquirerId: "17495726" tax: kbk: "18210302101081013260" oktmo: "40519000" payerStatus: "09" evidence: "ТП" period: "ГД.00.2021" nalType: "0" docNumber: "0" docDate: "0" uin: "0" thirdPartyInn: "366109554501" thirdPartyKpp: "0" nextCursor: "0plHq1GMtZTd39VywSrQ5C1an0tj0Q4Lo91ZPul5i0Y=" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "5fdf22eb91012189" errorCode: "NO_EXISTING_ACCOUNT" errorMessage: "Selected account for company not found." "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v2/chargebacks: get: tags: - "Интернет-эквайринг. Диспуты" summary: "Получить информацию о диспутах компании с ограничениями по количес\ тву" description: "Метод для получения информации по всем диспутам компании за за\ прашиваемый период с ограничениями по количеству. Включает в себя как новы\ е диспуты, так и старые, по которым были изменения за период." operationId: "getChargebacksV2" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "beginDate" in: "query" description: "Дата начала." required: false style: "form" explode: true schema: type: "string" format: "date" - name: "endDate" in: "query" description: "Дата окончания." required: false style: "form" explode: true schema: type: "string" format: "date" - name: "limit" in: "query" description: "Ограничение количества запрошенных диспутов. Максимальное зн\ ачение — 100." required: false style: "form" explode: true schema: type: "integer" format: "int64" - name: "offset" in: "query" description: "Смещение количества запрошенных диспутов." required: false style: "form" explode: true schema: type: "integer" format: "int64" responses: "200": description: "OK" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "data" - "pageable" type: "object" properties: message: maxLength: 300 type: "string" description: "Результат обработки запроса." data: maxItems: 100 type: "array" items: required: - "attachments" - "cbkAmt" - "channel" - "chargebackStage" - "reasonCode" - "status" type: "object" properties: channel: type: "string" description: "Канал:\n- `ON-US` — карты Тинькофф;\n- `OFF-US`\ \ — карты сторонних банков." enum: - "ON-US" - "OFF-US" origTrxnDate: pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$" type: "string" description: "Дата и время оригинальной транзакции в фор\ мате `yyyy-mm-dd'T'HH:mm:ss`." cardNumber: maxLength: 100 pattern: "\\*{2,}" type: "string" description: "Маскированный номер карты клиента." merchantName: maxLength: 100 type: "string" description: "Название мерчанта." submerchantId: type: "integer" description: "Идентификатор точки." format: "int64" trxnAmt: type: "number" description: "Сумма транзакции в рублях." cbkAmt: type: "number" description: "Сумма оспаривания." cbkCur: maxLength: 100 type: "string" description: "Валюта оспаривания." paymentId: maxLength: 100 type: "string" description: "Идентификатор платежа (orderId)." terminalId: maxLength: 100 type: "string" description: "Идентификатор терминала." arn: maxLength: 100 type: "string" description: "Acquirer Reference Number." rrn: maxLength: 100 type: "string" description: "Retrieval Reference Number." reasonCode: maxLength: 100 type: "string" description: "Код причины оспаривания." status: maxLength: 100 type: "string" description: "Статус диспута:\n- `Вернули держателю` — д\ испут проиграли и сумма вернулась физическому лицу.\n\ - `Нужен ответ` — Тинькофф требует от вас ответа на ди\ спут: согласны с претензией или нет, а также документы\ , подтверждающие позицию компании в случае несогласия\ \ с диспутом.\n- `В работе` — ответ от компании получе\ н, диспут в обработке на стороне Тинькофф или стороне\ \ эмитента.\n- `Выиграли` — диспут закрыт в пользу ком\ пании.\n- `Решение по Арбитражу` — диспут закрыт по ит\ огам рассмотрения в Арбитражном комитете платёжной сис\ темы. Решение ПС может быть передано по запросу." chargebackStage: maxLength: 100 type: "string" description: "Стадия диспута." retentionDate: type: "string" description: "Дата удержания средств с ТСП." format: "date" moneyTransferDate: type: "string" description: "Дата зачисления средств в ТСП." format: "date" text: maxLength: 5000 type: "string" description: "Текст сообщения." deadline: type: "string" description: "Дата, до которой ожидаем получить ответ." format: "date" attachments: maxItems: 100 type: "array" description: "Файлы, прикрепленные к диспуту." items: maxLength: 100 type: "string" description: "Ссылка на файл в data.tinkoff." firstCbkDate: pattern: "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$" type: "string" description: "Дата и время открытия спора в формате `yyyy-mm-dd'T'HH:mm:ss`." description: "Информация о диспуте." pageable: required: - "limit" - "offset" - "total" type: "object" properties: message: maxLength: 300 type: "string" description: "Информация о пагинации." offset: type: "integer" description: "Порядковый номер первого чарджбэка в списке." format: "int32" limit: type: "integer" description: "Порядковый номер последнего чарджбэка в спис\ ке." format: "int32" total: type: "integer" description: "Общее количество чарджбэков в запросе." format: "int32" description: "Описание параметров пагинации." description: "Общий формат ответа" example: message: "OK" data: - channel: "ON-US" origTrxnDate: "2023-01-31T17:25:14" cardNumber: "553691******6876" merchantName: "WIldberries" submerchantId: 123456 trxnAmt: 5000.5 cbkAmt: 4000 cbkCur: "RUB" paymentId: "klkjhgfdsdtyuio1kjh2g" terminalId: "1234567" arn: "12345678909876543212451" rrn: "987654321234" reasonCode: "4837" status: "Нужен ответ" chargebackStage: "Чарджбэк" retentionDate: "2023-02-10" moneyTransferDate: "2023-02-10" text: "Добрый день! По указанной ниже операции поступила претенз\ ия от держателя карты. Он утверждает, что данную операцию не с\ овершал." deadline: "2023-02-14" attachments: - "d7cf8082-8f8c-47a8-v80a-51aac30ba315/example.png" - "80b5a5c0-5a48-4bb8-9f71-0ed9bf8d1955/example.pdf" pageable: limit: 100 offset: 0 total: 1234 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "cf92ecba-7ac9-4799-856d-eb450ce1875b" errorMessage: "Мерчант не подключен к интернет-эквайрингу" errorCode: "INVALID_DATA" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v2/checkout/order: post: tags: - "Тинькофф Корзина. Работа с заказом" summary: "Создать заказ для клиента-физического лица" description: " Метод для создания заказа в системе Тинькофф Корзина." operationId: "postApiV2Orders" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: content: application/json: schema: required: - "orderId" - "orderItems" - "shopId" - "taxation" type: "object" properties: shopId: type: "string" description: "Идентификатор магазина в системе Тинькофф Корзина." format: "uuid" amount: type: "number" description: "Сумма заказа в копейках с учётом доставки. Устарев\ шее — используйте `itemsAmount`. Обязательное поле, если не ук\ азано значение `itemsAmount`." deprecated: true itemsAmount: type: "number" description: "Сумма заказа в копейках без учёта доставки. Обязат\ ельное поле, если не указано значение `amount`." orderId: maxLength: 36 type: "string" description: "Идентификатор заказа в системе магазина." taxation: type: "string" description: "Система налогообложения:\n* `osn` — общая.\n* `usn_income`\ \ — упрощённая (доходы).\n* `usn_income_outcome` — упрощённая\ \ (доходы минус расходы).\n* `patent` — патентная.\n* `envd` —\ \ единый налог на вменённый доход. \n* `esn` — единый сельскох\ озяйственный налог.\n* `self` — НПД. В этом случае информация\ \ о чеке не отправляется в Интернет-эквайринг." enum: - "osn" - "usn_income" - "usn_income_outcome" - "patent" - "envd" - "esn" - "self" description: maxLength: 250 type: "string" description: "Описание заказа." customerKey: maxLength: 128 type: "string" description: "Идентификатор покупателя в системе магазина." successPageUrl: maxLength: 1000 type: "string" description: "URL для редиректа на страницу успеха мерчанта." format: "url" isForceRedirect: type: "boolean" description: "Флаг для принудительного редиректа на страницу усп\ еха мерчанта после выполнения оплаты." shoppingCartPageUrl: maxLength: 1000 type: "string" description: "URL для редиректа на страницу корзины мерчанта." format: "url" deliveryPayment: maxItems: 1000 type: "array" description: "Переопределение матрицы способов доставки и оплаты\ \ для заказа" items: required: - "deliveryKind" type: "object" properties: deliveryKind: type: "string" description: "Способ доставки, доступный для заказа:\n* `disabled`\ \ — доставка не поддерживается; \n* `by_merchant` — дост\ авка средствами продавца; \n* `courier` — доставка курье\ рской службой; \n* `post_office` — доставка посредством\ \ почтового отправления; \n* `delivery_point` — заказ мо\ жно забрать из пункта выдачи заказов; \n* `merchant_delivery_point`\ \ — заказ можно забрать из пункта выдачи заказов продавц\ а. " enum: - "disabled" - "by_merchant" - "courier" - "post_office" - "delivery_point" - "merchant_delivery_point" paymentTypes: maxItems: 4 type: "array" description: "Способы оплаты, доступные при использовании\ \ указанного способа доставки" items: type: "string" description: "Способы оплаты, доступные при использовани\ и указанного способа доставки\n* `card` - Платеж с исп\ ользованием кредитной или дебетовой карты. \n* `sbp` -\ \ Оплата прямым денежным переводом по технологии «СБП»\ . \n* `on_delivery` - Оплата заказа при получении дост\ авки. \n* `dolyame` - Оплата заказа с использованием с\ ервиса «Долями»." enum: - "card" - "sbp" - "on_delivery" - "dolyame" description: "Элемент матрицы, переопределяющей доступные спос\ обы доставки и оплаты для заказа" orderItems: maxItems: 4000 type: "array" items: required: - "amount" - "name" - "price" - "quantity" - "tax" type: "object" properties: name: type: "string" description: "Имя товарной позиции." quantity: type: "number" description: "Количество товарной позиции." amount: type: "number" description: "Суммарная стоимость товарной позиции. Рассчи\ тывается как price * quantity." price: type: "number" description: "Стоимость одной товарной позиции в копейках." description: maxLength: 250 type: "string" description: "Описание товарной позиции." tax: type: "string" description: "Cтавка НДС:\n* `none` — без НДС;\n* `vat0` —\ \ 0%;\n* `vat10` — 10%; \n* `vat20` — 20%; \n* `vat110`\ \ — 10/110;\n* `vat118` — 18/118 (deprecated);\n* `vat120`\ \ — 20/120." enum: - "none" - "vat0" - "vat10" - "vat20" - "vat110" - "vat118" - "vat120" excise: type: "number" description: "Cумма акциза." paymentMethod: type: "string" description: "Признак способа расчёта:\n* `full_payment` —\ \ полный расчёт;\n* `full_prepayment` — предоплата 100%;\n\ * `prepayment` — предоплата; \n* `advance` — аванс;\n* `partial_payment`\ \ — частичный расчёт и кредит; \n* `credit` — передача в\ \ кредит; \n * `credit_payment` — оплата кредита." enum: - "full_payment" - "full_prepayment" - "prepayment" - "advance" - "partial_payment" - "credit" - "credit_payment" paymentObject: type: "string" description: "Признак предмета расчёта:\n* `commodity` — т\ овар\n* `excise` — подакцизный товар;\n* `job` — работа\ ; \n* `service` — услуга;\n* `gambling_bet` — ставка аза\ ртной игры; \n* `gambling_prize` — выигрыш азартной игры\ ; \n * `lottery` — лотерейный билет; \n* `gambling_prize`\ \ — выигрыш азартной игры; \n* `lottery_prize` — выигрыш\ \ лотереи; \n* `intellectual_activity` — предоставление\ \ результатов интеллектуальной деятельности; \n* `payment`\ \ — платёж; \n* `agent_commission` — агентское вознаграж\ дение; \n* `contribution` — составной предмет расчёта; \n\ * `property_rights` — имущественное право; \n* `unrealization`\ \ — внереализационный доход; \n* `tax_reduction` — иные\ \ платежи и взносы; \n* `trade_fee` — торговый сбор; \n\ * `resort_tax` — курортный сбор; \n* `pledge` — залог; \n\ * `income_decrease` — расход; \n* `ie_pension_insurance_without_payments`\ \ — взносы на ОПС ИП; \n* `ie_pension_insurance_with_payments`\ \ — взносы на ОПС; \n* `ie_medical_insurance_without_payments`\ \ — взносы на ОМС ИП; \n* `ie_medical_insurance_with_payments`\ \ — взносы на ОМС; \n* `social_insurance` — взносы на ОС\ С; \n* `casino_chips` — платёж казино; \n* `agent_payment`\ \ — выдача ДС; \n* `excisable_goods_without_marking_code`\ \ — АТНМ; \n* `excisable_goods_with_marking_code` — АТМ\ ; \n* `goods_without_marking_code` — ТНМ; \n* `goods_with_marking_code`\ \ — ТМ; \n* `another` — иной предмет расчёта." enum: - "commodity" - "excise" - "job" - "service" - "gambling_bet" - "gambling_prize" - "lottery" - "lottery_prize" - "intellectual_activity" - "payment" - "agent_commission" - "contribution" - "property_rights" - "unrealization" - "tax_reduction" - "trade_fee" - "resort_tax" - "pledge" - "income_decrease" - "ie_pension_insurance_without_payments" - "ie_pension_insurance_with_payments" - "ie_medical_insurance_without_payments" - "ie_medical_insurance_with_payments" - "social_insurance" - "casino_chips" - "agent_payment" - "excisable_goods_without_marking_code" - "excisable_goods_with_marking_code" - "goods_without_marking_code" - "goods_with_marking_code" - "another" countryCode: maxLength: 3 type: "string" description: "Код страны." declarationNumber: type: "string" description: "Номер декларации. Состоит из цифр." measurementUnit: type: "string" description: "Единица измерения товарной позиции." markCode: type: "object" properties: markCodeType: type: "string" description: "Тип кода маркировки:\n\n * `ean8` — код\ \ товара в формате EAN-8; \n* `ean13` — код товара в\ \ формате EAN-13; \n* `itf14` — код товара в формате\ \ ITF-14; \n* `gs10` — код товара в формате GS1, нан\ есённый на товар, не подлежащий маркировке; \n* `gs1m`\ \ — код товара в формате GS1, нанесённый на товар, п\ одлежащий маркировке; \n* `short` — код товара в фор\ мате короткого кода маркировки, нанесенный на товар\ ; \n* `fur` — контрольно-идентификационный знак мехо\ вого изделия; \n* `egais20` — код товара в формате Е\ ГАИС-2.0; \n* `egais30` — код товара в формате ЕГАИС\ -3.0. \n* `rawcode` — код маркировки, как он был про\ читан сканером. " enum: - "ean8" - "ean13" - "itf14" - "gs10" - "gs1m" - "short" - "fur" - "egais20" - "egais30" - "rawcode" value: type: "string" description: "Значение." description: "Код маркировки в машиночитаемой форме, предс\ тавленный в виде одного из видов кодов, формируемых в со\ ответствии с требованиями, предусмотренными правилами, д\ ля нанесения на потребительскую упаковку, или на товары\ , или на товарный ярлык." markQuantity: type: "object" properties: numerator: type: "number" description: "Числитель дробной части предмета расчёта\ . Значение должно быть строго меньше значения реквиз\ ита Знаменатель." denominator: type: "number" description: "Знаменатель дробной части предмета расчё\ та. Значение равно количеству товара в партии (упако\ вке), имеющей общий код маркировки товара." description: "Реквизит «дробное количество маркированного\ \ товара»." article: maxLength: 250 type: "string" description: "Артикул товарной позиции. Обязателен при раб\ оте со службами доставки." weight: maximum: 1000 exclusiveMaximum: true minimum: 0 exclusiveMinimum: true type: "number" description: "Вес одной единицы товара. Общий вес позиции\ \ равен Count * Weight в кг. Обязателен при работе со сл\ ужбами доставки." format: "double" declaredValue: type: "integer" description: "Объявленная ценность в копейках. Обязателен\ \ при работе со службами доставки." format: "int32" externalProductId: maxLength: 256 type: "string" description: "Идентификатор товара в системе мерчанта." description: "Модель создания товарной позиции." deliveryCondition: required: - "tax" type: "object" properties: price: type: "number" description: "Цена позиции в копейках." tax: type: "string" description: "Cтавка НДС:\n* `none` — без НДС;\n* `vat0` — 0%;\n\ * `vat10` — 10%; \n* `vat20` — 20%; \n* `vat110` — 10/110;\n\ * `vat118` — 18/118 (deprecated);\n* `vat120` — 20/120." enum: - "none" - "vat0" - "vat10" - "vat20" - "vat110" - "vat118" - "vat120" shippingParameters: required: - "height" - "length" - "weight" - "width" type: "object" properties: metashipShopId: type: "string" description: "ID магазина metaship." format: "uuid" metashipWarehouseId: type: "string" description: "ID склада metaship." format: "uuid" types: type: "array" description: "Тип доставки: Courier — курье\ рская доставка, PostOffice — почтовое отп\ равление, DeliveryPoint — ПВЗ.\nУстаревше\ е - используйте `deliveryPayment`.`deliveryKind`." deprecated: true items: type: "string" services: type: "array" description: "Дополнительные услуги служб доставки." items: required: - "service" type: "object" properties: service: type: "string" description: "Дополнительные услуги служб доставки\ . Возможные значения: \n* 'barcode-generation' -\ \ Генерация штрихкода на стороне Меташипа (YandexDelivery\ \ и DPD)\n* 'dress-fitting' - Имеется возможност\ ь примерки (Cdek и DPD)\n* 'crate' - Обрешётка(з\ ащитный каркас) груза (DPD)\n* 'fragile' - Хрупк\ ое (Почта России)\n* 'sms' - SMS информирование\ \ (DPD, Почта России и Cdek)" value: type: "string" weight: maximum: 1000 exclusiveMaximum: true minimum: 0 exclusiveMinimum: true type: "number" description: " Вес, кг." format: "double" height: maximum: 1000 minimum: 1 type: "integer" description: "Высота, см." format: "int32" width: maximum: 1000 minimum: 1 type: "integer" description: "Ширина, см." format: "int32" length: maximum: 1000 minimum: 1 type: "integer" description: "Длина, см." format: "int32" declaredValue: minimum: 0 type: "number" description: "Объявленная стоимость, коп." format: "double" freeDelivery: type: "object" properties: postOffice: type: "object" properties: deliveryPriceBefore: type: "number" description: "Доставка бесплатная, если цена доставк\ и меньше либо равна данному числу." checkoutPriceAfter: type: "number" description: "Доставка бесплатная, если сумма корзин\ ы больше либо равна данному числу." description: "Параметры бесплатной доставки." courier: type: "object" properties: deliveryPriceBefore: type: "number" description: "Доставка бесплатная, если цена доставк\ и меньше либо равна данному числу." checkoutPriceAfter: type: "number" description: "Доставка бесплатная, если сумма корзин\ ы больше либо равна данному числу." description: "Параметры бесплатной доставки." deliveryPoint: type: "object" properties: deliveryPriceBefore: type: "number" description: "Доставка бесплатная, если цена доставк\ и меньше либо равна данному числу." checkoutPriceAfter: type: "number" description: "Доставка бесплатная, если сумма корзин\ ы больше либо равна данному числу." description: "Параметры бесплатной доставки." description: "Параметры бесплатной доставки." description: "Позиция условия доставки." discountInfo: type: "object" properties: promoCodeId: maxLength: 256 type: "string" description: "Идентификатор промокода." discountAmount: type: "number" description: "Суммарная скидка заказа в копейках. Целое поло\ жительное число." description: "Информация о скидке." description: "Модель запроса на создание заказа." example: shopId: "d666b39e-8bfb-4273-b794-01d5aaf8226e" amount: 10000 orderId: "12345" taxation: "osn" customerKey: "unique-customer-key-123" description: "описание заказа в произвольной форме" successPageUrl: "https://shop.com/success" isForceRedirect: false orderItems: - name: "Чемодан" quantity: 1000 amount: 10000 price: 10 description: "Большой чемодан" tax: "vat20" paymentObject: "commodity" paymentMethod: "full_prepayment" article: "артикул товара" declaredValue: 100 weight: 3.213 length: 80 width: 50 height: 100 deliveryCondition: tax: "vat20" shippingParameters: types: - "Courier" - "PostOffice" services: - service: "sms" - service: "dress-fitting" - service: "shelf-life-days" value: "10" weight: 5.213 length: 80 width: 50 height: 100 freeDelivery: postOffice: deliveryPriceBefore: 50000 checkoutPriceAfter: 1000000 courier: deliveryPriceBefore: 100000 checkoutPriceAfter: 2000000 deliveryPoint: deliveryPriceBefore: null checkoutPriceAfter: 1500000 deliveryPayment: - deliveryKind: "disabled" paymentTypes: - "card" required: true responses: "201": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "checkoutOrderId" - "orderId" - "url" type: "object" properties: checkoutOrderId: type: "string" description: "Идентификатор заказа в системе Тинькофф Корзина" format: "uuid" url: type: "string" description: "Ссылка на виджет Тинькофф Корзины с содержимым з\ аказа." format: "url" orderId: maxLength: 36 type: "string" description: "Идентификатор заказа в системе магазина." example: checkoutOrderId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" url: "https://checkout.tinkoff.ru/dd6c3237-9958-47d9-9ba0-f6faeaa0e788" orderId: "order#123" "400": description: "Ошибка при создании заказа" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Не удалось создать заказ" errorCode: "NOT_CREATED" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Некорректные данные для создания заказа" errorCode: "NOT_CREATED" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/checkout/order/{shopId}/by/{orderId}: get: tags: - "Тинькофф Корзина. Работа с заказом" summary: "Получить информацию о заказе клиента-физического лица" description: " Метод для получения информации о заказе: товары, стоимость, о\ писания.\n\n{shopId} — идентификатор магазина в системе Тиньк\ офф Корзина, {orderId} — идентификатор заказа в системе магаз\ ина. " operationId: "getApiV2OrdersShopIdOrderId" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "orderId" in: "path" required: true style: "simple" explode: false schema: maxLength: 36 type: "string" description: "Идентификатор заказа." format: "string" - name: "shopId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор магазина." format: "uuid" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "order" type: "object" properties: order: required: - "amount" - "checkoutOrderId" - "deliveryPayment" - "itemsAmount" - "orderId" - "orderItems" - "shopId" - "taxation" - "timestamp" type: "object" properties: checkoutOrderId: type: "string" description: "Идентификатор заказа в системе Тинькофф Корз\ ина." format: "uuid" shopId: type: "string" description: "Идентификатор магазина в системе Тинькофф Ко\ рзина." format: "uuid" amount: type: "number" description: "Сумма заказа в копейках с учётом доставки. У\ старевшее — используйте `itemsAmount`." deprecated: true itemsAmount: type: "number" description: "Сумма заказа в копейках без учёта доставки." paidAmount: type: "number" description: "Сумма, которую уже оплатил плательщик." amountToPay: type: "number" description: "Сумма, которую плательщик еще должен оплатит\ ь." orderId: maxLength: 36 type: "string" taxation: type: "string" description: "Система налогообложения:\n* `osn` — общая.\n\ * `usn_income` — упрощённая (доходы).\n* `usn_income_outcome`\ \ — упрощённая (доходы минус расходы).\n* `patent` — пат\ ентная.\n* `envd` — единый налог на вменённый доход. \n\ * `esn` — единый сельскохозяйственный налог.\n* `self` —\ \ НПД. В этом случае информация о чеке не отправляется в\ \ Интернет-эквайринг." enum: - "osn" - "usn_income" - "usn_income_outcome" - "patent" - "envd" - "esn" - "self" description: maxLength: 250 type: "string" description: "Описание заказа." customerKey: maxLength: 128 type: "string" description: "Идентификатор покупателя в системе магазина." timestamp: type: "string" description: "Дата и время создания заказа." format: "date-time" successPageUrl: maxLength: 1000 type: "string" description: "URL для редиректа на страницу успеха мерчант\ а." format: "url" isForceRedirect: type: "boolean" description: "Флаг для принудительного редиректа на страни\ цу успеха мерчанта после выполнения оплаты." shoppingCartPageUrl: maxLength: 1000 type: "string" description: "URL для редиректа на страницу корзины мерчан\ та." format: "url" deliveryPayment: maxItems: 1000 type: "array" description: "Переопределение матрицы способов доставки и\ \ оплаты для заказа" items: required: - "deliveryKind" type: "object" properties: deliveryKind: type: "string" description: "Способ доставки, доступный для заказа\ :\n* `disabled` — доставка не поддерживается; \n*\ \ `by_merchant` — доставка средствами продавца; \n\ * `courier` — доставка курьерской службой; \n* `post_office`\ \ — доставка посредством почтового отправления; \n\ * `delivery_point` — заказ можно забрать из пункта\ \ выдачи заказов; \n* `merchant_delivery_point` —\ \ заказ можно забрать из пункта выдачи заказов про\ давца. " enum: - "disabled" - "by_merchant" - "courier" - "post_office" - "delivery_point" - "merchant_delivery_point" paymentTypes: maxItems: 4 type: "array" description: "Способы оплаты, доступные при использо\ вании указанного способа доставки" items: type: "string" description: "Способы оплаты, доступные при исполь\ зовании указанного способа доставки\n* `card` -\ \ Платеж с использованием кредитной или дебетово\ й карты. \n* `sbp` - Оплата прямым денежным пере\ водом по технологии «СБП». \n* `on_delivery` - О\ плата заказа при получении доставки. \n* `dolyame`\ \ - Оплата заказа с использованием сервиса «Доля\ ми»." enum: - "card" - "sbp" - "on_delivery" - "dolyame" description: "Элемент матрицы, переопределяющей доступны\ е способы доставки и оплаты для заказа" paymentType: type: "string" description: "Использованный при оформлении заказа способ\ \ оплаты:\n* `internet_acquiring` — оплата через интерне\ т-эквайринг; \n* `payment_on_delivery` — оплата заказа п\ ри получении доставки; \n* `dolyame` — оплата заказа c и\ спользованием сервиса «Долями»." enum: - "internet_acquiring" - "payment_on_delivery" - "dolyame" statuses: maxItems: 1000 type: "array" items: required: - "name" - "timestamp" type: "object" properties: name: maxLength: 50 type: "string" description: "Наименование статуса." timestamp: type: "string" description: "Дата и время статуса." format: "date-time" description: "Статус заказа." recipient: required: - "email" - "firstName" - "lastName" - "phone" type: "object" properties: firstName: maxLength: 35 type: "string" description: "Имя получателя." lastName: maxLength: 35 type: "string" description: "Фамилия получателя." phone: pattern: "^\\+?[0-9]{3}[0-9]{3}[0-9]{4,6}$" type: "string" description: "Телефон получателя." email: type: "string" description: "Почта получателя." format: "email" description: "Получатель заказа." user: required: - "id" type: "object" properties: id: type: "string" description: "Идентификатор покупателя в системе Тиньк\ офф Корзина." format: "uuid" firstName: maxLength: 35 type: "string" description: "Имя покупателя." lastName: maxLength: 35 type: "string" description: "Фамилия покупателя." phone: maxLength: 16 type: "string" description: "Номер телефона покупателя." email: maxLength: 254 type: "string" description: "Адрес электронной почты покупателя." description: "Информация о покупателе." delivery: required: - "address" type: "object" properties: address: maxLength: 250 type: "string" description: "Адрес доставки." flat: maxLength: 8 type: "string" description: "Квартира." flatCode: maxLength: 12 type: "string" description: "Код домофона." floor: maxLength: 8 type: "string" description: "Этаж." entrance: maxLength: 8 type: "string" description: "Подъезд." comment: maxLength: 1000 type: "string" description: "Комментарий для курьера." deliveryId: maxLength: 100 type: "string" description: "Код созданной заявки в системе доставки\ . При самовывозе из магазина принимает значение N/A." trackingNumber: maxLength: 100 type: "string" description: "Трек-номер от службы доставки." deliveryType: maxLength: 30 type: "string" description: "Выбранный тип доставки: Courier\ \ — курьерская доставка, PostOffice — п\ очтовое отправление, DeliveryPoint — ПВ\ З, постамат, Самовывоз из магазина — са\ мовывоз из магазина." deliveryService: maxLength: 30 type: "string" description: "Код выбранной службы доставки. При самов\ ывозе из магазина принимает значение Самовывоз\ \ из магазина." errorMessage: maxLength: 250 type: "string" description: "Текстовая ошибка от службы доставки." deliveryCondition: required: - "price" - "tax" type: "object" properties: price: type: "number" description: "Цена позиции в копейках." tax: type: "string" description: "Cтавка НДС:\n* `none` — без НДС;\n*\ \ `vat0` — 0%;\n* `vat10` — 10%; \n* `vat20` — 20%;\ \ \n* `vat110` — 10/110;\n* `vat118` — 18/118 (deprecated);\n\ * `vat120` — 20/120." enum: - "none" - "vat0" - "vat10" - "vat20" - "vat110" - "vat118" - "vat120" shippingParameters: required: - "height" - "length" - "weight" - "width" type: "object" properties: metashipShopId: type: "string" description: "ID магазина metaship." format: "uuid" metashipWarehouseId: type: "string" description: "ID склада metaship." format: "uuid" types: type: "array" description: "Тип доставки: Courier\ \ — курьерская доставка, PostOffice\ \ — почтовое отправление, DeliveryPoint\ \ — ПВЗ.\nУстаревшее - используйте `deliveryPayment`.`deliveryKind`." deprecated: true items: type: "string" services: type: "array" description: "Дополнительные услуги служб дост\ авки." items: required: - "service" type: "object" properties: service: type: "string" description: "Дополнительные услуги служ\ б доставки. Возможные значения: \n* 'barcode-generation'\ \ - Генерация штрихкода на стороне Мет\ ашипа (YandexDelivery и DPD)\n* 'dress-fitting'\ \ - Имеется возможность примерки (Cdek\ \ и DPD)\n* 'crate' - Обрешётка(защитн\ ый каркас) груза (DPD)\n* 'fragile' -\ \ Хрупкое (Почта России)\n* 'sms' - SMS\ \ информирование (DPD, Почта России и\ \ Cdek)" value: type: "string" weight: maximum: 1000 exclusiveMaximum: true minimum: 0 exclusiveMinimum: true type: "number" description: " Вес, кг." format: "double" height: maximum: 1000 minimum: 1 type: "integer" description: "Высота, см." format: "int32" width: maximum: 1000 minimum: 1 type: "integer" description: "Ширина, см." format: "int32" length: maximum: 1000 minimum: 1 type: "integer" description: "Длина, см." format: "int32" declaredValue: minimum: 0 type: "number" description: "Объявленная стоимость, коп." format: "double" description: "Позиция условия доставки." description: "Информация о доставке." discountInfo: type: "object" properties: promoCodeId: maxLength: 256 type: "string" description: "Идентификатор промокода." discountAmount: type: "number" description: "Суммарная скидка заказа в копейках. Цело\ е положительное число." description: "Информация о скидке." orderItems: maxItems: 4000 type: "array" items: required: - "amount" - "id" - "name" - "price" - "quantity" - "tax" type: "object" properties: id: type: "string" description: "Идентификатор товарной позиции в систе\ ме Тинькофф Корзина." format: "uuid" name: maxLength: 250 type: "string" description: "Имя товарной позиции." quantity: type: "number" description: "Количество товарной позиции." amount: type: "number" description: "Суммарная стоимость товарной позиции в\ \ копейках. Рассчитывается как price * quantity." price: type: "number" description: "Стоимость одной товарной позиции в коп\ ейках." description: maxLength: 250 type: "string" description: "Описание товарной позиции." tax: type: "string" description: "Cтавка НДС:\n* `none` — без НДС;\n* `vat0`\ \ — 0%;\n* `vat10` — 10%; \n* `vat20` — 20%; \n* `vat110`\ \ — 10/110;\n* `vat118` — 18/118 (deprecated);\n*\ \ `vat120` — 20/120." enum: - "none" - "vat0" - "vat10" - "vat20" - "vat110" - "vat118" - "vat120" excise: type: "number" description: "Cумма акциза в рублях." paymentMethod: type: "string" description: "Признак способа расчёта:\n* `full_payment`\ \ — полный расчёт;\n* `full_prepayment` — предопла\ та 100%;\n* `prepayment` — предоплата; \n* `advance`\ \ — аванс;\n* `partial_payment` — частичный расчёт\ \ и кредит; \n* `credit` — передача в кредит; \n *\ \ `credit_payment` — оплата кредита." enum: - "full_payment" - "full_prepayment" - "prepayment" - "advance" - "partial_payment" - "credit" - "credit_payment" paymentObject: type: "string" description: "Признак предмета расчёта:\n* `commodity`\ \ — товар\n* `excise` — подакцизный товар;\n* `job`\ \ — работа; \n* `service` — услуга;\n* `gambling_bet`\ \ — ставка азартной игры; \n* `gambling_prize` — в\ ыигрыш азартной игры; \n * `lottery` — лотерейный\ \ билет; \n* `gambling_prize` — выигрыш азартной и\ гры; \n* `lottery_prize` — выигрыш лотереи; \n* `intellectual_activity`\ \ — предоставление результатов интеллектуальной де\ ятельности; \n* `payment` — платёж; \n* `agent_commission`\ \ — агентское вознаграждение; \n* `contribution` —\ \ составной предмет расчёта; \n* `property_rights`\ \ — имущественное право; \n* `unrealization` — вне\ реализационный доход; \n* `tax_reduction` — иные п\ латежи и взносы; \n* `trade_fee` — торговый сбор;\ \ \n* `resort_tax` — курортный сбор; \n* `pledge`\ \ — залог; \n* `income_decrease` — расход; \n* `ie_pension_insurance_without_payments`\ \ — взносы на ОПС ИП; \n* `ie_pension_insurance_with_payments`\ \ — взносы на ОПС; \n* `ie_medical_insurance_without_payments`\ \ — взносы на ОМС ИП; \n* `ie_medical_insurance_with_payments`\ \ — взносы на ОМС; \n* `social_insurance` — взносы\ \ на ОСС; \n* `casino_chips` — платёж казино; \n*\ \ `agent_payment` — выдача ДС; \n* `excisable_goods_without_marking_code`\ \ — АТНМ; \n* `excisable_goods_with_marking_code`\ \ — АТМ; \n* `goods_without_marking_code` — ТНМ; \n\ * `goods_with_marking_code` — ТМ; \n* `another` —\ \ иной предмет расчёта." enum: - "commodity" - "excise" - "job" - "service" - "gambling_bet" - "gambling_prize" - "lottery" - "lottery_prize" - "intellectual_activity" - "payment" - "agent_commission" - "contribution" - "property_rights" - "unrealization" - "tax_reduction" - "trade_fee" - "resort_tax" - "pledge" - "income_decrease" - "ie_pension_insurance_without_payments" - "ie_pension_insurance_with_payments" - "ie_medical_insurance_without_payments" - "ie_medical_insurance_with_payments" - "social_insurance" - "casino_chips" - "agent_payment" - "excisable_goods_without_marking_code" - "excisable_goods_with_marking_code" - "goods_without_marking_code" - "goods_with_marking_code" - "another" countryCode: maxLength: 3 type: "string" description: "Цифровой код страны происхождения това\ ра в соответствии с Общероссийским классификатором\ \ стран мира (3 цифры)." declarationNumber: maxLength: 36 type: "string" description: "Номер декларации." measurementUnit: maxLength: 36 type: "string" description: "Единица измерения товарной позиции." markCode: type: "object" properties: markCodeType: type: "string" description: "Тип кода маркировки:\n\n * `ean8`\ \ — код товара в формате EAN-8; \n* `ean13` —\ \ код товара в формате EAN-13; \n* `itf14` — к\ од товара в формате ITF-14; \n* `gs10` — код т\ овара в формате GS1, нанесённый на товар, не п\ одлежащий маркировке; \n* `gs1m` — код товара\ \ в формате GS1, нанесённый на товар, подлежащ\ ий маркировке; \n* `short` — код товара в форм\ ате короткого кода маркировки, нанесенный на т\ овар; \n* `fur` — контрольно-идентификационный\ \ знак мехового изделия; \n* `egais20` — код т\ овара в формате ЕГАИС-2.0; \n* `egais30` — код\ \ товара в формате ЕГАИС-3.0. \n* `rawcode` —\ \ код маркировки, как он был прочитан сканером\ . " enum: - "ean8" - "ean13" - "itf14" - "gs10" - "gs1m" - "short" - "fur" - "egais20" - "egais30" - "rawcode" value: type: "string" description: "Значение." description: "Код маркировки в машиночитаемой форме\ , представленный в виде одного из видов кодов, фор\ мируемых в соответствии с требованиями, предусмотр\ енными правилами, для нанесения на потребительскую\ \ упаковку, или на товары, или на товарный ярлык." markQuantity: type: "object" properties: numerator: type: "number" description: "Числитель дробной части предмета р\ асчёта. Значение должно быть строго меньше зна\ чения реквизита Знаменатель." denominator: type: "number" description: "Знаменатель дробной части предмета\ \ расчёта. Значение равно количеству товара в\ \ партии (упаковке), имеющей общий код маркиро\ вки товара." description: "Реквизит «дробное количество маркирова\ нного товара»." article: maxLength: 250 type: "string" description: "Артикул товарной позиции." weight: maximum: 1000 exclusiveMaximum: true minimum: 0 exclusiveMinimum: true type: "number" description: "Вес одной единицы товара. Общий вес по\ зиции равен Count * Weight в кг." format: "double" declaredValue: type: "number" description: "Объявленная ценность в копейках." externalProductId: maxLength: 256 type: "string" description: "Идентификатор товара в системе мерчант\ а." description: "Товарная позиция." description: "Модель заказа." example: order: checkoutOrderId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" shopId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" user: id: "00021d4e-536f-11ec-ac0b-370ccfeacec2" firstName: "Иван" lastName: "Иванов" phone: "+79101234567" email: "i.ivanov@gmail.com" amount: 100 itemsAmount: 100 paidAmount: 0 amountToPay: 100 orderId: "order#123" taxation: "osn" description: "Описание заказа, сделанного через Тинькофф Корзину\ ." timestamp: "2022-11-08T11:35:04.311317+00:00" customerKey: "user#123" successPageUrl: "https://merchant.com/success" isForceRedirect: false shoppingCartPageUrl: "https://merchant.com/cart" statuses: - name: "NEW_ORDER" timestamp: "2022-11-09T10:04:04.211317+00:00" delivery: deliveryId: "ae5ef21e-39be-4756-8ecf-15cd5c11cc52" trackingNumber: "1112-63" deliveryType: "PostOffice" deliveryService: "RussianPost" errorMessage: "Сообщение" address: "г Москва, ул Менжинского, д 5" flat: "166" entrance: "3" floor: "5" flatCode: "166*B" deliveryCondition: price: 2000 tax: "none" shippingParameters: metashipShopId: "89a3058c-a5bf-4f47-9608-2963c7153e80" metashipWarehouseId: "ae6a9db6-3e5c-41b0-bdf9-848860f2ace5" types: - "PostOffice" - "Courier" services: - service: "sms" - service: "dress-fitting" - service: "shelf-life-days" value: "10" weight: 63 height: 7 width: 26 length: 22 declaredValue: 3300 discountInfo: promoCodeId: "promoCode#123" discountAmount: 100000 orderItems: - id: "58097aa1-9660-47e7-8550-f2167fa80cea" name: "Ноутбук" quantity: 1 amount: 1000 price: 1000 description: "Описание товарной позиции." tax: "none" excise: 332 paymentMethod: "full_payment" paymentObject: "commodity" countryCode: "643" declarationNumber: "123123" measurementUnit: "kg" markCode: markCodeType: "ean8" value: "value" markQuantity: numerator: 1 denominator: 1 article: "Артикул товарной позиции." weight: 0.005 declaredValue: 1000 recipient: firstName: "Иван" lastName: "Петров" email: "rec@mail.ru" phone: "+79123456789" deliveryPayment: - deliveryKind: "disabled" paymentTypes: - "card" paymentType: "internet_acquiring" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "retw6789" errorMessage: "Указанный заказ не найден" errorCode: "NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}: get: tags: - "Декларации 3-НДФЛ" summary: "Получить данные о заявке" description: "Метод возвращает актуальные данные о заявке. Если заявка не бу\ дет найдена, вернётся ошибка." operationId: "getRequest" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "clientFullName" - "clientId" - "createdAt" - "hasUnreadMessages" - "requestType" - "status" type: "object" properties: clientId: type: "string" description: "Идентификатор клиента." format: "uuid" clientFullName: maxLength: 200 type: "string" description: "ФИО клиента." requestType: type: "string" description: "Тип заявки: консультация или декларация." enum: - "Comment" - "Declaration" status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" hasUnreadMessages: type: "boolean" description: "Флаг наличия непрочитанных сообщений в чате." casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" createdAt: type: "string" description: "Дата создания в формате `ISO-8601`." format: "dateTime" example: clientId: "1453dd48-53ea-4aab-a200-597b57daf809" clientFullName: "Иванов Иван Иванович" requestType: "Declaration" status: "New" hasUnreadMessages: false casVersion: 1 createdAt: "2023-02-21T07:14:04.622Z" "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/attachments/upload: post: tags: - "Декларации 3-НДФЛ" summary: "Загрузить произвольный файл" description: "Метод для загрузки произвольного файла, который можно прикрепи\ ть как вложение к заявке, идентифицируемой `taxRequestId`. После успешной\ \ загрузки вернётся идентификатор файла — `attachmentId`." operationId: "postApiV2Ndfl-3RequestsTaxrequestidAttachmentsUpload" parameters: - name: "X-Content-File-Name" in: "header" description: "Имя файла." required: true style: "simple" explode: false schema: type: "string" description: "Имя файла." example: "sample.png" - name: "X-Content-File-Type" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Тип файла." example: "image/png" - name: "X-Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" requestBody: content: application/octet-stream: schema: type: "string" format: "binary" example: "binary data" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "attachmentId" type: "object" properties: attachmentId: type: "string" description: "Идентификатор вложения." format: "uuid" example: attachmentId: "54593069-1789-4a7d-b729-37406bd1fc0e" "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/attachments/{attachmentId}: get: tags: - "Декларации 3-НДФЛ" summary: "Скачать вложение (файл) из чата" description: "Метод возвращает файл из чата по заявке (`taxRequestId`) по ег\ о идентификатору — `attachmentId`.\n\nЕсли файл не будет найден или будет\ \ недоступен для скачивания (после закрытия запроса), вернётся ошибка." operationId: "getApiV2Ndfl-3RequestsTaxrequestidAttachmentsAttachmentid" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "attachmentId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор вложения." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" responses: "200": description: "" headers: Content-Disposition: required: true style: "simple" explode: false schema: type: "string" description: "Файл для скачивания." example: "attachment; filename=\"filename.jpg\"" X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/octet-stream: schema: type: "string" format: "binary" example: "binary data" "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/chat: get: tags: - "Декларации 3-НДФЛ" summary: "Получить список сообщений по декларации 3-НДФЛ" description: "Метод возвращает список сообщений чата с клиентом по деклараци\ и по идентификатору заявки — `taxRequestId`. Если заявка не будет найдена\ , вернётся ошибка." operationId: "getChat" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" - name: "limit" in: "query" required: true style: "form" explode: true schema: type: "integer" description: "Желаемое количество элементов." - name: "offset" in: "query" required: true style: "form" explode: true schema: type: "integer" description: "Позиция начала списка." responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "meta" - "values" type: "object" properties: meta: required: - "count" - "offset" - "total" type: "object" properties: offset: type: "integer" description: "Позиция начала списка." count: type: "integer" description: "Количество элементов в ответе." total: type: "integer" description: "Общее количество элементов." description: "Информация для пагинации." values: maxItems: 1000 type: "array" description: "Сообщения в чате." items: required: - "authorType" - "createdAt" - "id" type: "object" properties: id: type: "string" description: "Уникальный идентификатор сообщения." format: "uuid" authorType: type: "string" description: "Тип автора сообщения." enum: - "Manager" - "Client" text: maxLength: 1000 type: "string" description: "Текст сообщения." attachments: maxItems: 1000 type: "array" description: "Документы, приложенные к сообщению." items: required: - "createdAt" - "id" - "mime" - "name" - "size" type: "object" properties: id: maxLength: 100 type: "string" description: "Уникальный идентификатор вложения." name: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Тип содержимого файла." size: type: "integer" description: "Размер файла в байтах." createdAt: type: "string" description: "Дата загрузки документа в формате `ISO-8601`." format: "dateTime" createdAt: type: "string" description: "Дата создания сообщения в формате `ISO-8601`." format: "dateTime" example: meta: offset: 0 count: 10 total: 100 values: - id: "17cf5b26-a9b4-4531-bd19-186dbfc64a0a" authorType: "Manager" text: "Прикладываю справку" attachments: - id: "cb4bc60f-101d-4ba2-a4fb-94dcf1208d31" name: "image.png" mime: "image/png" size: 43870 createdAt: "2023-11-22T14:12:37.933204Z" createdAt: "2023-11-22T14:12:37.933204Z" "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/chat/send: post: tags: - "Декларации 3-НДФЛ" summary: "Отправить сообщение в чат с клиентом" description: "Метод отправляет сообщение с возможными вложениями в чат с кли\ ентом. Если заявка не будет найдена, вернётся ошибка." operationId: "sendChat" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" requestBody: content: application/json: schema: required: - "message" type: "object" properties: message: type: "object" properties: text: maxLength: 1000 type: "string" description: "Текст сообщения." attachments: maxItems: 1000 type: "array" description: "Вложения. Значение не передаётся, либо передаё\ тся список идентификаторов вложений." items: type: "string" description: "Идентификатор вложения." format: "uuid" description: "Сообщение." example: message: text: "Прикладываю справку" attachments: - "cb4bc60f-101d-4ba2-a4fb-94dcf1208d30" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" example: {} "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration: get: tags: - "Декларации 3-НДФЛ" summary: "Получить декларацию клиента" description: "Метод получает декларацию клиента по её идентификатору — `RequestId`.\ \ Если заявка или вложения к заявке не будут найдены, вернётся ошибка." operationId: "getDeclaration" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "createdAt" - "incomeSources" - "ndfl3" - "primaryForm" - "taxReturnReasons" type: "object" properties: primaryForm: maxItems: 1000 type: "object" additionalProperties: required: - "content" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "Идентификатор группы для формы." content: required: - "chosenOptions" type: "object" properties: chosenOptions: type: "object" additionalProperties: {} description: "Опции внутри группы." description: "Перечень идентификаторов групп для первичной фор\ мы согласно структуре анкеты. Для каждого идентификатора выв\ одится группа для формы (FormGroup)." ndfl3: type: "object" additionalProperties: required: - "chosenOptions" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы опций из структуры анкеты." chosenOptions: type: "object" additionalProperties: required: - "documents" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции из структуры анкеты." documents: type: "object" additionalProperties: maxItems: 1000 type: "array" items: required: - "id" - "mime" - "name" - "size" type: "object" properties: id: maxLength: 100 type: "string" description: "Уникальный идентификатор вло\ жения." name: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Тип содержимого файла." size: type: "integer" description: "Размер файла в байтах." description: "Перечень идентификаторов документов\ \ согласно структуре анкеты для выбранной опции\ . Для каждого идентификатора выводится список вл\ ожений (Attachment)." description: "Перечень идентификаторов групп для первичной дек\ ларации согласно структуре анкеты. Для каждого идентификатор\ а выводится группа (Group)." incomeSources: type: "object" additionalProperties: required: - "chosenOptions" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы опций из структуры анкеты." chosenOptions: type: "object" additionalProperties: required: - "documents" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции из структуры анкеты." documents: type: "object" additionalProperties: maxItems: 1000 type: "array" items: required: - "id" - "mime" - "name" - "size" type: "object" properties: id: maxLength: 100 type: "string" description: "Уникальный идентификатор вло\ жения." name: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Тип содержимого файла." size: type: "integer" description: "Размер файла в байтах." description: "Перечень идентификаторов документов\ \ согласно структуре анкеты для выбранной опции\ . Для каждого идентификатора выводится список вл\ ожений (Attachment)." description: "Перечень идентификаторов групп доходов согласно\ \ структуре анкеты. Для каждого идентификатора выводится гру\ ппа (Group)." taxReturnReasons: type: "object" additionalProperties: required: - "chosenOptions" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы опций из структуры анкеты." chosenOptions: type: "object" additionalProperties: required: - "documents" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции из структуры анкеты." documents: type: "object" additionalProperties: maxItems: 1000 type: "array" items: required: - "id" - "mime" - "name" - "size" type: "object" properties: id: maxLength: 100 type: "string" description: "Уникальный идентификатор вло\ жения." name: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Тип содержимого файла." size: type: "integer" description: "Размер файла в байтах." description: "Перечень идентификаторов документов\ \ согласно структуре анкеты для выбранной опции\ . Для каждого идентификатора выводится список вл\ ожений (Attachment)." description: "Перечень выбранных клиентом идентификаторов груп\ п вычетов согласно структуре анкеты. Для каждого идентификат\ ора выводится группа (Group)." finalDocuments: required: - "exportedFile" type: "object" properties: exportedFile: required: - "id" - "mime" - "name" - "size" type: "object" properties: id: maxLength: 100 type: "string" description: "Уникальный идентификатор вложения." name: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Тип содержимого файла." size: type: "integer" description: "Размер файла в байтах." description: "Финальные документы декларации." casVersion: type: "integer" description: "Версия заявки в формате `ETag`." createdAt: type: "string" description: "Дата создания декларации в формате `ISO-8601`." format: "dateTime" example: primaryForm: is-resident: id: "is-resident" content: chosenOptions: "true": true declaration-type: id: "declaration-type" content: chosenOptions: primary: true declaration-year: id: "declaration-year" content: chosenOptions: declaration-year-2023: true incomeSources: foreign-investment-incomes: id: "foreign-investment-incomes" chosenOptions: foreign-broker-account: id: "foreign-broker-account" documents: broker-report-v2: - id: "e4f145a8-4f1e-4595-8c8d-7f1363064cc3" name: "image.png" mime: "image/png" size: 43870 taxReturnReasons: {} ndfl3: target-year-primary-ndfl3: id: "target-year-primary-ndfl3" chosenOptions: uploaded-target-year-ndfl3: id: "uploaded-target-year-ndfl3" documents: uploaded-target-year-ndfl3: - id: "854d449f-ae43-4586-9758-00fdd823768f" name: "image.png" mime: "image/png" size: 43870 finalDocuments: exportedFile: id: "e426ca85-28f4-46da-8b31-f7fa1c77c607" name: "image.png" mime: "image/png" size: 43870 casVersion: 12 createdAt: "2023-11-15T13:16:20.787349Z" "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Некоторые вложения не найдены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Некоторые вложения не найдены" errorCode: "ATTACHMENT_NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" put: tags: - "Декларации 3-НДФЛ" summary: "Отредактировать заявку на декларацию клиента" description: "Метод редактирует или обновляет декларацию клиента по её идент\ ификатору — `RequestId`. Элементы заявки, которые не изменяются, всё равно\ \ должны быть в запросе — частично обновить заявку нельзя.\n\nЕсли заявка\ \ или вложения к заявке не будут найдены, вернётся ошибка." operationId: "updateDeclaration" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" requestBody: content: application/json: schema: required: - "incomeSources" - "ndfl3" - "primaryForm" - "taxReturnReasons" type: "object" properties: primaryForm: maxItems: 1000 type: "object" additionalProperties: required: - "content" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "Идентификатор группы для формы." content: required: - "chosenOptions" type: "object" properties: chosenOptions: type: "object" additionalProperties: {} description: "Опции внутри группы." description: "Перечень идентификаторов групп для первичной формы\ \ согласно структуре анкеты. Для каждого идентификатора выводи\ тся группа для формы (FormGroup)." ndfl3: type: "object" additionalProperties: required: - "chosenOptions" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы опций из структуры анкеты" chosenOptions: type: "object" additionalProperties: required: - "documents" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции из структуры анкеты" documents: type: "object" additionalProperties: maxItems: 1000 type: "array" items: type: "string" description: "Идентификатор вложения." format: "uuid" description: "Перечень идентификаторов документов со\ гласно структуре анкеты для выбранной опции. Для к\ аждого идентификатора выводится список вложений (Attachment)" description: "Перечень идентификаторов групп для первичной декла\ рации согласно структуре анкеты. Для каждого идентификатора вы\ водится группа (Group)." incomeSources: type: "object" additionalProperties: required: - "chosenOptions" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы опций из структуры анкеты" chosenOptions: type: "object" additionalProperties: required: - "documents" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции из структуры анкеты" documents: type: "object" additionalProperties: maxItems: 1000 type: "array" items: type: "string" description: "Идентификатор вложения." format: "uuid" description: "Перечень идентификаторов документов со\ гласно структуре анкеты для выбранной опции. Для к\ аждого идентификатора выводится список вложений (Attachment)" description: "Перечень идентификаторов групп доходов согласно ст\ руктуре анкеты. Для каждого идентификатора выводится группа (Group)." taxReturnReasons: type: "object" additionalProperties: required: - "chosenOptions" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы опций из структуры анкеты" chosenOptions: type: "object" additionalProperties: required: - "documents" - "id" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции из структуры анкеты" documents: type: "object" additionalProperties: maxItems: 1000 type: "array" items: type: "string" description: "Идентификатор вложения." format: "uuid" description: "Перечень идентификаторов документов со\ гласно структуре анкеты для выбранной опции. Для к\ аждого идентификатора выводится список вложений (Attachment)" description: "Перечень выбранных клиентом идентификаторов групп\ \ вычетов согласно структуре анкеты. Для каждого идентификатор\ а выводится группа (Group)." finalDocuments: required: - "exportedFile" type: "object" properties: exportedFile: maxLength: 100 type: "string" description: "Уникальный идентификатор вложения." description: "Финальные документы декларации." example: primaryForm: is-resident: id: "is-resident" content: chosenOptions: "true": true declaration-type: id: "declaration-type," content: chosenOptions: primary: true declaration-year: id: "declaration-year" content: chosenOptions: declaration-year-2023: true incomeSources: foreign-investment-incomes: id: "foreign-investment-incomes" chosenOptions: foreign-broker-account: id: "foreign-broker-account" documents: broker-report-v2: - "e4f145a8-4f1e-4595-8c8d-7f1363064cc3" taxReturnReasons: {} ndfl3: {} finalDocuments: exportedFile: "e426ca85-28f4-46da-8b31-f7fa1c77c607" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" type: "object" properties: casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: casVersion: 12 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Некоторые вложения не найдены" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Некоторые вложения не найдены" errorCode: "ATTACHMENT_NOT_FOUND" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/structure: get: tags: - "Декларации 3-НДФЛ" summary: "Получить структуру анкеты" description: "Метод для получения структуры анкеты. Если заявка не будет най\ дена, вернётся ошибка." operationId: "getDeclarationStructure" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "incomeSources" - "ndfl3" - "primaryForm" - "taxReturnReasons" - "variables" type: "object" properties: variables: type: "object" additionalProperties: type: "string" description: "Перечисление переменных для динамических заголов\ ков." primaryForm: maxItems: 1000 type: "array" description: "Список экранов для первичного опроса." items: required: - "content" - "id" - "title" - "type" type: "object" properties: id: maxLength: 100 type: "string" description: "ID экранной формы." title: maxLength: 200 type: "string" description: "Заголовок формы." fallbackTitle: maxLength: 200 type: "string" description: "Заголовок формы, если не получится сформир\ овать динамический заголовок." type: type: "string" description: "Тип выбора элементов на форме." enum: - "SingleChoice" - "MultipleChoice" content: required: - "options" type: "object" properties: options: maxItems: 1000 type: "array" description: "Список опций для выбора." items: required: - "id" - "title" - "type" - "value" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции." title: maxLength: 200 type: "string" description: "Наименование опции." type: type: "string" description: "Тип значения опции." enum: - "String" - "Int" - "Boolean" value: maxLength: 200 type: "string" description: "Значение опции." description: "Список экранов для первичного опроса\ ." description: "Содержимое экрана." incomeSources: required: - "groups" - "title" type: "object" properties: title: maxLength: 200 type: "string" description: "Отображаемое название раздела." fallBackTitle: maxLength: 200 type: "string" description: "Название раздела, если не получится сформиро\ вать динамическое название." groups: maxItems: 1000 type: "array" description: "Список групп в разделе." items: required: - "id" - "isDeleted" - "options" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы." title: maxLength: 200 type: "string" description: "Отображаемое название группы." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." isDeleted: type: "boolean" description: "Флаг отсутствия группы в последней вер\ сии анкеты." options: maxItems: 1000 type: "array" description: "Набор опций, входящих в группу." items: required: - "documents" - "id" - "isDeleted" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции." title: maxLength: 200 type: "string" description: "Отображаемое название опции." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." isDeleted: type: "boolean" description: "Флаг отсутствия опции в последне\ й версии анкеты." documents: maxItems: 1000 type: "array" description: "Список подтверждающих документов\ , которые нужно приложить." items: required: - "isDeleted" - "shared" - "title" - "type" type: "object" properties: type: maxLength: 100 type: "string" description: "ID документа." title: maxLength: 200 type: "string" description: "Отображаемое название доку\ мента." isDeleted: type: "boolean" description: "Флаг отсутствия документа\ \ в последней версии анкеты." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." shared: type: "boolean" description: "Флаг, находятся ли вложени\ я в локальной (documents) или глобальн\ ой (sharedDocuments) секциях." description: "Группы источников дохода." taxReturnReasons: required: - "groups" - "title" type: "object" properties: title: maxLength: 200 type: "string" description: "Отображаемое название раздела." fallBackTitle: maxLength: 200 type: "string" description: "Название раздела, если не получится сформиро\ вать динамическое название." groups: maxItems: 1000 type: "array" description: "Список групп в разделе." items: required: - "id" - "isDeleted" - "options" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы." title: maxLength: 200 type: "string" description: "Отображаемое название группы." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." isDeleted: type: "boolean" description: "Флаг отсутствия группы в последней вер\ сии анкеты." options: maxItems: 1000 type: "array" description: "Набор опций, входящих в группу." items: required: - "documents" - "id" - "isDeleted" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции." title: maxLength: 200 type: "string" description: "Отображаемое название опции." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." isDeleted: type: "boolean" description: "Флаг отсутствия опции в последне\ й версии анкеты." documents: maxItems: 1000 type: "array" description: "Список подтверждающих документов\ , которые нужно приложить." items: required: - "isDeleted" - "shared" - "title" - "type" type: "object" properties: type: maxLength: 100 type: "string" description: "ID документа." title: maxLength: 200 type: "string" description: "Отображаемое название доку\ мента." isDeleted: type: "boolean" description: "Флаг отсутствия документа\ \ в последней версии анкеты." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." shared: type: "boolean" description: "Флаг, находятся ли вложени\ я в локальной (documents) или глобальн\ ой (sharedDocuments) секциях." description: "Группы налоговых вычетов." ndfl3: required: - "groups" type: "object" properties: groups: maxItems: 1000 type: "array" description: "Список групп в разделе." items: required: - "id" - "isDeleted" - "options" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID группы." title: maxLength: 200 type: "string" description: "Отображаемое название группы." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." isDeleted: type: "boolean" description: "Флаг отсутствия группы в последней вер\ сии анкеты." options: maxItems: 1000 type: "array" description: "Набор опций, входящих в группу." items: required: - "documents" - "id" - "isDeleted" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID опции." title: maxLength: 200 type: "string" description: "Отображаемое название опции." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." isDeleted: type: "boolean" description: "Флаг отсутствия опции в последне\ й версии анкеты." documents: maxItems: 1000 type: "array" description: "Список подтверждающих документов\ , которые нужно приложить." items: required: - "isDeleted" - "shared" - "title" - "type" type: "object" properties: type: maxLength: 100 type: "string" description: "ID документа." title: maxLength: 200 type: "string" description: "Отображаемое название доку\ мента." isDeleted: type: "boolean" description: "Флаг отсутствия документа\ \ в последней версии анкеты." hint: maxLength: 1000 type: "string" description: "Подсказка к заполнению." shared: type: "boolean" description: "Флаг, находятся ли вложени\ я в локальной (documents) или глобальн\ ой (sharedDocuments) секциях." description: "Группы 3-НДФЛ для уточняющей декларации." example: variables: target_year: "declaration-year" primaryForm: - id: "declaration-year" title: "За какой год оформить декларацию?" type: "SingleChoice" content: options: - id: "declaration-year-2023" title: "2023" type: "Int" value: "2023" - id: "declaration-year-2022" title: "2022" type: "Int" value: "2022" - id: "declaration-year-2021" title: "2021" type: "Int" value: "2021" - id: "declaration-type" title: "В первый раз подаете декларацию за {{`{{target_year}}`}}\ \ год?" fallbackTitle: "В первый раз подаете декларацию за тот год?" type: "SingleChoice" content: options: - id: "primary" title: "Да, в первый раз" type: "String" value: "Primary" - id: "clarifying" title: "Нет, нужна уточненная декларация" type: "String" value: "Clarifying" incomeSources: title: "Какие доходы учесть в декларации?" groups: - id: "foreign-investment-incomes" title: "Доходы по зарубежным инвестициям" hint: "Дивиденды по иностранным бумагам у российских брокеров\ \ и доходы по счету иностранного брокера" isDeleted: false options: - id: "foreign-broker-account" title: "Доходы по счету иностранного брокера" isDeleted: false documents: - type: "broker-report-v2" title: "Брокерский отчет с момента открытия счета по {{`{{target_year}}`}}\ \ год" isDeleted: false shared: false - type: "broker-report-interactive-brokers" title: "Брокерский отчет с момента открытия счета по {{`{{target_year}}`}}\ \ год в формате Interactive Brokers" isDeleted: false shared: false taxReturnReasons: title: "Какие вычеты учесть в декларации?" groups: - id: "investment" title: "Инвестиционный налоговый вычет" hint: "Вычет по ИИС, учет убытков прошлых лет, сальдирование м\ ежду брокерами" isDeleted: false options: - id: "iis-type-a" title: "Вычет по ИИС (тип А)" isDeleted: false documents: - type: "open-iis-agreement" title: "Договор об открытии ИИС" isDeleted: false shared: false - type: "in-money-bills" title: "Платежки о внесении денег на счет за {{`{{target_year}}`}}\ \ год" isDeleted: false shared: false - type: "employer-2-ndfl" title: "2-НДФЛ от работодателя" isDeleted: false shared: false ndfl3: groups: - id: "target-year-primary-ndfl3" title: "Первичная 3-НДФЛ за {{`{{target_year}}`}} год" isDeleted: false options: - id: "uploaded-target-year-ndfl3" title: "Загрузите декларацию 3-НДФЛ за {{`{{target_year}}`}}\ \ год" isDeleted: false documents: - type: "uploaded-target-year-ndfl3" title: "Загрузите декларацию 3-НДФЛ за {{`{{target_year}}`}}\ \ год" isDeleted: false shared: false "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/acknowledge: post: tags: - "Декларации 3-НДФЛ" summary: "Отметить заявку выполненной" description: "Метод переводит заявку типа «Декларация» в статус `Acknowledge`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `Acknowledge`, метод вернёт данные\ \ в 200 ответе. Если актуальная версия заявки не совпадает с версией, пере\ данной в HTTP-заголовке, вернётся 422 ошибка.\n\nЕсли передан параметр `finalDocuments`,\ \ данное вложение прикладывается к анкете в качестве финального пакета док\ ументов." operationId: "updateStatusAcknowledge" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" - name: "finalDocuments" in: "query" required: false style: "form" explode: true schema: type: "string" description: "Уникальный идентификатор вложения." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "Acknowledge" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/cancel: post: tags: - "Декларации 3-НДФЛ" summary: "Отменить заявку" description: "Метод переводит заявку типа «Декларация» в статус `Cancelled`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `Cancelled`, метод вернёт данные в\ \ 200 ответе. Если актуальная версия заявки не совпадает с версией, переда\ нной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusCancelled" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "Cancelled" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/clarification: post: tags: - "Декларации 3-НДФЛ" summary: "Требуются уточнения по заявке" description: "Метод переводит заявку типа «Декларация» в статус `Clarification`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `Clarification`, метод вернёт данны\ е в 200 ответе. Если актуальная версия заявки не совпадает с версией, пере\ данной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusClarification" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "Clarification" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/decline: post: tags: - "Декларации 3-НДФЛ" summary: "Отклонить заявку" description: "Метод переводит заявку типа «Декларация» в статус `Declined`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `Declined`, метод вернёт данные в 200\ \ ответе. Если актуальная версия заявки не совпадает с версией, переданной\ \ в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusDeclined" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "Declined" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/payment-done: post: tags: - "Декларации 3-НДФЛ" summary: "Отметить оплату заявки" description: "Метод переводит заявку типа «Декларация» в статус `PaymentDone`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `PaymentDone`, метод вернёт данные\ \ в 200 ответе. Если актуальная версия заявки не совпадает с версией, пере\ данной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusPaymentDone" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "PaymentDone" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/pending-payment: post: tags: - "Декларации 3-НДФЛ" summary: "Отметить необходимость оплаты заявки" description: "Метод переводит заявку типа «Декларация» в статус `PendingPayment`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `PendingPayment`, метод вернёт данн\ ые в 200 ответе. Если актуальная версия заявки не совпадает с версией, пер\ еданной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusPendingPayment" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "PendingPayment" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/ready: post: tags: - "Декларации 3-НДФЛ" summary: "Завершить заявку" description: "Метод переводит заявку типа «Декларация» в статус `Ready`.\n\n\ Если заявка не будет найдена или её нельзя перевести в этот статус, вернёт\ ся ошибка. Если заявка уже в статусе `Ready`, метод вернёт данные в 200 от\ вете. Если актуальная версия заявки не совпадает с версией, переданной в HTTP-з\ аголовке, вернётся 422 ошибка." operationId: "updateStatusReady" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "Ready" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/resume-work: post: tags: - "Декларации 3-НДФЛ" summary: "Возобновить работу над заявкой" description: "Метод переводит заявку типа «Декларация» в статус `PartnerInProgress`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `PartnerInProgress`, метод вернёт д\ анные в 200 ответе. Если актуальная версия заявки не совпадает с версией,\ \ переданной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusPartnerInProgress" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "PartnerInProgress" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/start-review: post: tags: - "Декларации 3-НДФЛ" summary: "Взять заявку в анализ" description: "Метод переводит заявку типа «Декларация» в статус `Preprocess`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `Preprocess`, метод вернёт данные в\ \ 200 ответе. Если актуальная версия заявки не совпадает с версией, переда\ нной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusStartReview" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "Preprocess" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/declaration/workflow/start-work: post: tags: - "Декларации 3-НДФЛ" summary: "Взять заявку в работу" description: "Метод переводит заявку типа «Декларация» в статус `PartnerGeneratingReportData`.\n\ \nЕсли заявка не будет найдена или её нельзя перевести в этот статус, верн\ ётся ошибка. Если заявка уже в статусе `PartnerGeneratingReportData`, мето\ д вернёт данные в 200 ответе. Если актуальная версия заявки не совпадает с\ \ версией, переданной в HTTP-заголовке, вернётся 422 ошибка." operationId: "updateStatusPartnerGeneratingReportData" parameters: - name: "If-Match" in: "header" required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Версия заявки в формате `ETag`, которая используется для о\ птимистичных блокировок. Другое название — casVersion." - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "status" type: "object" properties: status: type: "string" description: "Статус заявки." enum: - "Assigned" - "InProgress" - "Answered" - "SeenByClient" - "NeedsClarification" - "Closed" - "SentToPartner" - "Draft" - "New" - "Preprocess" - "PartnerGeneratingReportData" - "PartnerInProgress" - "PendingPassport" - "PendingPayment" - "PaymentDone" - "Ready" - "PartnerReady" - "Acknowledge" - "Cancelled" - "Declined" - "Clarification" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: status: "PartnerGeneratingReportData" casVersion: 2 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Неверные данные заявки" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Переход между статусами невозможен" errorCode: "ILLEGAL_WORKFLOW_TRANSITION" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/ndfl-3/requests/{taxRequestId}/info/form: get: tags: - "Декларации 3-НДФЛ" summary: "Получить заполненную клиентом анкету, где указан желаемый состав д\ екларации 3-НДФЛ" description: "Метод возвращает заполненную анкету клиента по идентификатору\ \ заявки — `taxRequestId`. Если анкета не будет найдена, вернётся ошибка." operationId: "getFormInfo" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Уникальный идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "casVersion" - "createdAt" - "incomeSources" - "isResident" - "taxReturnReasons" - "type" - "year" type: "object" properties: year: type: "integer" description: "Год, за который подается декларация." isResident: type: "boolean" description: "Был ли клиент налоговым резидентом в выбранный г\ од." type: type: "string" description: "Тип декларации — первичная или уточняющая." enum: - "Primary" - "Clarifying" incomeSources: maxItems: 1000 type: "array" description: "Группы источников дохода." items: required: - "options" - "title" type: "object" properties: title: maxLength: 100 type: "string" description: "Название группы." options: maxItems: 1000 type: "array" description: "Детализация в рамках группы." items: required: - "documents" - "title" type: "object" properties: title: maxLength: 100 type: "string" description: "Название детализации." price: required: - "currency" - "isFullPrice" - "value" type: "object" properties: value: type: "integer" description: "Сумма." currency: maxLength: 10 type: "string" description: "Валюта. Например, `RUB`." hint: maxLength: 1000 type: "string" description: "Поясняющий текст." isFullPrice: type: "boolean" description: "Флаг полной цены." details: maxItems: 1000 type: "array" description: "Детализация цен типа «от»." items: required: - "currency" - "isFullPrice" - "value" type: "object" properties: value: type: "integer" description: "Сумма." currency: maxLength: 10 type: "string" description: "Валюта. Например, `RUB`." hint: maxLength: 1000 type: "string" description: "Поясняющий текст." isFullPrice: type: "boolean" description: "Флаг полной цены." description: "Цена." documents: maxItems: 1000 type: "array" description: "Документы, приложенные к анкете." items: required: - "fileName" - "id" - "mime" - "size" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID документа для его дальнейше\ го получения." title: maxLength: 100 type: "string" description: "Тип документа." fileName: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Формат файла." size: type: "integer" description: "Размер файла в байтах." taxReturnReasons: maxItems: 1000 type: "array" description: "Группы налоговых вычетов, на которые клиент пода\ л заявку." items: required: - "options" - "title" type: "object" properties: title: maxLength: 100 type: "string" description: "Название группы." options: maxItems: 1000 type: "array" description: "Детализация в рамках группы." items: required: - "documents" - "title" type: "object" properties: title: maxLength: 100 type: "string" description: "Название детализации." price: required: - "currency" - "isFullPrice" - "value" type: "object" properties: value: type: "integer" description: "Сумма." currency: maxLength: 10 type: "string" description: "Валюта. Например, `RUB`." hint: maxLength: 1000 type: "string" description: "Поясняющий текст." isFullPrice: type: "boolean" description: "Флаг полной цены." details: maxItems: 1000 type: "array" description: "Детализация цен типа «от»." items: required: - "currency" - "isFullPrice" - "value" type: "object" properties: value: type: "integer" description: "Сумма." currency: maxLength: 10 type: "string" description: "Валюта. Например, `RUB`." hint: maxLength: 1000 type: "string" description: "Поясняющий текст." isFullPrice: type: "boolean" description: "Флаг полной цены." description: "Цена." documents: maxItems: 1000 type: "array" description: "Документы, приложенные к анкете." items: required: - "fileName" - "id" - "mime" - "size" - "title" type: "object" properties: id: maxLength: 100 type: "string" description: "ID документа для его дальнейше\ го получения." title: maxLength: 100 type: "string" description: "Тип документа." fileName: maxLength: 100 type: "string" description: "Название файла." mime: maxLength: 100 type: "string" description: "Формат файла." size: type: "integer" description: "Размер файла в байтах." totalAmount: required: - "currency" - "isFullPrice" - "value" type: "object" properties: value: type: "integer" description: "Сумма." currency: maxLength: 10 type: "string" description: "Валюта. Например, `RUB`." isFullPrice: type: "boolean" description: "Зависит от наличия опций, содержащих плавающ\ ую цену. То есть те, у которых `isFullPrice = false`." createdAt: type: "string" description: "Дата загрузки документа в формате `ISO-8601`." format: "dateTime" casVersion: type: "integer" description: "Актуальный номер версии заявки." format: "int64" example: year: 2022 isResident: true type: "Primary" incomeSources: - title: "Доходы за рубежом" options: - title: "Сдача недвижимости в аренду" price: value: 8500 currency: "RUB" isFullPrice: false details: - value: 8500 currency: "RUB" hint: "Менее 50 операций" isFullPrice: false - value: 15700 currency: "RUB" hint: "51-200 операций" isFullPrice: false - value: 25400 currency: "RUB" hint: "201-800 операций" isFullPrice: false documents: - id: "4f73de13-4054-448e-b07f-500e09cd6d56" title: "Договор аренды" fileName: "filename.pdf" mime: "application/pdf" size: 10000 taxReturnReasons: - title: "Социальный налоговый вычет" options: - title: "Лечение" price: value: 8500 currency: "RUB" isFullPrice: false documents: - id: "4f73de13-4054-448e-b07f-500e09cd6d56" title: "Платежки, подтверждающие расходы на лечение" fileName: "filename.pdf" mime: "application/pdf" size: 10000 totalAmount: value: 1 currency: "RUB" isFullPrice: false createdAt: "2005-08-09T18:31:42+03:30" casVersion: 1 "400": description: "Заявка не найдена" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." example: errorId: "868d646e609f5339" errorMessage: "Заявка не найдена" errorCode: "REQUEST_NOT_FOUND" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/rules: get: tags: - "Правила" summary: "Получить список платёжных правил" description: "Метод для получения списка платёжных правил." operationId: "getApiV2Nonacceptance-RuleList" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "agreementId" in: "query" description: "ID соглашения, в рамках которого заключены правила." required: false style: "form" explode: true schema: type: "string" format: "uuid" nullable: true - name: "limit" in: "query" description: "Максимальное количество правил, которое нужно вывести. Значе\ ние по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" format: "int32" nullable: true default: 50 - name: "offset" in: "query" description: "Количество правил, которые нужно пропустить. Значение по умо\ лчанию — 0." required: false style: "form" explode: true schema: type: "integer" format: "int32" nullable: true default: 0 - name: "ruleTypes" in: "query" description: "Типы правил, которые должны быть включены в ответ." required: false style: "form" explode: true schema: maxItems: 50 type: "array" nullable: true items: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекуррентное правило;\n\ \n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" responses: "200": description: "Успешный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "object" properties: offset: type: "integer" description: "Количество правил, которое было пропущено." format: "int32" limit: type: "integer" description: "Максимальное количество правил, которое могло бы\ ть выведено." format: "int32" size: type: "integer" description: "Количество правил в ответе." format: "int32" total: type: "integer" description: "Общее количество правил." format: "int32" results: maxItems: 50 type: "array" description: "Результат." items: oneOf: - title: "Рекуррентное правило" required: - "agreementId" - "cronExpr" - "id" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекурре\ нтное правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" agreementId: type: "string" description: "ID соглашения." format: "uuid" requisites: required: - "amount" - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" amount: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа." format: "decimal" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance`\ \ — без акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмот\ ренных договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, п\ ередайте `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" cronExpr: maxLength: 200 minLength: 9 type: "string" description: "CRON-выражение регулярности платежа. Нап\ ример, «0 12 * * *» — каждый день в 12:00 мск." format: "string" - title: "Триггерное правило" required: - "agreementId" - "amount" - "id" - "replenishmentFilter" - "requisites" - "type" type: "object" properties: type: type: "string" description: " Тип правила:\n\n* `Recurrent` — рекурре\ нтное правило;\n\n* `Trigger` — триггерное правило." enum: - "Recurrent" - "Trigger" id: type: "string" description: "ID правила." format: "uuid" agreementId: type: "string" description: "ID соглашения." format: "uuid" amount: type: "object" properties: fixed: minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде фиксированного\ \ значения." format: "decimal" nullable: true percent: multipleOf: 0.00010 maximum: 1 minimum: 0 exclusiveMinimum: true type: "number" description: "Сумма платежа в виде процента от сум\ мы пополнения. Значение 0.0001 соответствует 0.01%,\ \ а 1.0000 - 100%." format: "decimal" nullable: true description: "Сумма платежа.\n\nВозможно представление\ \ в одном из двух видов: фиксированный или процентны\ й. Заполнять необходимо только одно из полей: либо `fixed`,\ \ либо `percent`." replenishmentFilter: required: - "category" type: "object" properties: payers: maxItems: 50 type: "array" description: "Данные компаний-инициаторов пополнен\ ий.\n\nПри заполнении данного поля списание буде\ т происходить, только когда инициатором пополнен\ ия является одна из компаний, указанных в поле.\n\ \nЗаполнение поля обязательно для правил с `category`\ \ = `CounterpartyIncome`. В иных случаях поле не\ \ заполняется." nullable: true items: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП." description: "Компания-инициатор операции пополн\ ения" category: type: "string" description: "Категория операций пополнения, по ко\ торым будут производиться списания.\n\n`CashIn`\ \ - операции внесения наличных на счёт контраген\ та.\n\n`MerchantAcq` - операции, проведённые по\ \ торговому эквайрингу.\n\n`InternetAcq` - опера\ ции, проведённые по интернет-эквайрингу.\n\n`CounterpartyIncome`\ \ - операции по входящим переводам от контрагент\ ов. " enum: - "CashIn" - "MerchantAcq" - "InternetAcq" - "CounterpartyIncome" accounts: maxItems: 50 type: "array" description: "Счета для операций пополнения.\n\nПр\ и заполнении данного поля списание будет происхо\ дить, только когда совершается пополнение одного\ \ из указанных в поле счетов. " nullable: true items: pattern: "^(\\d{20})$" type: "string" description: "Счёт, на который должны приходить\ \ пополнения." description: "Условия, при которых должны проводиться\ \ списания по операциям пополнения.\n\nРаботает по п\ ринципу «И»: если заполнены несколько полей, то спис\ ания будут происходить, только когда для каждого эти\ х полей будет выполнено указанное условие.\n\nНаприм\ ер, если в `category` указано `CounterpartyIncome`,\ \ в `payers` указана компания с ИНН = 7777777777, а\ \ в `accounts` указан счёт 40000000000000000000, то\ \ списание будет происходить, только когда производи\ тся входящий перевод от компании с ИНН = 7777777777\ \ на счёт 40000000000000000." requisites: required: - "docType" - "payerAccount" - "payerBIC" - "payerCorAccount" - "payerINN" - "payerKPP" - "payerName" - "purpose" - "recipientAccount" type: "object" properties: docType: type: "string" description: " Тип платёжного документа.\n\n`PaymentRequest`\ \ — платёжное требование." enum: - "PaymentRequest" paymentCondition: type: "string" description: " Условие платежа. `WithoutAcceptance`\ \ — без акцепта." enum: - "WithAcceptance" - "WithoutAcceptance" acceptTerm: maximum: 9 minimum: 5 type: "integer" description: "Количество дней для акцепта." format: "int32" nullable: true docDispatchDate: pattern: "^(\\d{4}-\\d{2}-\\d{2})$" type: "string" description: " Дата вручения плательщику предусмот\ ренных договором документов в формате `YYYY-MM-DD`." nullable: true payerAccount: pattern: "^(\\d{20})$" type: "string" description: "Номер счёта плательщика." payerINN: pattern: "^(\\d{10}|\\d{12})$" type: "string" description: "ИНН плательщика." payerKPP: pattern: "^(\\d{9}|0)$" type: "string" description: " КПП плательщика.\n\nЕсли КПП нет, п\ ередайте `0`." payerName: maxLength: 160 minLength: 1 type: "string" description: "Наименование плательщика." payerBIC: pattern: "^(\\d{9})$" type: "string" description: "БИК плательщика." payerCorAccount: pattern: "^(\\d{20})$" type: "string" description: "Корреспондентский счёт плательщика." recipientAccount: pattern: "^(\\d{20})$" type: "string" description: "Счёт получателя." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." format: "string" example: offset: 0 limit: 50 size: 2 total: 2 results: - id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Recurrent" cronExpr: "0 12 * * *" requisites: amount: 1000.55 docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 - id: "c31e2fc0-3a2b-4482-9025-6ec36ed857bc" agreementId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" type: "Trigger" amount: fixed: 1000.55 percent: null replenishmentFilter: payers: - inn: "7777777777" kpp: "987654321" - inn: "8888888888" kpp: "0" category: "CounterpartyIncome" accounts: - "12345678900987654321" - "98765432100123456789" requisites: docType: "PaymentRequest" payerAccount: "12345678900987654321" payerINN: "1234567890" payerKPP: "123456789" payerBIC: "044525974" payerCorAccount: "30101810145250000974" payerName: "ИП Петров Петр Иванович" recipientAccount: "09876543211234567890" purpose: "Платеж по соглашению №236383626412/2022-08-05/25.421" paymentCondition: "WithoutAcceptance" acceptTerm: 6 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Соглашение не найдено: value: errorId: "bcadsa12" errorCode: "NOT_FOUND" errorMessage: "Resource not found" Некорректно заполнено поле: value: errorId: "bcadsa12" errorCode: "VALIDATION_ERROR" errorMessage: "One or more validation errors occurred." errorDetails: ruleTypes: - "The value '' is invalid." "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v2/self-employed/taxpayers/{inn}/status: get: tags: - "Самозанятые" summary: "Получить статус самозанятого" description: "Метод возвращает информацию о статусе самозанятого, дате поста\ новки на учёт, выданных Тинькофф правах, регионе и виде деятельности." operationId: "getApiV2Self-employedTaxpayersInnStatus" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "inn" in: "path" required: true style: "simple" explode: false schema: pattern: "^(\\d{12})$" type: "string" description: "ИНН." responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "status" type: "object" properties: status: type: "string" description: "Статус самозанятого в Тинькофф." enum: - "REGISTERED" - "NOT_REGISTERED" info: required: - "oktmo" - "registeredAt" type: "object" properties: registeredAt: type: "string" description: "Дата и время последней постановки на учёт в\ \ UTC. Возвращается в формате ISO-8601." format: "date-time" activityCodes: maxItems: 256 type: "array" description: "Виды деятельности, которые самозанятый указа\ л при регистрации." items: type: "string" oktmo: maxLength: 8 type: "string" description: "Регион деятельности самозанятого." permissions: maxItems: 9 type: "array" description: "Список прав, которые самозанятый выдал Тиньк\ офф." items: type: "string" enum: - "PAYMENT_INFORMATION" - "TAXPAYER_UPDATE" - "CANCEL_ANY_INCOME" - "CANCEL_INCOME" - "INCOME_SUMMARY" - "INCOME_REGISTRATION" - "INCOME_LIST" - "PERMISSIONS_MGMT" - "TAX_PAYMENT" description: "Объект с информацией о самозанятом." application: required: - "changedAt" - "status" - "type" type: "object" properties: type: type: "string" description: "Тип заявки. Заявка создается при инициализац\ ии процесса регистрации клиента, снятии с учёта или отвя\ зки." enum: - "REGISTRATION" - "DEREGISTRATION" - "BINDING" - "UNBINDING" - "CHANGE_PERMISSIONS" status: type: "string" description: "Статус заявки." enum: - "IN_PROGRESS" - "DONE" changedAt: type: "string" description: "Дата и время последнего изменения данных по\ \ заявке в UTC. Возвращается в формате ISO-8601." format: "date-time" result: type: "string" description: "Результат по заявке со статусом DONE." enum: - "OK" - "DENIED" - "ERROR" reason: type: "string" description: "Причина, по которой рассмотрение заявки не з\ авершилось успехом. Для заявок в статусе DONE." format: "string" description: "Объект с информацией о последней заявке на измен\ ение самозанятости в Тинькофф. \n\nНачальный статус — IN_PROGRESS,\ \ переходит в DONE при завершении процесса — ка\ к успешном, так и с ошибкой. \n\nЕсли от пользователя требуе\ тся выдать права в личном кабинете ФНС, будет иметь type BINDING\ \ или CHANGE_PERMISSIONS. \n\nПосле создания но\ вой заявки предыдущая исчезает. Нельзя завести новую заявку\ , если статус текущей — IN_PROGRESS." examples: Пример ответа REGISTERED DONE: value: status: "REGISTERED" info: registeredAt: "2022-05-12T14:03:40Z" activityCodes: - "100" oktmo: "29000000" permissions: - "PAYMENT_INFORMATION" - "TAXPAYER_UPDATE" - "CANCEL_ANY_INCOME" - "CANCEL_INCOME" - "INCOME_SUMMARY" - "INCOME_REGISTRATION" - "INCOME_LIST" - "PERMISSIONS_MGMT" - "TAX_PAYMENT" application: type: "REGISTRATION" status: "DONE" changedAt: "2022-05-20T09:20:19Z" result: "OK" Пример ответа NOT_REGISTERED с заявкой: value: status: "NOT_REGISTERED" application: type: "BINDING" status: "IN_PROGRESS" changedAt: "2022-08-16T09:35:33Z" Пример ответа NOT_REGISTERED без заявки: value: status: "NOT_REGISTERED" Пример ответа NOT_REGISTERED DONE: value: status: "NOT_REGISTERED" application: status: "DONE" type: "REGISTRATION" result: "DENIED" reason: "DEBTS_FOUND" changedAt: "2022-08-16T09:35:33Z" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "cde4zxc5" errorMessage: "One or more validation errors occurred." errorCode: "VALIDATION_ERROR" errorDetails: inn: "'inn' must be valid INN, i.e. contain 10 or 12 characters\ \ each of which is a digit and at least one of which is not\ \ '0' and checksum matches" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v3/card/limits/set_batch: put: tags: - "Бизнес-карты" summary: "Установить лимиты по указанным картам" description: "Метод для установки лимитов по указанным картам — период возоб\ новления лимитов, величина лимита." operationId: "setCardsLimits" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" requestBody: description: "Запрос на установку лимитов для списка карт" content: application/json: schema: required: - "limits" type: "object" properties: limits: maxItems: 10000 type: "array" description: "Список карт для установки лимитов." items: required: - "ucid" type: "object" properties: ucid: type: "integer" description: "Уникальный идентификатор карты." spendLimit: required: - "limitPeriod" - "limitValue" type: "object" properties: limitPeriod: type: "string" description: "Период возобновления лимита." enum: - "DAY" - "MONTH" - "IRREGULAR" limitValue: type: "integer" description: "Величина лимита в валюте счёта, к которо\ му привязана карта." description: "Данные для установки лимита." cashLimit: required: - "limitPeriod" - "limitValue" type: "object" properties: limitPeriod: type: "string" description: "Период возобновления лимита." enum: - "DAY" - "MONTH" - "IRREGULAR" limitValue: type: "integer" description: "Величина лимита в валюте счёта, к которо\ му привязана карта." description: "Данные для установки лимита." description: "Запрос на установку лимитов для одной карты." description: "Запрос на установку лимитов для списка карт." example: limits: - ucid: 1029374074 spendLimit: limitValue: 23400 limitPeriod: "MONTH" cashLimit: limitValue: 25000 limitPeriod: "DAY" required: true responses: "200": description: "Результат установки лимитов для карт" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "limits" type: "object" properties: limits: maxItems: 10000 type: "array" description: "Результаты установки лимитов." items: required: - "ucid" type: "object" properties: ucid: type: "integer" description: "Уникальный идентификатор карты." spendLimit: required: - "isSuccess" type: "object" properties: isSuccess: type: "boolean" description: "Успешность установки лимита." errorMessage: type: "string" description: "Сообщение об ошибке, если лимит не уст\ ановлен." format: "string" description: "Результат установки лимита." cashLimit: required: - "isSuccess" type: "object" properties: isSuccess: type: "boolean" description: "Успешность установки лимита." errorMessage: type: "string" description: "Сообщение об ошибке, если лимит не уст\ ановлен." format: "string" description: "Результат установки лимита." description: "Результат установки лимитов для одной карты." description: "Список результатов установки лимитов для карт." example: limits: - ucid: 1029374074 spendLimit: isSuccess: true cashLimit: isSuccess: false errorMessage: "Can't change the limit" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v3/card/requisites-iframe-link: get: tags: - "Бизнес-карты" summary: "Получить ссылку для авторизации" description: "Метод для получения ссылки для авторизации." operationId: "getRequisitesLink" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "ucid" in: "query" description: "Уникальный идентификатор карты." required: true style: "form" explode: true schema: type: "integer" responses: "200": description: "Результат получения ссылки для авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "link" type: "object" properties: link: maxLength: 500 type: "string" description: "Ссылка для авторизации." description: "Результат получения ссылки для авторизации." example: link: "https://id.tinkoff.ru/auth/authorize?client_id=ibsme&redirect_uri=https://business.tinkoff.ru/sme/accounts/7017906137/cards/1029374074&response_type=none&auth_token=sSP75NhvfGZ5E6puUT1eg9FmxlClVE" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v3/card/virtual/issue/application: get: tags: - "Бизнес-карты" summary: "Получить список заявок на виртуальные карты" description: "Метод возвращает список заявок на виртуальные карты." operationId: "getVirtualApplicationsList" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "limit" in: "query" description: "Количество заявок в списке." required: true style: "form" explode: true schema: type: "integer" - name: "offset" in: "query" description: "Номер первой заявки в списке." required: true style: "form" explode: true schema: type: "integer" responses: "200": description: "Запрошенный список заявок." headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: maxItems: 10000 type: "array" description: "Список заявок." items: required: - "cardIssueApplicationId" - "status" type: "object" properties: cardIssueApplicationId: type: "string" description: "Идентификатор заявки." format: "uuid" status: maxLength: 21 type: "string" description: "Статус заявки. `FAILED_FATAL` — не можем выпус\ тить карту данному физ. лицу, `FAILED_NON_FATAL` — проблем\ а с документами и исходными данными, нужно подать заявку з\ аново." enum: - "NEW" - "IDENTIFICATION" - "ISSUING" - "CARD_ISSUED" - "FAILED_FATAL" - "FAILED_NON_FATAL" ucid: maxLength: 10 type: "string" description: "UCID выпущенной карты." description: "Данные заявки на виртуальную карту." examples: Пустой список заявок: description: "Пустой список заявок" value: [] Список заявок: description: "Непустой список заявок" value: - cardIssueApplicationId: "6bcbca1f-b01d-4796-88bb-d4e868c07a68" status: "NEW" - cardIssueApplicationId: "3edcdf90-95d4-4466-ab98-75436076d9cb" status: "CARD_ISSUED" ucid: "1140102097" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка валидации: description: "Ошибка валидации" value: errorMessage: "Некорректное значение поля запроса" errorId: "01234567890123456789" errorCode: "REQUEST_DATA_VALIDATION_ERROR" errorDetails: field: "Название невалидного поля" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v3/company/card: get: tags: - "Бизнес-карты" summary: "Получить список карт компании" description: "Метод для получения списка карт компании." operationId: "getApiV3Card" parameters: - name: "X-Request-Id" in: "header" description: "Уникальный идентификатор для трассировки запроса. Не влияет\ \ на логику исполнения запроса." required: false allowEmptyValue: false style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." format: "uuid" - name: "accountNumber" in: "query" description: "Номер расчётного счёта, к которому привязана карта." required: false style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" - name: "limit" in: "query" description: "Количество карт, которое нужно вывести. Значение по умолчани\ ю — `1000`." required: false style: "form" explode: true schema: type: "integer" - name: "offset" in: "query" description: "Количество карт, которые необходимо пропустить. Значение по\ \ умолчанию — `0`." required: false style: "form" explode: true schema: type: "integer" responses: "200": description: "Запрошенный список карт" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "cards" - "limit" - "offset" type: "object" properties: cards: maxItems: 10000 type: "array" description: "Список карт." items: required: - "accountNumber" - "cardBin" - "cardLastFourDigits" - "embossedName" - "isActive" - "isVirtual" - "status" - "ucid" type: "object" properties: ucid: type: "integer" description: "Уникальный идентификатор карты." accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта, к которому привяза\ на карта." cardBin: pattern: "^(\\d{6})$" type: "string" description: "Первые 6 цифр номера карты (BIN карты)." cardLastFourDigits: pattern: "^(\\d{4})$" type: "string" description: "Последние 4 цифры номера карты." embossedName: maxLength: 100 type: "string" description: "Имя держателя карты." isActive: type: "boolean" description: "Флаг активации карты." status: type: "string" description: "Статус карты." enum: - "NORM" - "CLOSED" - "BLOCKED" isVirtual: type: "boolean" description: "Флаг виртуальной карты." description: "Данные карты." offset: type: "integer" description: "Запрошенный оффсет." limit: type: "integer" description: "Запрошенный лимит." description: "Список карт." examples: Список карт: description: "Список карт" value: cards: - ucid: 2147484647 accountNumber: "12345678901234567890" cardBin: "404006" cardLastFourDigits: "2222" embossedName: "IVAN IVANOV" isActive: true status: "NORM" isVirtual: true offset: 0 limit: 1000 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неправильно заполненном ИНН: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Данные не соответствуют формату платёжного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при неактивном токене: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Токен недействителен" errorCode: "UNAUTHORIZED" Ошибка при неправильно заданной компании: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Компания с такими ИНН/КПП не найдена. Проверьте\ \ реквизиты. Если реквизиты изменились, необходимо перевыпус\ тить токен." errorCode: "UNAUTHORIZED" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при отсутствии доступов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "У вас неподходящие скопы для данной операции, т\ ребуемые скопы: scope" errorCode: "FORBIDDEN" Ошибка при запросе с неизвестного IP: value: errorId: "efc04138-7d50-40f9-a367-0e1ca4d7cd49" errorMessage: "Запрос был отправлен с IP-адреса, который не бы\ л указан при получении токена. Пожалуйста, укажите этот IP-а\ дрес при получении нового токена" errorCode: "FORBIDDEN" Ошибка при отсутствии прав на использование продукта: value: errorId: "5d1de3e5-82b9-4b1d-b805-a9de95cf83bb" errorMessage: "Недостаточно прав на совершаемое действие. Свяж\ итесь с вашим менеджером, чтобы подключить данную функционал\ ьность. " errorCode: "FORBIDDEN" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при недостатке средств: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Ошибка при превышении лимитов запросов: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: maxLength: 50 type: "string" description: "Идентификатор запроса." content: application/json: schema: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." examples: Непредвиденная ошибка: value: errorId: "60324c74-e4b9-477d-baae-786956876a28" errorMessage: "Непредвиденная ошибка. Попробуйте позже" errorCode: "INTERNAL_ERROR" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" /api/v1/company/signer/status: get: tags: - "Tinkoff Business ID. Информация о компании" summary: "Получить информацию о статусе подписанта" description: "Метод возвращает информацию о том, является ли пользователь по\ дписантом.\nПользователь должен дать согласие на доступ к просмотру информ\ ации о статуcе подписанта.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/signer/get\ \ — Информация о статусе подписанта в компании с ИНН {inn} и КПП {kpp}.\n\ \ " operationId: "getApiV1CompanySignerStatus" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SignerStatusResponse" example: isSigner: true "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/driver-licenses: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить водительские удостоверения" description: "Метод для получения водительских удостоверений физического лиц\ а.\n\n\nЧтобы использовать метод, нужен доступ — opensme/individual/driver-licenses/get\ \ — Водительские удостоверения.\n " operationId: "getApiV1IndividualDocumentsDriver-licenses" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DriverLicensesResponse" example: licenses: - docNumber: "1122334455" issueDate: "2020-10-01" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/inn: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить ИНН" description: "Метод для получения ИНН пользователя.\n\n\nЧтобы использовать\ \ метод, нужен доступ — opensme/individual/inn/get — ИН\ Н.\n " operationId: "getApiV1IndividualDocumentsInn" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InnResponse" example: inn: "719351678037" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/documents/snils: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить СНИЛС" description: "Метод для получения СНИЛС пользователя.\n\n\nЧтобы использоват\ ь метод, нужен доступ — opensme/individual/snils/get — С\ НИЛС.\n " operationId: "getApiV1IndividualDocumentsSnils" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SnilsResponse" example: snils: "95661068844" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/self-employed/status: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить информацию о статусе самозанятого" description: "Метод возвращает информацию о том, является ли пользователь са\ мозанятым.\n\n\nЧтобы использовать метод, нужен доступ opensme/individual/self-employed/status/get\ \ — Информация о статусе самозанятого.\n " operationId: "getApiV1IndividualSelf-employedStatus" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedStatusResponse" example: isSelfEmployed: true "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/accounts/debit: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить информацию об активных дебетовых счетах клиента" description: "Метод возвращает информацию об активных дебетовых счетах — пол\ учатель, счёт получателя, данные по банку.\n\n\nЧтобы использовать метод,\ \ нужен доступ opensme/individual/accounts/debit/get — Р\ еквизиты дебетовых счетов.\n " operationId: "getApiV1IndividualAccountsDebit" responses: "200": description: "Активные дебетовые счета" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DebitAccountsResponse" example: accounts: - name: "Иванов Иван Иванович" accountNumber: "40802123456789012345" bank: bik: "044525974" corAccount: "30101810145250000974" name: "АО \"ТИНЬКОФФ БАНК\"" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/subscription: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить информацию об активной подписке клиента" description: "Метод возвращает информацию с типом активной подписки.\n\n\nЧт\ обы использовать метод, нужен доступ opensme/individual/subscription/get\ \ — Информация о подписке для определения статуса и доступа к опреде\ лённым привилегиям.\n " operationId: "getApiV1IndividualSubscription" responses: "200": description: "Информация о подписке клиента" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" example: type: "PREMIUM" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/individual/cobrand/{programId}: get: tags: - "Tinkoff ID. Информация о пользователе" summary: "Получить признак кобренда" description: "Метод возвращает признак наличия карты кобренда.\n\n\nВ поле scopes\ \ у токена должен быть доступ вида opensme/individual/cobrand/status/get\ \ — по нему можно посмотреть наличие статуса кобрэнда.\n " operationId: "getApiV1IndividualCobrandProgramid" parameters: - name: "programId" in: "path" description: "Уникальный ID программы лояльности партнёра." required: true style: "simple" explode: false schema: type: "integer" description: "Идентификатор программы лояльности" format: "int32" example: 42 responses: "200": description: "Признак кобренда по клиенту" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CobrandResponse" example: programStatus: true accounts: - cardType: "CREDIT" loyaltyId: "123" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/employees/create: post: tags: - "Зарплатный проект" summary: "Создать черновики анкет сотрудников" description: "Запрос является асинхронной операцией — его результат можно по\ лучить через вызов метода Получить результат создания черновиков анкет сотрудников, передав в н\ ём соответствующий correlationId.\n\n\nЧтобы использовать метод, ну\ жен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/employees/manage\ \ — Добавление и получение информации о сотрудниках компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SalaryCreateEmployee" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateEmployeesRequest" examples: Гражданин РФ: summary: "Гражданин РФ" value: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" employees: - number: 1 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1967-12-25" birthPlace: "Санкт-Петербург" citizenship: "Санкт-Петербург" email: "example@example.com" latinFirstName: "Ivan" latinLastName: "Ivanov" phones: - type: "Мобильный" number: "+72565121024" addresses: - type: "Работы" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Херсонская" house: "12" building: "1" construction: "1" apartment: "512" - type: "Жительства" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" - type: "Жительства" country: "РОССИЯ" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" documents: - type: "Паспорт" serial: "1234" number: "123456" date: "2015-05-09" organization: "ФМС" division: "123-123" expireDate: "2025-05-09" jobInfo: position: "программист" Иностранный гражданин: summary: "Иностранный гражданин" value: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" employees: - number: 1 firstName: "Шерлок" lastName: "Холмс" birthDate: "1934-03-09" birthPlace: "Эдинбург" citizenship: "Соединенное Королевство" email: "example@example.com" latinFirstName: "Sherlock" latinLastName: "Holmes" phones: - type: "Мобильный" number: "+72565121024" addresses: - type: "Работы" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Херсонская" house: "12" building: "1" construction: "1" apartment: "512" - type: "Жительства" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" - type: "Жительства" country: "РОССИЯ" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" documents: - type: "Загр. паспорт иностранного гр." serial: "1234" number: "123456" date: "2015-05-09" organization: "Migration service of the United Kingdom" expireDate: "2025-05-09" - type: "Вид на жительство" serial: "1234" number: "123456" date: "2015-05-09" organization: "ФМС" expireDate: "2025-05-09" jobInfo: position: "детектив" Гражданин РФ + Иностранный гражданин: summary: "Гражданин РФ + Иностранный гражданин" value: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" employees: - number: 1 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1967-12-25" birthPlace: "Санкт-Петербург" citizenship: "Санкт-Петербург" email: "example@example.com" latinFirstName: "Ivan" latinLastName: "Ivanov" phones: - type: "Мобильный" number: "+72565121024" addresses: - type: "Работы" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Херсонская" house: "12" building: "1" construction: "1" apartment: "512" - type: "Жительства" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" - type: "Жительства" country: "РОССИЯ" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" documents: - type: "Паспорт" serial: "1234" number: "123456" date: "2015-05-09" organization: "ФМС" division: "123-123" expireDate: "2025-05-09" jobInfo: position: "программист" - number: 2 firstName: "Шерлок" lastName: "Холмс" birthDate: "1934-03-09" birthPlace: "Эдинбург" citizenship: "Соединенное Королевство" email: "example@example.com" latinFirstName: "Sherlock" latinLastName: "Holmes" phones: - type: "Мобильный" number: "+72565121024" addresses: - type: "Работы" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Херсонская" house: "12" building: "1" construction: "1" apartment: "512" - type: "Жительства" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" - type: "Жительства" country: "РОССИЯ" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Таллинская" house: "4" building: "8" construction: "16" apartment: "20" documents: - type: "Загр. паспорт иностранного гр." serial: "1234" number: "123456" date: "2015-05-09" organization: "Migration service of the United Kingdom" expireDate: "2025-05-09" - type: "Вид на жительство" serial: "1234" number: "123456" date: "2015-05-09" organization: "ФМС" expireDate: "2025-05-09" jobInfo: position: "детектив" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateEmployeesResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/employees/create/result: get: tags: - "Зарплатный проект" summary: "Получить результат создания черновиков анкет сотрудников" description: "Возвращает результат запроса для метода Создание черновиков анкет сотрудников.\nОтвет на запрос создания хран\ ится в течение двух дней.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/employees/manage\ \ — Добавление и получение информации о сотрудниках компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SalaryGetEmployeesCreateResult" parameters: - name: "correlationId" in: "query" description: "Уникальный идентификатор типа UUID, который связывает запрос создания с запросом получения ответа\ . Формируется на стороне клиента.\n\n\nОграничение на использование мето\ да — 1 запрос в секунду.\n " required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateEmployeeResultResponse" examples: Example0: value: employeeResults: - number: 1 employeeId: 2 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" status: "CREATED" errors: [] Example1: value: employeeResults: - number: 1 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" status: "ERROR" errors: - fieldName: "Дата рождения" errorDescription: "Вам должно быть от 14 до 100 лет" - fieldName: "Документ" errorDescription: "Дата должна быть не ранее 01.07.1997" - fieldName: "Адрес" errorDescription: "Отсутствует адрес данного типа" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/employees/list: post: tags: - "Зарплатный проект" summary: "Получить информацию по сотрудникам" description: "Вызывайте метод не чаще одного раза в 10 минут.\n\n\nЗаявка на\ \ добавление сотрудника создаётся в статусе DRAFT. После этог\ о её нужно отправить в личном кабинете. Отправленный сотрудник перейдёт в\ \ статус ACTIVE.\n\n\nЧтобы использовать метод, нужен доступ\ \ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/employees/manage —\ \ Добавление и получение информации о сотрудниках компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SalaryGetEmployeesList" requestBody: description: "Список идентификаторов сотрудников. Ограничение на использов\ ание метода — 1 запрос в секунду." content: application/json: schema: $ref: "#/components/schemas/EmployeesInfoRequest" example: employeeIds: - 217 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/EmployeeResponse" example: employees: - id: 217 status: "DRAFT" firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1967-12-25" phones: - type: "Мобильный" number: "+72565121024" documents: - type: "Паспорт" serial: "1234" number: "123456" date: "2015-05-09" organization: "ФМС" division: "123-123" expireDate: "2025-05-09" jobInfo: position: "программист" bankInfo: accountNumber: "40802123456789012345" agreementNumber: "1234567890" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/payment-registry/create: post: tags: - "Зарплатный проект" summary: "Создать черновик платёжного реестра" description: "Запрос является асинхронной операцией — его результат можно по\ лучить через метод Получить результат создания платёжного реестра, передав в нём соответ\ ствующий correlationId.\n\nВ реестр можно добавить сотрудников, кот\ орые находятся в статусах `ACTIVE` и `FIRED`.\n\nЧтобы использовать метод\ , нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/payment-registry/manage\ \ — Добавление и получение информации о платежных реестрах компании\ \ с инн {inn} и кпп {kpp}.\n\nОграничение на использование метода —\ \ 1 запрос в секунду.\n " operationId: "SalaryCreatePaymentRegistry" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePaymentRegistryRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" companyAccountNumber: "40802123456789012345" loadDate: "2015-05-09T12:30" registryCreateType: "FAIL_ERRORS" payments: - number: 1 accountNumber: "12345678901234567890" paymentPurpose: "Зарплата" employeeInfo: firstName: "Петр" lastName: "Петров" middleName: "Петрович" sum: 65000 periodStart: "2015-05-09" periodEnd: "2016-05-09" revenueTypeCode: "2" collectionAmount: 50 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreatePaymentRegistryResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/payment-registry/create/result: get: tags: - "Зарплатный проект" summary: "Получить результат создания черновика платёжного реестра" description: "Метод возвращает результат запроса для метода Создать платёжный реестр.\nРезультат создания хранится в течение двух\ \ дней.\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/payment-registry/manage\ \ — Добавление и получение информации о платежных реестрах компании\ \ с ИНН {inn} и КПП {kpp}.\n\nОграничение на использование метода —\ \ 1 запрос в секунду.\n " operationId: "SalaryGetPaymentRegistryCreateResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreatePaymentRegistryResultResponse" examples: Example0: value: paymentRegistryId: 1 status: "CREATED" paymentErrors: [] Example1: value: status: "ERROR" error: fieldName: "Ошибка создания платежного реестра" errorDescription: "Непредвиденная ошибка. Пожалуйста, попроб\ уйте позже." paymentErrors: - number: 1 accountNumber: "40802123456789012345" errors: - fieldName: "Номер счета" errorDescription: "Неверный номер счёта" - fieldName: "Номер договора" errorDescription: "Номер договора не найден" - fieldName: "Статус сотрудника" errorDescription: "Не удалось найти среди активных и бывши\ х сотрудников компании" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/payment-registry/{paymentRegistryId}: get: tags: - "Зарплатный проект" summary: "Получить информацию по платёжному реестру" description: "Метод для получения информации по платёжному реестру — статус\ , дата отправки, номер счёта компании, с которого будут списаны деньги,\nс\ умма и список платежей, их количество.\nВызывайте не чаще одного раза в 10\ \ минут.\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/payment-registry/manage\ \ — Добавление и получение информации о платежных реестрах компании\ \ с ИНН {inn} и КПП {kpp}.\"\n\nОграничение на использование метода\ \ — 1 запрос в секунду.\n " operationId: "SalaryGetPaymentRegistry" parameters: - name: "paymentRegistryId" in: "path" description: "Номер платёжного реестра." required: true style: "simple" explode: false schema: type: "integer" format: "int32" example: 5 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PaymentRegistryResponse" example: status: "EXECUTED" companyAccountNumber: "40816810800000122870" loadDate: "2015-05-09T12:30" paymentsCount: 2 totalSum: 1000 payments: - number: 1 status: "EXECUTED" employeeInfo: firstName: "Петр" lastName: "Петров" middleName: "Петрович" employeeId: 123456789 accountNumber: "40802678901234567890" paymentPurpose: "Зарплата" sum: 750 periodStart: "2015-05-09" periodEnd: "2016-05-09" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/salary/payment-registry/submit: post: tags: - "Зарплатный проект" summary: "Подписать платёжный реестр сотрудников" description: "Запрос является асинхронной операцией — его результат можно по\ лучить через метод Получить результат подписания платёжного реестра, передав в нём соотв\ етствующий correlationId.\n\nДанный метод позволяет подписать черно\ вик платёжного реестра, чтобы оплатить его позже через метод Оплатить реестр или через личный кабинет.\n\nЧтобы использовать метод\ , нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/payment-registry/submit\ \ — Подписание платежных реестров по сотрудникам компании с ИНН {inn}\ \ и КПП {kpp}.\n\nОграничение на использование метода — 1 запрос в\ \ секунду.\n " operationId: "SalaryPaymentRegistrySubmit" requestBody: content: application/json: schema: $ref: "#/components/schemas/PaymentRegistrySubmitRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" paymentRegistryId: 12 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PaymentRegistrySubmitResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/salary/payment-registry/submit/result: get: tags: - "Зарплатный проект" summary: "Получить результат подписания платёжного реестра сотрудников" description: "Метод возвращает результат запроса для метода Подписать платёжный реестр сотрудников.\nРезультат создания хранится\ \ в течение двух дней.\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/salary/payment-registry/submit\ \ — Подписание платежных реестров по сотрудникам компании с ИНН {inn}\ \ и КПП {kpp}.\n\nОграничение на использование метода — 1 запрос в\ \ секунду.\n " operationId: "SalaryPaymentRegistrySubmitResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PaymentRegistrySubmitResultResponse" examples: Example0: value: paymentRegistryId: 12 status: "ACCEPTED" paymentErrors: [] Example1: value: paymentRegistryId: 12 status: "ERROR" error: errorCode: "INTERNAL_ERROR" errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте\ \ позже." paymentErrors: - number: 1 accountNumber: "40802123456789012345" errors: - fieldName: "Номер счета" errorDescription: "Неверный номер счёта" - fieldName: "Номер договора" errorDescription: "Номер договора не найден" - fieldName: "Статус сотрудника" errorDescription: "Не удалось найти среди активных и бывши\ х сотрудников компании" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/recipients/create: post: tags: - "Выплаты самозанятым" summary: "Создать черновики анкет самозанятых" description: "Метод для создания черновиков анкет самозанятых.\n\n\nЗапрос а\ синхронный. Его результат можно получить через вызов метода Получить результат создания самозанятого с выпуском карты, передав в\ \ нём соответствующий correlationId.\n\n\nЧтобы использовать метод\ , нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/recipients/manage\ \ — Добавление и получение информации о самозанятых компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SelfEmployedCreateSelfEmployed" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateSelfEmployedRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" recipients: - number: 1 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1967-12-25" birthPlace: "Санкт-Петербург" citizenship: "Санкт-Петербург" email: "example@example.com" latinFirstName: "Ivan" latinLastName: "Ivanov" phones: - type: "Мобильный" number: "+72565121024" addresses: - type: "Жительства" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Херсонская" house: "12" building: "1" construction: "1" apartment: "512" - type: "Регистрации" country: "Россия" postalCode: "123123" state: "Санкт-Петербург" city: "Санкт-Петербург" district: "Санкт-Петербург" settlement: "Санкт-Петербург" street: "ул. Херсонская" house: "12" building: "1" construction: "1" apartment: "512" documents: - type: "Паспорт" serial: "2048" number: "131072" date: "2015-05-09" organization: "ФМС" division: "256-512" expireDate: "2025-05-09" registrationInfo: oktmo: "oktmo" activityCodes: - "1" - "2" - "3" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateSelfEmployedResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/recipients/create/result: get: tags: - "Выплаты самозанятым" summary: "Получить результат создания черновиков анкет самозанятых" description: "Метод возвращает результат запроса на создание самозанятого.\n\ Ответ на запрос создания хранится в течение двух дней.\n\n\nЧтобы использо\ вать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/recipients/manage\ \ — Добавление и получение информации о самозанятых компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SelfEmployedGetSelfEmployedCreateResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateSelfEmployedResultResponse" examples: Example0: value: recipientResults: - number: 1 recipientId: 2 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" status: "CREATED" errors: [] Example1: value: recipientResults: - number: 1 firstName: "Иван" lastName: "Иванов" middleName: "Иванович" status: "ERROR" errors: - fieldName: "Дата рождения" errorDescription: "Вам должно быть от 14 до 100 лет" - fieldName: "Документ" errorDescription: "Дата должна быть не ранее 01.07.1997" - fieldName: "Адрес" errorDescription: "Отсутствует адрес данного типа" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/recipients/list: post: tags: - "Выплаты самозанятым" summary: "Получить информацию по самозанятым" description: "Метод для получения информации по самозанятым. Вызывайте не ча\ ще одного раза в 10 минут.\n\n\nЗаявка для добавления самозанятого создаёт\ ся в статусе DRAFT. После этого её нужно отправить в личном к\ абинете. Отправленный самозанятый перейдёт в статус ACTIVE.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/recipients/manage\ \ — Добавление и получение информации о самозанятых компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SelfEmployedList" requestBody: content: application/json: schema: $ref: "#/components/schemas/SelfEmployedListRequest" example: recipientIds: - 1 - 2 - 3 inn: - "502805064090" status: - "PROCESSING" - "DRAFT" - "PROCESSING_ERROR" - "ACTIVE" - "ERROR" - "REJECTED" - "DELETED" - "MTNG_SCHD" - "MTNG_WAIT" - "MTNG_CANC" selfEmployedStatus: - "REGISTRATION_WAIT" - "NOT_CONFIRM" - "NOT_ACTIVE" - "ACTIVE" creationDate: from: "2022-12-27T12:02:08Z" to: "2022-12-29T15:02:00Z" offset: 0 limit: 20 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedResponse" example: recipients: - id: 1 status: "ACTIVE" selfEmployedStatus: "ACTIVE" firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1958-09-05" phones: - type: "Мобильный" number: "+72565121024" documents: - type: "Паспорт" serial: "2048" number: "131072" date: "2015-05-09" organization: "ФМС Семи Королевств" division: "256-512" expireDate: "2025-05-09" registrationInfo: oktmo: "oktmo" activityCodes: - "1" - "2" - "3" bankInfo: accountNumber: "40817678901234567890" agreementNumber: "7007131001" bankBic: "044525187" inn: "719351678037" creationDate: "2023-01-05T11:39:04Z" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/payment-registry/create: post: tags: - "Выплаты самозанятым" summary: "Создать черновик платёжного реестра" description: "Метод для создания черновика платёжного реестра.\n\n\nЗапрос а\ синхронный. Его результат можно получить через вызов метода Получить результат создания платёжного реестра, передав в нём соответ\ ствующий correlationId.\n\n\nВы можете добавлять в реестр самозянят\ ых, которые находятся в статусах ACTIVE и FIRED.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/manage\ \ — Добавление и получение информации о платёжных реестрах по самоза\ нятым компании с ИНН {inn} и КПП {kpp}.\n\n\nОграничение на использ\ ование метода — 1 запрос в секунду.\n " operationId: "SelfEmployedCreatePaymentRegistry" requestBody: content: application/json: schema: $ref: "#/components/schemas/SelfEmployedCreatePaymentRegistryRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" companyAccountNumber: "40802123456789012345" registryCreateType: "FAIL_ERRORS" payments: - number: 1 accountNumber: "12345678901234567890" paymentPurpose: "Оплата по договору" selfEmployedInfo: firstName: "Петр" lastName: "Петров" middleName: "Петрович" sum: 750 revenueTypeCode: "2" taxHolding: true incomeType: "FROM_LEGAL_ENTITY" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedCreatePaymentRegistryResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/payment-registry/create/result: get: tags: - "Выплаты самозанятым" summary: "Получить результат создания черновика платёжного реестра" description: "Возвращает результат запроса для метода Создать черновик платёжного реестра.\nРезультат создания хранится в т\ ечение двух дней.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/manage\ \ — Добавление и получение информации о платёжных реестрах по самоза\ нятым компании с ИНН {inn} и КПП {kpp}.\n\n\nОграничение на использ\ ование метода — 1 запрос в секунду.\n " operationId: "SelfEmployedGetPaymentRegistryCreateResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedCreatePaymentRegistryResultResponse" examples: Example0: value: paymentRegistryId: 1 status: "CREATED" paymentErrors: [] Example1: value: status: "ERROR" error: fieldName: "Ошибка создания платежного реестра" errorDescription: "Непредвиденная ошибка. Пожалуйста, попроб\ уйте позже." paymentErrors: - number: 1 accountNumber: "40802123456789012345" errors: - fieldName: "Номер счета" errorDescription: "Неверный номер счёта" - fieldName: "Номер договора" errorDescription: "Номер договора не найден" - fieldName: "Статус сотрудника" errorDescription: "Не удалось найти среди активных и бывши\ х сотрудников компании" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/payment-registry/{paymentRegistryId}: get: tags: - "Выплаты самозанятым" summary: "Получить информацию по платёжному реестру" description: "Вызывайте метод не чаще одного раза раз в 10 минут.\n\n\nЧтобы\ \ использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/manage\ \ — Добавление и получение информации о платёжных реестрах по самоза\ нятым компании с ИНН {inn} и КПП {kpp}.\n\n\nОграничение на использ\ ование метода — 1 запрос в секунду.\n " operationId: "SelfEmployedGetPaymentRegistry" parameters: - name: "paymentRegistryId" in: "path" description: "Номер платёжного реестра." required: true style: "simple" explode: false schema: type: "integer" format: "int32" example: 12 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPaymentRegistry" example: status: "EXECUTED" loadDate: "2015-05-09T12:30" paymentsCount: 2 totalSum: 1000 payments: - number: 1 status: "EXECUTED" selfEmployedInfo: firstName: "Петр" lastName: "Петров" middleName: "Петрович" accountNumber: "40802678901234567890" paymentPurpose: "Оплата по договору" sum: 750 revenueTypeCode: "1" collectionAmount: 50 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/payment-registry/submit: post: tags: - "Выплаты самозанятым" summary: "Подписать платёжный реестр самозанятых" description: "Метод позволяет подписать черновик платёжного реестра, чтобы о\ платить его позже через метод Оплатить реестр или через личный кабинет.\n\n\nЗапрос асинхронный. Ег\ о результат можно получить через вызов метода Получить результат подписания платёжного реестра, передав в нём соотв\ етствующий correlationId.\n\n\nЧтобы использовать метод, нужен дост\ уп — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/submit\ \ — Подписание платёжных реестров по самозанятым компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SelfEmployedPaymentRegistrySubmit" requestBody: content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPaymentRegistrySubmitRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" paymentRegistryId: 12 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPaymentRegistrySubmitResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/payment-registry/submit/result: get: tags: - "Выплаты самозанятым" summary: "Получить результат подписания платёжного реестра самозанятых" description: "Возвращает результат запроса для метода Подписать платёжный реестр самозанятых.\nРезультат создания хранится\ \ в течение двух дней.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/submit\ \ — Подписание платёжных реестров по самозанятым компании с ИНН {inn}\ \ и КПП {kpp}.\n\n\nОграничение на использование метода — 1 запрос\ \ в секунду.\n " operationId: "SelfEmployedGetPaymentRegistrySubmitResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPaymentRegistryResultSubmitResponse" examples: Example0: value: paymentRegistryId: 12 status: "ACCEPTED" paymentErrors: [] Example1: value: paymentRegistryId: 12 status: "ERROR" error: errorCode: "INTERNAL_ERROR" errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте\ \ позже." paymentErrors: - number: 1 accountNumber: "40802123456789012345" errors: - fieldName: "Номер счета" errorDescription: "Неверный номер счёта" - fieldName: "Номер договора" errorDescription: "Номер договора не найден" - fieldName: "Статус сотрудника" errorDescription: "Не удалось найти среди активных и бывши\ х сотрудников компании" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/payment-registry/pay: post: tags: - "Выплаты самозанятым" summary: "Оплатить платёжный реестр" description: "Запрос является асинхронной операцией — его результат можно по\ лучить через вызов метода Получить результат оплаты платёжного реестра самозанятых, передав в н\ ём соответствующий correlationId.\n\n\nЧтобы использовать метод, ну\ жен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/pay\ \ — Оплата подписанных платёжных реестров сотрудников или самозаняты\ х.\n\n\nОграничение на использование метода — 1 запрос в секунду.\n\ \ " operationId: "SelfEmployedPayPaymentRegistry" requestBody: content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPayPaymentRegistryRequest" example: paymentRegistryId: 1 correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPayPaymentRegistryResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/payment-registry/pay/result: post: tags: - "Выплаты самозанятым" summary: "Получить результат оплаты платёжного реестра" description: "Возвращает результат запроса для метода Оплатить платёжный реестр самозанятых.\nРезультат создания хранится в\ \ течение двух дней.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/pay\ \ — Оплата подписанных платёжных реестров сотрудников или самозаняты\ х.\n\n\nОграничение на использование метода — 1 запрос в секунду.\n\ \ " operationId: "SelfEmployedPayPaymentRegistryResult" requestBody: content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPayPaymentRegistryResultRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedPayPaymentRegistryResultResponse" example: paymentRegistryId: 56 status: "SENT" count: 1 paymentResults: - number: 1 paymentStatus: "SENT" errors: [] "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/payment-registry/receipts: post: tags: - "Выплаты самозанятым" summary: "Получить чеки по платёжному реестру самозанятых" description: "Метод позволяет запрашивать ссылки на чеки, полученные через м\ етод Зарегистрировать доход самозанятого.\n\n\nЗапрос является асинхронной\ \ операцией — его результат можно получить через вызов метода Получить результат запроса на получение чеков, передав в нём соответс\ твующий correlationId.\n\n\nЧтобы использовать метод, нужен доступ\ \ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/fiscalize\ \ — Регистрация дохода и получение чеков по платежам платёжного реес\ тра по самозанятым компании с ИНН {inn} и КПП {kpp}.\n\n\nОграничен\ ие на использование метода — 1 запрос в секунду.\n " operationId: "SelfEmployedReceipts" requestBody: content: application/json: schema: $ref: "#/components/schemas/SelfEmployedReceiptsRequest" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" paymentRegistryId: 777 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedReceiptsResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/payment-registry/receipts/result: get: tags: - "Выплаты самозанятым" summary: "Получить результат запроса на получение чеков" description: "Метод возвращает результат запроса на получение чеков.\n\n\nЧт\ обы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/payment-registry/fiscalize\ \ — Регистрация дохода и получение чеков по платежам платёжного реес\ тра по самозанятым компании с ИНН {inn} и КПП {kpp}.\n\n\nОграничен\ ие на использование метода — 1 запрос в секунду.\n " operationId: "SelfEmployedReceiptsResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/SelfEmployedReceipts" examples: Example0: value: status: "FINISHED" receipts: - number: 777 selfEmployedInfo: firstName: "Иван" lastName: "Иванов" middleName: "Иванович" recipientId: 123456789 link: "http://link.example" status: "SUCCESS" Example1: value: status: "ERROR" error: errorCode: "INTERNAL_ERROR" errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте\ \ позже." receipts: - number: 777 selfEmployedInfo: firstName: "Иван" lastName: "Иванов" middleName: "Иванович" recipientId: 123456789 status: "ERROR" error: errorCode: "INTERNAL_ERROR" errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуй\ те позже." "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/invoice/send: post: tags: - "Выставление счетов" summary: "Выставить счёт" description: "Метод для выставления счетов — номер, срок оплаты, дата выстав\ ления, информация о плательщике и другое.\nЛоготип и подпись с печатью не\ \ проставляются.\n\n\nПользователь должен дать согласие на доступ к создан\ ию и отправке счетов на оплату контрагенту.\n\n\nЧтобы использовать метод\ , нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/invoice/submit\ \ — Создание, отправка счёта на оплату и получение его информации в\ \ компании с ИНН {inn} и КПП {kpp}.\n\n\nОграничение на использован\ ие метода — 4 запроса в секунду.\n " operationId: "postApiV1InvoiceSend" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAndSendInvoiceRequest" example: invoiceNumber: "12345" dueDate: "2020-08-22" invoiceDate: "2020-07-23" accountNumber: "40802123456789012345" payer: name: "ООО Рога и Копыта" inn: "730990470834" kpp: "123456789" items: - name: "Рога" price: 10 unit: "Шт" vat: "None" amount: 10 - name: "Копыта" price: 100 unit: "Шт" vat: "20" amount: 2 contacts: - email: "example@mail.com" contactPhone: "+74996051110" comment: "Комментарий, например, информанция для контрагента." required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateAndSendInvoiceResponse" example: pdfUrl: "https://example.com/qwetq" invoiceId: "d8327c28-4a8e-4084-93ea-a94b7bd144c5" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/payment/ruble-transfer/pay: post: tags: - "Платежи" summary: "Выполнить платёж" description: "Метод для выплаты денег с рублёвых счетов компании на счета ре\ зидентов юридических и физических лиц в банках РФ.\n\n\nВыплата денег со с\ чёта производится асинхронно.\nЧтобы совершать налоговые платежи за себя и\ \ за третьих лиц, передайте значения в блоке tax.\n\n\nРезультат за\ проса на выплату можно получить через метод Получить статуса платежа, передав в нём соответствующий paymentId.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/payments/rub-pay\ \ — Совершение платежей с рублёвого расчётного счёта компании с ИНН\ \ {inn} и КПП {kpp}.\n\n\nВсе вызовы метода дедуплицируются:\n\nSelf-с\ ценарий\n\n\nДедупликация происходит по paymentId в контексте в\ ашей компании. Это значит, что paymentId должен быть уникален в рам\ ках всех платежей от лица вашей компании.\nЕсли вызвать метод два и более\ \ раза с одинаковыми paymentId в рамках одной компании, создастся т\ олько один платёж.\n\nПартнёрский сценарий\n\n\nДедупликация происх\ одит по paymentId и clientId. Это значит, что связка paymentId\ \ и clientId должна быть уникальна.\nЕсли вызвать метод два и более\ \ раза с одинаковыми paymentId и clientId, создастся только\ \ один платёж.\nclientId выдаётся при регистрации партнёра в Tinkoff\ \ и отправляется на почту.\n\nЛимиты\n\n\nПо умолчанию на выполнени\ е платежей через API установлены следующие лимиты:\n\n\n\nЧтобы изменить лимиты д\ ля вашей компании, напишите на openapi@tinkoff.ru.\n\ \n\nОграничение на использование метода — 10 запросов в секунду." operationId: "PaymentsCorePay" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePaymentRequest" examples: Example0: summary: "Пример платежа в пользу юридического лица" value: id: "123456" from: accountNumber: "12345678900987654321" to: name: "ООО \"РОГА и КОПЫТА\"" inn: "1234567890" kpp: "111222333" bik: "444555666" bankName: "Чемпион" corrAccountNumber: "12345678901234567890" accountNumber: "11122233344455566677" purpose: "Оплата по договору №123. НДС не облагается" documentNumber: 100 executionOrder: 5 amount: 10 dueDate: "2020-07-01T00:00+03:00" meta: clientCustomField: "value" Example1: summary: "Пример платежа в пользу физического лица" value: id: "123456" from: accountNumber: "12345678900987654321" to: name: "Иванов В.В." inn: "0" bik: "444555666" bankName: "Чемпион" corrAccountNumber: "12345678901234567890" accountNumber: "11122233344455566677" purpose: "//ВЗС//500-00// Выплата заработной платы (30000 руб.)\ \ Иванову В.В. за июль 2020 года по ведомости от 30.06.20 №5.\ \ НДС не облагается" documentNumber: 100 executionOrder: 5 amount: 30000 dueDate: "2020-07-01T00:00+03:00" revenueTypeCode: "1" collectionAmount: 500 meta: clientCustomField: "value" Example2: summary: "Пример налогового платежа" value: id: "123456" from: accountNumber: "12345678900987654321" to: name: "ООО \"РОГА и КОПЫТА\"" inn: "1234567890" kpp: "111222333" bik: "444555666" bankName: "Чемпион" corrAccountNumber: "12345678901234567890" accountNumber: "11122233344455566677" uin: "12345678912345678900" tax: payerStatus: "01" kbk: "18210301000011000110" oktmo: "50701000" evidence: "ТП" period: "ГД.00.2021" docNumber: "ТР" docDate: "10.01.2020" thirdParty: inn: "563287187294" kpp: "849354728" purpose: "1234567890//123456789//ООО \"Абажур\"//НДС за 1 кварта\ л 2017 года Пени по ТР. №132235 от 25.07.2017 г" documentNumber: 100 executionOrder: 5 amount: 10 dueDate: "2020-07-01T00:00+03:00" meta: clientCustomField: "value" Example3: summary: "Пример платежа при уплате налоговых задолженностей работ\ ников" value: id: "123456" from: accountNumber: "12345678900987654321" to: name: "УФК по г. Москве (Черемушкинский ОСП УФСПП УФСПП России\ \ по г.Москве)" inn: "7704270863" kpp: "771945003" bik: "004525988" bankName: "ГУ Банка России по ЦФО/УФК по г. Москве г.Москва л\ /c 05731234567" corrAccountNumber: "40102810545370000003" accountNumber: "03100643000000017300" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по ис\ полнительному листу от 01.08.2021 по делу N 2-2733/2021" documentNumber: 100 executionOrder: 5 amount: 10 dueDate: "2020-07-01T00:00+03:00" meta: clientCustomField: "value" required: true responses: "201": description: "Платёж поставлен в очередь на исполнение" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" examples: Ошибка при некорректных реквизитах: value: errorMessage: "Payment verification failed" errorCode: "VERIFICATION_FAILED" errorId: "12c342b26ae6a44fe5b2" errorDetails: reason: "Проверьте номер счета получателя — возможно, вы ука\ зали неправильные цифры" Ошибка, когда платеж с данным id уже совершён: value: errorMessage: "Non unique payment" errorCode: "PAYMENT_ALREADY_COMPLETED" errorId: "c1bde0417a19088492b5" Ошибка при неверном р/c отправителя: value: errorMessage: "No agreement found for given account" errorCode: "UNKNOWN_ACCOUNT" errorId: "d929c551b4770b708a33" Ошибка при недостаточном балансе: value: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/payment/{paymentId}: get: tags: - "Платежи" summary: "Получить статус платежа" description: "Метод для получения статуса выплаты, произведённой через метод\ ы Выпо\ лнить платёж и Выполнить платёж на карту Тинькофф.\n\n\nЧтобы использовать метод, ну\ жен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/payments/payment-registry\ \ — Оплата подписанных платёжных реестров сотрудников или самозаняты\ х.\n\n\nПримечание для партнёров: в методе учитывается clientId.\ \ Если ваш clientId был изменён, вы не сможете получить стату\ с платежа, созданного\nпри использовании старого clientId.\n\ clientId выдаётся при регистрации партнёра в Tinkoff и отправ\ ляется на почту.\n\n\nОграничение на использование метода — 20 запросов в\ \ секунду.\n\n\nЧтобы оперативно отслеживать статусы выплат, вы также може\ те воспользоваться вебхуком Статус платежа." operationId: "PaymentsCoreGetStatus" parameters: - name: "paymentId" in: "path" description: "Идентификатор платежа." required: true style: "simple" explode: false schema: type: "string" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PaymentStatusResponse" example: status: "FAILED" errorMessage: "Ошибка в счете получателя. Счет получателя не соотв\ етствует БИКу банка получателя." meta: clientCustomField: "value" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" examples: Ошибка, если данный id платежа не был найден: value: errorMessage: "No payment found for given paymentId" errorCode: "PAYMENT_NOT_FOUND" errorId: "58e32e4e818fad990562" Ошибка при недостаточном балансе: value: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/payment/card-transfer/pay: post: tags: - "Платежи" summary: "Выполнить платёж на карту Тинькофф" description: "Метод для выплаты денег с рублёвых счетов компании на карты Ти\ нькофф по номеру договора себе и другим физическим лицам.\n\n\nВыплата ден\ ег со счёта производится асинхронно.\nРезультат запроса на выплату можно п\ олучить через вызов метода Получить статуса платежа, передав в нём соответствующий paymentId.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/payments/cards-pay\ \ — Совершение платежей физическим лицам с рублёвого расчётного счёт\ а компании с ИНН {inn} и КПП {kpp} на карту Тинькофф.\n\n\nОграниче\ ние на использование метода — 10 запросов в секунду." operationId: "CardPay" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateCardPaymentRequest" examples: Пример платежа с номером договора: value: id: "123456" from: accountNumber: "12345678900987654321" to: agreementNumber: "7000368800" purpose: "Оплата по договору №123. НДС не облагается" documentNumber: 100 amount: 10 executionOrder: 5 dueDate: "2021-06-20T00:00:00Z" required: true responses: "201": description: "Платёж поставлен в очередь на исполнение" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" examples: Ошибка при некорректных реквизитах: value: errorMessage: "Payment verification failed" errorCode: "VERIFICATION_FAILED" errorId: "12c342b26ae6a44fe5b2" errorDetails: reason: "Проверьте номер счета получателя — возможно, вы ука\ зали неправильные цифры" Ошибка, когда платеж с данным id уже совершён: value: errorMessage: "Non unique payment" errorCode: "PAYMENT_ALREADY_COMPLETED" errorId: "c1bde0417a19088492b5" Ошибка при неверном р/c отправителя: value: errorMessage: "No agreement found for given account" errorCode: "UNKNOWN_ACCOUNT" errorId: "d929c551b4770b708a33" Ошибка при недостаточном балансе: value: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/payment/payment-registry/pay: post: tags: - "Платежи" - "Зарплатный проект" summary: "Оплатить реестр" description: "Позволяет оплатить подписанный платёжный реестр сотрудников ил\ и самозанятых.\n\n\nВ поле purpose передайте назначение платежа. В\ \ конце назначения добавьте фразу «Согласно реестру» и номер.\n\n\nЛимиты\ \ по переводам рассчитываются вместе с лимитами по методу Выполнить платёж.\n\n\nРезультат запроса на выплату можно получить че\ рез вызов метода Получить статуса платежа.\nДля зарплатного проекта — Получить информацию по платёжному реестру (зарплатный проект); Получить информацию по платёжному реестру (выплаты самозанятым).\n\n\n\ Чтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/payments/payment-registry\ \ — Оплата подписанных платёжных реестров сотрудников или самозаняты\ х.\n\n\nОграничение на использование метода — 10 запросов в секунду\ ." operationId: "CreateSalaryRegistryPayment" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateRegistryPaymentRequest" example: id: "123456" paymentRegistryId: 123 accountNumber: "40702810110011000777" purpose: "Зарплата согласно реестру №123 от 30.06.2021" documentNumber: 100 executionOrder: 5 dueDate: "2020-07-01T00:00+03:00" meta: clientCustomField: "value" required: true responses: "201": description: "Платёж поставлен в очередь на исполнение" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/payment/create: post: tags: - "Платежи" summary: "Создать черновик платёжного поручения" description: "Метод для создания черновиков платежей.\n\n\nРезультат запроса\ \ на создание черновика платёжного поручения можно получить через метод Получить с\ писок статусов платёжных документов, передав в нём соответствующий documentId.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/payments/draft/create\ \ — Создание черновиков платежей в компании с ИНН {inn} и КПП {kpp}.\n\ \n\nОграничение на использование метода — 10 запросов в секунду.\n \ \ " operationId: "postApiV1PaymentCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePaymentDraftRequest" examples: Пример платежа в пользу физического лица: summary: "Пример платежа в пользу физического лица" value: documentNumber: "654321" date: "2015-09-03T12:30+03:00[Europe/Moscow]" amount: 500 recipientName: "Петров Петр Петрович" inn: "987654321987" kpp: "0" bankAcnt: "55554444333322221111" bankBik: "76543277778" accountNumber: "40702810110011000777" paymentPurpose: "оплата товара" executionOrder: 5 taxPayerStatus: "09" kbk: "33335555666677778888" oktmo: "33335555" taxEvidence: "ТП" taxPeriod: "ГД.00.2019" uin: "0" taxDocNumber: "0" taxDocDate: "0" revenueTypeCode: "2" collectionAmountNumber: 987654321 recipientCorrAccountNumber: "22228888333366661111" Пример платежа в пользу юридического лица: summary: "Пример платежа в пользу юридического лица" value: documentNumber: "654321" date: "2015-09-03T12:30+03:00[Europe/Moscow]" amount: 50000 recipientName: "ООО Рога и Копыта" inn: "987654321987" kpp: "654321654" bankAcnt: "99998888777766665555" bankBik: "76543277778" accountNumber: "40702810110011000777" paymentPurpose: "оплата товара" executionOrder: 5 taxPayerStatus: "09" kbk: "33335555666677778888" oktmo: "33335555" taxEvidence: "ТП" taxPeriod: "ГД.00.2019" uin: "0" taxDocNumber: "0" taxDocDate: "0" revenueTypeCode: "2" collectionAmountNumber: 987654321 recipientCorrAccountNumber: "66668888000066667777" Пример налогового платежа: summary: "Пример налогового платежа" value: documentNumber: "514462" date: "2021-12-30T00:00+03:00[Europe/Moscow]" amount: 1.0 recipientName: "СИБИРСКОЕ ГУ БАНКА РОССИИ//УФК по Новосибирской\ \ области г. Новосибирск" inn: "7710140679" kpp: "771301001" bankAcnt: "03100643000000015100" bankBik: "015004950" accountNumber: "40702810110011000777" paymentPurpose: "Налоги на прибыль" taxPayerStatus: "01" kbk: "18210301000011000110" oktmo: "50701000" taxEvidence: "ТП" taxPeriod: "ГД.00.2021" uin: "12345678912345678900" taxDocNumber: "1" taxDocDate: "10.01.2020" recipientCorrAccountNumber: "40102810445370000043" Пример налогового платежа за третьих лиц: summary: "Пример налогового платежа за третьих лиц" value: documentNumber: "514462" date: "2021-12-30T00:00+03:00[Europe/Moscow]" amount: 1.0 recipientName: "СИБИРСКОЕ ГУ БАНКА РОССИИ//УФК по Новосибирской\ \ области г. Новосибирск" inn: "7710140679" kpp: "771301001" bankAcnt: "03100643000000015100" bankBik: "015004950" accountNumber: "40702810110011000777" paymentPurpose: "Госпошлина за регистрацию прав на недвижимое им\ ущество и сделок с ним" taxPayerStatus: "13" kbk: "18210301000011000110" oktmo: "50701000" taxEvidence: "0" taxPeriod: "0" uin: "12345678912345678900" taxDocNumber: "1" taxDocDate: "10.01.2020" recipientCorrAccountNumber: "40102810445370000043" thirdParty: inn: "987654321098" kpp: "0" name: "Иванов Иван Иванович" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreatePaymentDraftResponse" example: documentId: "55555000-0000-0000-5555-000011110000" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" examples: Ошибка при определении банка-получателя: value: errorMessage: "Не можем определить банк-получатель. Проверьте\ , что БИК указан верно" errorCode: "CANT_DETERMINE_BANK_RECEIVER" errorId: "28cad1786e" Ошибка при неправильном расчетном счете: value: errorMessage: "Не найден расчетный счет с номером 40802000000000000000" errorCode: "INVALID_ACCOUNT_NUMBER" errorId: "162eb53ec0" Ошибка при несоответствии данных формату платежного поручения: value: errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorId: "c5a6096c3" Ошибка при неверном р/c отправителя: value: errorMessage: "No agreement found for given account" errorCode: "UNKNOWN_ACCOUNT" errorId: "d929c551b4770b708a33" Ошибка при недостаточном балансе: value: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/bank-statement: get: tags: - "Счета и выписки" summary: "Получить выписку по счёту клиента за определённый период" description: "Метод для получения выписок по счетам.\n\n\nЧтобы использовать\ \ метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/bank-statements/get\ \ — Информация об операциях компании с ИНН {inn} и КПП {kpp}.\n\ \n\nЗапросы выписок с количеством операций более 50 000 сейчас не поддержи\ ваются и будут возвращать ошибку.\n\n\nОграничение на использование метода\ \ — 10 запросов в секунду." operationId: "getApiV1Bank-statement" parameters: - name: "accountNumber" in: "query" description: "Расчётный счёт организации." required: true style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." example: 40702810110011000777 - name: "from" in: "query" description: "Дата начала периода. Если параметр не передаётся, дата прира\ внивается значению даты конца — 1 месяц." required: false style: "form" explode: true schema: type: "string" format: "date" example: "2021-11-03" - name: "till" in: "query" description: "Дата окончания периода. Если параметр не передаётся, приравн\ ивается текущей дате." required: false style: "form" explode: true schema: type: "string" format: "date" example: "2021-11-03" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BankStatement" example: accountNumber: "99998888777766665555" saldoIn: 500 income: 500 outcome: 500 saldoOut: 500 operation: - operationId: "12345_89765" id: "1234567890123456789" date: "2015-04-01" amount: 500 drawDate: "2015-05-01" payerName: "Иванов Иван Иванович" payerInn: "987654321987" payerAccount: "99998888777766665555" payerCorrAccount: "40244447777333300000" payerBic: "76543277778" payerBank: "банк 'Лидеров'" chargeDate: "2015-09-03" recipient: "Петров Петр Петрович" recipientInn: "765432198765" recipientAccount: "77774444222277772222" recipientCorrAccount: "40299998888777700000" recipientBic: "12345678901" recipientBank: "банк 'Чемпионов'" paymentType: "" operationType: "01" uin: "0" paymentPurpose: "материальная помощь" creatorStatus: "" kbk: "44445555666677778888" oktmo: "44445555" taxEvidence: "ТП" taxPeriod: "ГД.00.2019" taxDocNumber: "0" taxDocDate: "0" taxType: "taxType" executionOrder: "5" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/bank-accounts: get: tags: - "Счета и выписки" summary: "Получить счета" description: "Чтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/bank-accounts/get\ \ — Информация о счетах компании с ИНН {inn} и КПП {kpp}. Огр\ аничение на использование метода — 6 запросов в секунду." operationId: "getApiV1Bank-accounts" responses: "200": description: "Расчётные счета" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "array" items: $ref: "#/components/schemas/AccountInfo" examples: Расчётные счета: value: - accountNumber: "40802678901234567890" currency: "643" balance: otb: 45089 authorized: 0 pendingPayments: 0 pendingRequisitions: 0 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v2/bank-accounts: get: tags: - "Счета и выписки" summary: "Получить счета" description: "Чтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/bank-accounts/get\ \ — Информация о счетах компании с ИНН {inn} и КПП {kpp}. Огр\ аничение на использование метода — 6 запросов в секунду." operationId: "getApiV2Bank-accounts" responses: "200": description: "Расчётные счета" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "array" items: $ref: "#/components/schemas/AccountInfo1" examples: Расчётные счета: value: - accountNumber: "40802678901234567890" name: "Валютный фунтовый счет" currency: "643" bankBik: "123456789" accountType: "Current" balance: otb: 45089 authorized: 0 pendingPayments: 0 pendingRequisitions: 0 transitAccount: accountNumber: "11223344556677889900" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v3/bank-accounts: get: tags: - "Счета и выписки" summary: "Получить счета v3" description: "Метод для получения информации по расчётным счетам организаций\ .\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/bank-accounts/get\ \ — Информация о счетах компании с ИНН {inn} и КПП {kpp}.\n\n\ \nОграничение на использование метода — 6 запросов в секунду." operationId: "getApiV3Bank-accounts" responses: "200": description: "Расчётные счета" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "array" items: $ref: "#/components/schemas/AccountInfo2" examples: Расчётные счета: value: - accountNumber: "40802678901234567890" name: "Валютный фунтовый счет" currency: "643" bankBik: "123456789" accountType: "Current" activationDate: "2010-08-03" balance: otb: 45089 authorized: 0 pendingPayments: 0 pendingRequisitions: 0 transitAccount: accountNumber: "11223344556677889900" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v4/bank-accounts: get: tags: - "Счета и выписки" summary: "Получить счета v4" description: "Метод для получения информации по расчётным и инвестиционным с\ четам организаций.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/bank-accounts/get\ \ — Информация о счетах компании с ИНН {inn} и КПП {kpp}.\n\n\ \nОграничение на использование метода — 6 запросов в секунду." operationId: "getApiV4Bank-accounts" parameters: - name: "withInvest" in: "query" description: "Флаг получения инвестиционных счетов." required: false style: "form" explode: true schema: type: "boolean" responses: "200": description: "Расчётные счета" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "array" items: $ref: "#/components/schemas/AccountInfo3" examples: Расчётные счета: value: - accountNumber: "40802678901234567890" name: "Валютный фунтовый счет" status: "NORM" tariffName: "Тарифный план \"Продвинутый\" GBP" tariffCode: "TFLE1.2GBP" currency: "643" createdOn: "2010-08-03" mainFlag: "Y" bankBik: "123456789" accountType: "Current" activationDate: "2010-08-03" balance: balance: 444333 realOtb: 44000 otb: 45089 authorized: 0 pendingPayments: 0 pendingRequisitions: 0 transitAccount: accountNumber: "11223344556677889900" - accountNumber: "" name: "Инвестиционный счет" status: "NORM" tariffName: "" tariffCode: "TRD12.1" currency: "643" createdOn: "2023-01-01" mainFlag: "N" bankBik: "123456789" accountType: "Invest" activationDate: "2023-01-01" balance: balance: 50000 realOtb: 0 otb: 0 authorized: 0 pendingPayments: 0 pendingRequisitions: 0 brokerCurrencyBalance: - currency: "RUB" currentBalance: 125 currentBalanceForWithdrawal: 115 blockedQuantity: 10 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/account-operations: get: tags: - "Счета и выписки" summary: "Получить выписку с авторизациями за определённый период" description: "Необходимо согласие пользователя на доступ к информации об опе\ рациях компании. Чтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/account-operations/get\ \ — Информация о транзакциях и авторизациях по счетам компании с инн\ \ {inn} и кпп {kpp}.Запросы с количеством операций более 10 000 буд\ ут возвращать ошибку TOO_MANY_OPERATIONS. Ограничение на использование мет\ ода — 3 запроса в секунду." operationId: "getApiV1Account-operations" parameters: - name: "accountNumber" in: "query" description: "Расчётный счёт организации." required: true style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." example: 40702810110011000777 - name: "ucid" in: "query" description: "UCID карты. Если не указан, вернутся все операции по счёту." required: false style: "form" explode: true schema: type: "integer" format: "int64" example: 1234567890 - name: "operationStatus" in: "query" description: "Статус операции. Если не указан, вернутся как транзакции, та\ к и авторизации." required: false style: "form" explode: true schema: $ref: "#/components/schemas/AccountOperationStatus" example: "transaction" - name: "from" in: "query" description: "Дата начала периода, включительно." required: true style: "form" explode: true schema: type: "string" format: "date-time" example: "2021-11-03T11:00:00+03:00" - name: "till" in: "query" description: "Дата конца периода, исключительно." required: true style: "form" explode: true schema: type: "string" format: "date-time" example: "2021-11-03T11:00:00+03:00" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: type: "array" items: $ref: "#/components/schemas/AccountOperation" example: - accountNumber: "40702810110011000777" authDateTime: "2021-11-17T12:10+03:00" trxnDateTime: "2021-11-17T12:11+03:00" authId: "123456789" trxnId: "123456789" authStatus: "succeed" operationType: "debit" operationStatus: "transaction" amount: 100 currency: "RUB" accountAmount: 100 description: "Нужно совершить платеж" card: ucid: "12345678901234567890" mcc: "1234" number: "1111********9999" merch: id: "123456" name: "Лучший Банк" address: "ул. Уличная, д. 666" city: "MOSCOW" country: "RUS" rrn: "123456789012" acquirerId: "010455" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/special-accounts/arrest-etp: get: tags: - "Специальные счета" summary: "Получить данные по специальным счетам" description: "Метод возвращает информацию по блокировкам, картотекам ЭТП (эл\ ектронная торговая площадка) и списаниям за нарушения договора.\n\n\nЧтобы\ \ использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/special-accounts/arrest-etp/get\ \ — Получение информации по картотекам, блокировкам, картотекам ЭТП\ \ и по списаниям в бюджет.\n\n\nУ блокировок и картотек нет информа\ ции о дате отмены, ориентируйтесь только на статус — cardIndexStatus.\n\ \n\nОграничение на использование метода — 4 запроса в секунду." operationId: "getApiV1Special-accountsArrest-etp" parameters: - name: "accountNumber" in: "query" description: "Номер счёта клиента." required: true style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." example: 40702810110011000777 - name: "from" in: "query" description: "Дата начала периода." required: true style: "form" explode: true schema: type: "string" format: "date" example: "2020-12-01" - name: "till" in: "query" description: "Дата окончания периода." required: true style: "form" explode: true schema: type: "string" format: "date" example: "2020-12-31" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/OperationsResponse" example: etpFees: - id: "987654321" externalId: "ETP-JNT-f8856187-11eb-46a2-ba1a-eb9ad29aade0" amount: 600 currency: "643" status: "ACTIVE" date: "2021-08-11T13:02:53.000000175+03:00[Europe/Moscow]" payedAmount: 0 paymentPurpose: "Комиссия" senderInn: "0" recipient: inn: "7707308480" name: "ЗАО Королей и Царей" account: "40702810110011000777" bank: bik: "7706605793" corAccount: "40702809400050001234" name: "Тинькофф" officeName: "ЭТП Королей и царей" contractBreaches: - id: "20051823" externalId: "ETP-JNT-cc1584b7-bd13-4a9f-8c5a-f30908a6cd3d" amount: 444.33 currency: "643" status: "PAYED" date: "2021-08-11T12:56:39.000000020+03:00[Europe/Moscow]" payedAmount: 444.33 paymentPurpose: "Перевод средств с площадки Королей и царей" senderInn: "0" recipient: inn: "7707308480" name: "ЗАО Королей и Царей" account: "40702810110011000777" bank: bik: "7706605793" corAccount: "40702809400050001234" name: "Тинькофф" officeName: "ЭТП Королей и царей" - id: "20051825" externalId: "ETP-JNT-b3a741f8-5ad6-4dcc-bbf1-b21872eccfda" amount: 500.0 currency: "643" status: "ACTIVE" date: "2021-08-11T12:59:06.000000361+03:00[Europe/Moscow]" payedAmount: 0 paymentPurpose: "Перевод средств с площадки Королей и царей" senderInn: "0" recipient: inn: "7707308480" name: "ЗАО Королей и Царей" account: "40702810110011000777" bank: bik: "7706605793" corAccount: "40702809400050001234" name: "Тинькофф" officeName: "ЭТП Королей и царей" - id: "20051829" externalId: "ETP-JNT-e9aecade-1c46-42b4-bb59-e3c0b3a3ecda" amount: 700.0 currency: "643" status: "CANCELED" date: "2021-08-11T13:04:06.000000872+03:00[Europe/Moscow]" payedAmount: 0 paymentPurpose: "Перевод средств с площадки Королей и царей" senderInn: "0" recipient: inn: "7707308480" name: "ЗАО Королей и Царей" account: "40702810110011000777" bank: bik: "7706605793" corAccount: "40702809400050001234" name: "Тинькофф" officeName: "ЭТП Королей и царей" arrests: sum: 3132.99 values: - id: "20051779" externalId: "ETP-JNT-a70a104f-7458-4519-ad44-639255b81bef" amount: 111.0 currency: "643" status: "ACTIVE" date: "2021-08-11T11:35:39.000000658+03:00[Europe/Moscow]" unblockDate: "2021-08-14T10:36:39.000000658+03:00[Europe/Moscow]" circumstances: "Блокировка денег для обеспечения заявки на тор\ гах" officeName: "ЭТП Королей и царей" - id: "20051785" externalId: "ETP-JNT-fad278df-a131-46bb-b461-da4c8dc15085" amount: 444.33 currency: "643" status: "ACTIVE" date: "2021-08-11T11:38:44.000000658+03:00[Europe/Moscow]" unblockDate: "2021-08-14T10:35:19.000000354+03:00[Europe/Moscow]" circumstances: "Блокировка денег для обеспечения заявки на тор\ гах" officeName: "ЭТП Королей и царей" - id: "20051783" externalId: "ETP-JNT-535f7697-1929-4f7c-ba08-cafb2b4005d2" amount: 333.33 currency: "643" status: "CANCELED" date: "2021-08-11T11:37:56.000000783+03:00[Europe/Moscow]" unblockDate: "2021-08-12T12:43:39.000000658+03:00[Europe/Moscow]" circumstances: "Блокировка денег для обеспечения заявки на тор\ гах" officeName: "ЭТП Королей и царей" - id: "20051786" externalId: "ETP-JNT-cc1584b7-bd13-4a9f-8c5a-f30908a6cd3d" amount: 444.33 currency: "643" status: "CANCELED" date: "2021-08-11T11:38:50.000000783+03:00[Europe/Moscow]" unblockDate: "2021-08-12T12:43:39.000000658+03:00[Europe/Moscow]" circumstances: "Блокировка денег для обеспечения заявки на тор\ гах" officeName: "ЭТП Королей и царей" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries: get: tags: - "Бенефициары и реквизиты" summary: "Получить список бенефициаров" description: "\nВозвращает информацию о бенефициарах компании.\n\n\nОграниче\ ние на использование метода — 10 запросов в секунду.\n\n\nЧтобы использова\ ть метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsBeneficiaries" parameters: - name: "offset" in: "query" description: "Количество бенефициаров, которое нужно пропустить. Значение\ \ по умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество бенефициаров, которое нужно вывести. Значение по\ \ умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BeneficiaryListResponse" example: offset: 0 limit: 50 size: 7 total: 7 results: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_RESIDENT" firstName: "Фома" middleName: "Семёнович" lastName: "Киняев" isSelfEmployed: true birthDate: "1969-08-21" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+79998887766" email: "f.kiniaev@tinkoff.ru" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей необ\ ъятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" inn: "266445718640" snils: "72865174431" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_NONRESIDENT" firstName: "John" middleName: "William" lastName: "Smith" isSelfEmployed: false birthDate: "1978-04-03" birthPlace: "Pietersburg" citizenship: "US" phoneNumber: "+12025550190" email: "john.smith@example.com" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "VISA" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "RESIDENCE_ADDRESS" address: "Pietersburg, Transvaal Province, South Africa" inn: "906858195320" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_RESIDENT" name: "Акционерное общество «Тинькофф Банк»" phoneNumber: "+78007551110" email: "business.welcome@tinkoff.ru" addresses: - type: "LEGAL_ENTITY_ADDRESS" address: "127287, г. Москва, ул. Хуторская 2-я, д. 38А, стр. 26" - type: "POSTAL_ADDRESS" address: "Москва, 127287, ул. Хуторская 2-я, д. 38А, стр. 26;\ \ а/я 23, г. Москва, 102001" registrationDate: "2002-11-28" opf: "АО" inn: "7710140679" ogrn: "1027739642281" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_NONRESIDENT" name: "TCS Group Holding Plc." phoneNumber: "+74996051110" email: "business.welcome@tinkoff.ru" addresses: - type: "REGISTRATION_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036a" - type: "LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" - type: "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" nza: "12345678912" registrationDate: "2015-11-13" registrationNumber: "107963" opf: "Plc." inn: "9909215909" kio: "21590" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_RESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+71378820200" email: "KDDwKOwWD0@Pijg1" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей необ\ ъятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" registrationDate: "2010-01-15" inn: "306707771448" ogrn: "310774601501066" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_NONRESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "US" phoneNumber: "+447768027220" email: "OAAQAYkiXe@uUmPe" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "MIGRATION_CARD" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" registrationDate: "2010-01-15" inn: "173527033406" ogrn: "310774601501066" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "LITE_CONTACT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] post: tags: - "Бенефициары и реквизиты" summary: "Создать бенефициара" description: "\nМетод создаёт бенефициара и возвращает его с ID, который нуж\ ен для дальнейшей работы.\n\n\nОграничение на использование метода — 10 за\ просов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами.\n\n\nЗаполняемые данные\ \ будут отличаться в зависимости от типа бенефициара — например, физическо\ е лицо-резидент или физическое лицо-нерезидент.\nПримеры данных по каждому\ \ из типов приведены ниже." operationId: "postApiV1Nominal-accountsBeneficiaries" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/BeneficiaryRequest" examples: Физическое лицо, резидент: value: type: "FL_RESIDENT" firstName: "Фома" middleName: "Семёнович" lastName: "Киняев" isSelfEmployed: true birthDate: "1969-08-21" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+79998887766" email: "f.kiniaev@tinkoff.ru" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей необ\ ъятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" inn: "266445718640" snils: "72865174431" Физическое лицо, нерезидент: value: type: "FL_NONRESIDENT" firstName: "John" middleName: "William" lastName: "Smith" isSelfEmployed: false birthDate: "1978-04-03" birthPlace: "Pietersburg" citizenship: "US" phoneNumber: "+12025550190" email: "john.smith@example.com" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "VISA" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "RESIDENCE_ADDRESS" address: "Pietersburg, Transvaal Province, South Africa" inn: "906858195320" Юридическое лицо, резидент: value: type: "UL_RESIDENT" name: "Акционерное общество «Тинькофф Банк»" phoneNumber: "+78007551110" email: "business.welcome@tinkoff.ru" addresses: - type: "LEGAL_ENTITY_ADDRESS" address: "127287, г. Москва, ул. Хуторская 2-я, д. 38А, стр. 26" - type: "POSTAL_ADDRESS" address: "Москва, 127287, ул. Хуторская 2-я, д. 38А, стр. 26;\ \ а/я 23, г. Москва, 102001" registrationDate: "2002-11-28" opf: "АО" inn: "7710140679" ogrn: "1027739642281" Юридическое лицо, нерезидент: value: type: "UL_NONRESIDENT" name: "TCS Group Holding Plc." phoneNumber: "+74996051110" email: "business.welcome@tinkoff.ru" addresses: - type: "REGISTRATION_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036a" - type: "LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" - type: "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" nza: "12345678912" registrationDate: "2015-11-13" registrationNumber: "107963" opf: "Plc." inn: "9909215909" kio: "21590" ИП, резидент: value: type: "IP_RESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+71378820200" email: "KDDwKOwWD0@Pijg1" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей необ\ ъятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" registrationDate: "2010-01-15" inn: "306707771448" ogrn: "310774601501066" ИП, нерезидент: value: type: "IP_NONRESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "US" phoneNumber: "+447768027220" email: "OAAQAYkiXe@uUmPe" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "MIGRATION_CARD" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" registrationDate: "2010-01-15" inn: "173527033406" ogrn: "310774601501066" Лёгкий контакт: value: type: "LITE_CONTACT" required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BeneficiaryResponse" examples: Физическое лицо, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_RESIDENT" firstName: "Фома" middleName: "Семёнович" lastName: "Киняев" isSelfEmployed: true birthDate: "1969-08-21" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+79998887766" email: "f.kiniaev@tinkoff.ru" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей не\ объятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" inn: "266445718640" snils: "72865174431" Физическое лицо, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_NONRESIDENT" firstName: "John" middleName: "William" lastName: "Smith" isSelfEmployed: false birthDate: "1978-04-03" birthPlace: "Pietersburg" citizenship: "US" phoneNumber: "+12025550190" email: "john.smith@example.com" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "VISA" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "RESIDENCE_ADDRESS" address: "Pietersburg, Transvaal Province, South Africa" inn: "906858195320" Юридическое лицо, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_RESIDENT" name: "Акционерное общество «Тинькофф Банк»" phoneNumber: "+78007551110" email: "business.welcome@tinkoff.ru" addresses: - type: "LEGAL_ENTITY_ADDRESS" address: "127287, г. Москва, ул. Хуторская 2-я, д. 38А, стр\ . 26" - type: "POSTAL_ADDRESS" address: "Москва, 127287, ул. Хуторская 2-я, д. 38А, стр. 26;\ \ а/я 23, г. Москва, 102001" registrationDate: "2002-11-28" opf: "АО" inn: "7710140679" ogrn: "1027739642281" Юридическое лицо, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_NONRESIDENT" name: "TCS Group Holding Plc." phoneNumber: "+74996051110" email: "business.welcome@tinkoff.ru" addresses: - type: "REGISTRATION_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036a" - type: "LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" - type: "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" nza: "12345678912" registrationDate: "2015-11-13" registrationNumber: "107963" opf: "Plc." inn: "9909215909" kio: "21590" ИП, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_RESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+71378820200" email: "KDDwKOwWD0@Pijg1" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей не\ объятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" registrationDate: "2010-01-15" inn: "306707771448" ogrn: "310774601501066" ИП, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_NONRESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "US" phoneNumber: "+447768027220" email: "OAAQAYkiXe@uUmPe" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "MIGRATION_CARD" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" registrationDate: "2010-01-15" inn: "173527033406" ogrn: "310774601501066" Лёгкий контакт: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "LITE_CONTACT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/{beneficiaryId}: get: tags: - "Бенефициары и реквизиты" summary: "Получить данные бенефициара" description: "\nВозвращает информацию о бенефициаре по его ID.\n\n\nОграниче\ ние на использование метода — 10 запросов в секунду.\n\n\nЧтобы использова\ ть метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsBeneficiariesBeneficiaryid" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BeneficiaryResponse" examples: Физическое лицо, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_RESIDENT" firstName: "Фома" middleName: "Семёнович" lastName: "Киняев" isSelfEmployed: true birthDate: "1969-08-21" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+79998887766" email: "f.kiniaev@tinkoff.ru" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей не\ объятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" inn: "266445718640" snils: "72865174431" Физическое лицо, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_NONRESIDENT" firstName: "John" middleName: "William" lastName: "Smith" isSelfEmployed: false birthDate: "1978-04-03" birthPlace: "Pietersburg" citizenship: "US" phoneNumber: "+12025550190" email: "john.smith@example.com" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "VISA" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "RESIDENCE_ADDRESS" address: "Pietersburg, Transvaal Province, South Africa" inn: "906858195320" Юридическое лицо, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_RESIDENT" name: "Акционерное общество «Тинькофф Банк»" phoneNumber: "+78007551110" email: "business.welcome@tinkoff.ru" addresses: - type: "LEGAL_ENTITY_ADDRESS" address: "127287, г. Москва, ул. Хуторская 2-я, д. 38А, стр\ . 26" - type: "POSTAL_ADDRESS" address: "Москва, 127287, ул. Хуторская 2-я, д. 38А, стр. 26;\ \ а/я 23, г. Москва, 102001" registrationDate: "2002-11-28" opf: "АО" inn: "7710140679" ogrn: "1027739642281" Юридическое лицо, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_NONRESIDENT" name: "TCS Group Holding Plc." phoneNumber: "+74996051110" email: "business.welcome@tinkoff.ru" addresses: - type: "REGISTRATION_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036a" - type: "LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" - type: "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" nza: "12345678912" registrationDate: "2015-11-13" registrationNumber: "107963" opf: "Plc." inn: "9909215909" kio: "21590" ИП, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_RESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+71378820200" email: "KDDwKOwWD0@Pijg1" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей не\ объятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" registrationDate: "2010-01-15" inn: "306707771448" ogrn: "310774601501066" ИП, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_NONRESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "US" phoneNumber: "+447768027220" email: "OAAQAYkiXe@uUmPe" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "MIGRATION_CARD" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" registrationDate: "2010-01-15" inn: "173527033406" ogrn: "310774601501066" Лёгкий контакт: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "LITE_CONTACT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] put: tags: - "Бенефициары и реквизиты" summary: "Изменить данные бенефициара" description: "\nМетод полностью изменяет данные бенефициара по его ID.\n\n\n\ Ограничение на использование метода — 10 запросов в секунду.\n\n\nЧтобы ис\ пользовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "putApiV1Nominal-accountsBeneficiariesBeneficiaryid" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/BeneficiaryRequest" examples: Физическое лицо, резидент: value: type: "FL_RESIDENT" firstName: "Фома" middleName: "Семёнович" lastName: "Киняев" isSelfEmployed: true birthDate: "1969-08-21" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+79998887766" email: "f.kiniaev@tinkoff.ru" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей необ\ ъятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" inn: "266445718640" snils: "72865174431" Физическое лицо, нерезидент: value: type: "FL_NONRESIDENT" firstName: "John" middleName: "William" lastName: "Smith" isSelfEmployed: false birthDate: "1978-04-03" birthPlace: "Pietersburg" citizenship: "US" phoneNumber: "+12025550190" email: "john.smith@example.com" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "VISA" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "RESIDENCE_ADDRESS" address: "Pietersburg, Transvaal Province, South Africa" inn: "906858195320" Юридическое лицо, резидент: value: type: "UL_RESIDENT" name: "Акционерное общество «Тинькофф Банк»" phoneNumber: "+78007551110" email: "business.welcome@tinkoff.ru" addresses: - type: "LEGAL_ENTITY_ADDRESS" address: "127287, г. Москва, ул. Хуторская 2-я, д. 38А, стр. 26" - type: "POSTAL_ADDRESS" address: "Москва, 127287, ул. Хуторская 2-я, д. 38А, стр. 26;\ \ а/я 23, г. Москва, 102001" registrationDate: "2002-11-28" opf: "АО" inn: "7710140679" ogrn: "1027739642281" Юридическое лицо, нерезидент: value: type: "UL_NONRESIDENT" name: "TCS Group Holding Plc." phoneNumber: "+74996051110" email: "business.welcome@tinkoff.ru" addresses: - type: "REGISTRATION_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036a" - type: "LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" - type: "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" nza: "12345678912" registrationDate: "2015-11-13" registrationNumber: "107963" opf: "Plc." inn: "9909215909" kio: "21590" ИП, резидент: value: type: "IP_RESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+71378820200" email: "KDDwKOwWD0@Pijg1" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей необ\ ъятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" registrationDate: "2010-01-15" inn: "306707771448" ogrn: "310774601501066" ИП, нерезидент: value: type: "IP_NONRESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "US" phoneNumber: "+447768027220" email: "OAAQAYkiXe@uUmPe" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "MIGRATION_CARD" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр. 26" registrationDate: "2010-01-15" inn: "173527033406" ogrn: "310774601501066" Лёгкий контакт: value: type: "LITE_CONTACT" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BeneficiaryResponse" examples: Физическое лицо, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_RESIDENT" firstName: "Фома" middleName: "Семёнович" lastName: "Киняев" isSelfEmployed: true birthDate: "1969-08-21" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+79998887766" email: "f.kiniaev@tinkoff.ru" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей не\ объятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" inn: "266445718640" snils: "72865174431" Физическое лицо, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "FL_NONRESIDENT" firstName: "John" middleName: "William" lastName: "Smith" isSelfEmployed: false birthDate: "1978-04-03" birthPlace: "Pietersburg" citizenship: "US" phoneNumber: "+12025550190" email: "john.smith@example.com" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "VISA" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "RESIDENCE_ADDRESS" address: "Pietersburg, Transvaal Province, South Africa" inn: "906858195320" Юридическое лицо, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_RESIDENT" name: "Акционерное общество «Тинькофф Банк»" phoneNumber: "+78007551110" email: "business.welcome@tinkoff.ru" addresses: - type: "LEGAL_ENTITY_ADDRESS" address: "127287, г. Москва, ул. Хуторская 2-я, д. 38А, стр\ . 26" - type: "POSTAL_ADDRESS" address: "Москва, 127287, ул. Хуторская 2-я, д. 38А, стр. 26;\ \ а/я 23, г. Москва, 102001" registrationDate: "2002-11-28" opf: "АО" inn: "7710140679" ogrn: "1027739642281" Юридическое лицо, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "UL_NONRESIDENT" name: "TCS Group Holding Plc." phoneNumber: "+74996051110" email: "business.welcome@tinkoff.ru" addresses: - type: "REGISTRATION_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036a" - type: "LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" - type: "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: "5th floor BERENGARIA 25 Spyrou Araouzou 25 Limassol,\ \ Cyprus, 3036" nza: "12345678912" registrationDate: "2015-11-13" registrationNumber: "107963" opf: "Plc." inn: "9909215909" kio: "21590" ИП, резидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_RESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "RU" phoneNumber: "+71378820200" email: "KDDwKOwWD0@Pijg1" documents: - type: "PASSPORT" serial: "5000" number: "287846" date: "1998-01-01" organization: "Отделом УФМС по всем городам всех областей не\ объятной нашей Родины" division: "123-456" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" registrationDate: "2010-01-15" inn: "306707771448" ogrn: "310774601501066" ИП, нерезидент: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "IP_NONRESIDENT" firstName: "Олег" middleName: "Юрьевич" lastName: "Анисимов" birthDate: "1974-01-23" birthPlace: "г. Москва" citizenship: "US" phoneNumber: "+447768027220" email: "OAAQAYkiXe@uUmPe" documents: - type: "FOREIGN_PASSPORT" number: "123456789" date: "1992-02-12" organization: "Issuing organization" - type: "MIGRATION_CARD" number: "123456789" date: "1998-01-01" expireDate: "2023-01-01" addresses: - type: "REGISTRATION_ADDRESS" address: "127287, г. Москва, ул. 2-я Хуторская, д. 38А, стр\ . 26" registrationDate: "2010-01-15" inn: "173527033406" ogrn: "310774601501066" Лёгкий контакт: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" type: "LITE_CONTACT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/scoring: get: tags: - "Бенефициары и реквизиты" summary: "Получить результаты проверки бенефициаров в финансовом мониторинге" description: "\nВозвращает информацию о результатах проверки бенефициаров в\ \ финансовом мониторинге.\n\n\nОграничение на использование метода — 10 за\ просов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsBeneficiariesScoring" parameters: - name: "beneficiaryId" in: "query" description: "\nИдентификатор бенефициара, по которому нужно вернуть резул\ ьтаты проверки.\nЕсли вы не передаёте параметр, возвращаются результаты\ \ по всем бенефициарам." required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" example: "61f656e0-0a86-4ec2-bd43-232499f7ad66" - name: "passed" in: "query" description: "Фильтр по результату проверки — прошёл/не прошёл." required: false style: "form" explode: true schema: type: "boolean" example: true - name: "offset" in: "query" description: "Количество результатов проверки, которое нужно пропустить. З\ начение по умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество результатов проверки, которое нужно вывести. Знач\ ение по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BeneficiaryScoringInfoListResponse" example: offset: 0 limit: 50 size: 2 total: 2 results: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" status: "IN_PROGRESS" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" status: "READY" result: isInnValid: true isPassportValid: false isInBlacklist: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/{beneficiaryId}/bank-details: get: tags: - "Бенефициары и реквизиты" summary: "Получить список банковских реквизитов бенефициара" description: "\nВозвращает информацию о всех банковских реквизитах бенефициа\ ра.\n\n\nОграничение на использование метода — 10 запросов в секунду.\n\n\n\ Чтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsBeneficiariesBeneficiaryidBank-details" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" - name: "offset" in: "query" description: "Количество реквизитов, которое необходимо пропустить. Значен\ ие по умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество реквизитов, которое необходимо вывести. Значение\ \ по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BankDetailsListResponse" example: offset: 0 limit: 50 size: 3 total: 3 results: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "PAYMENT_DETAILS" isDefault: false bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "CARD" isDefault: false cardId: "70000000707" terminalKey: "1573803282696E2C" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "SBP" isDefault: false phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] post: tags: - "Бенефициары и реквизиты" summary: "Создать банковские реквизиты для бенефициара" description: "\nСоздаёт банковские реквизиты для бенефициара и возвращает их\ \ с ID, который нужен для дальнейшего взаимодействия.\n\n\nОграничение на\ \ использование метода — 10 запросов в секунду.\n\n\nС помощью метода можн\ о создать реквизиты типов `PAYMENT_DETAILS`, `CARD` и `SBP`.\nДобавить рек\ визиты типа `CARD` могут только партнёры с сертификатом PCI DSS.\nЧтобы по\ дключиться к методу, напишите на openapi@tinkoff.ru\ \ перед интеграцией.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsBeneficiariesBeneficiaryidBank-details" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/BankDetailsRequest" examples: По реквизитам счёта.: value: type: "PAYMENT_DETAILS" isDefault: true bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" По карте.: value: type: "CARD" isDefault: true terminalKey: "1573803282696E2C" cardData: "ZV5eh9/1JXyBouiDDLpM84dgNBXata7LX/lB1vb8macuJ/bhV8qGe9SzYAsAG8WnmP0G1aNdu4FiLjclzgG1Scn2jJLNex5wM4Acr882QVgV00ZxGAmN3A8su1iVyDWV19Sq7l3WsFWZx2HZPbn8XvkcRHTUHeW528+7pbwSHi/1cTgsqyUpuBrBIz4SaYEVc8Rn57M7YxcdbtR/SAlyInWUUaIAEOJSSJwIQ/35cXLdK/7beLVtIuy2NcjIOnW5yOA1qDRcMiAd+wVhrDb8iZQMf/jPm7a4atlcA+x1z/eaf9gaOXqzDMjtRcFC9/fBsJV+QMMlecmaDhW8ZY1vuA==" Через СБП.: value: type: "SBP" isDefault: true terminalKey: "1573803282696E2C" phoneNumber: "+79001112233" bankId: "100000000004" required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BankDetailsResponse" examples: По карте.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "CARD" isDefault: true cardId: "70000000707" terminalKey: "1573803282696E2C" По реквизитам счёта.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "PAYMENT_DETAILS" isDefault: true bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" Через СБП.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "SBP" isDefault: true phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/{beneficiaryId}/bank-details/{bankDetailsId}: get: tags: - "Бенефициары и реквизиты" summary: "Получить данные банковских реквизитов бенефициара" description: "\nВозвращает информацию о банковских реквизитах бенефициара по\ \ их ID.\n\n\nОграничение на использование метода — 10 запросов в секунду\ .\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsBeneficiariesBeneficiaryidBank-detailsBankdetailsid" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" - name: "bankDetailsId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BankDetailsResponse" examples: По карте.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "CARD" isDefault: true cardId: "70000000707" terminalKey: "1573803282696E2C" По реквизитам счёта.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "PAYMENT_DETAILS" isDefault: true bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" Через СБП.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "SBP" isDefault: true phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] put: tags: - "Бенефициары и реквизиты" summary: "Изменить банковские реквизиты бенефициара" description: "\nПолностью изменяет банковские реквизиты бенефициара по их ID.\ \ Вы можете изменить реквизиты типа `PAYMENT_DETAILS` и `SBP`.\n\n\nОграни\ чение на использование метода — 10 запросов в секунду.\n\n\nЧтобы использо\ вать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "putApiV1Nominal-accountsBeneficiariesBeneficiaryidBank-detailsBankdetailsid" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" - name: "bankDetailsId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/BankDetailsRequest" examples: По реквизитам счёта.: value: type: "PAYMENT_DETAILS" isDefault: true bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" Через СБП.: value: type: "SBP" isDefault: true terminalKey: "1573803282696E2C" phoneNumber: "+79001112233" bankId: "100000000004" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BankDetailsResponse" examples: По реквизитам счёта.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" type: "PAYMENT_DETAILS" isDefault: true bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] delete: tags: - "Бенефициары и реквизиты" summary: "Удалить банковские реквизиты бенефициара" description: "\nУдаляет реквизиты бенефициара по их ID.\n\n\nОграничение на\ \ использование метода — 10 запросов в секунду.\n\n\nЧтобы использовать ме\ тод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "deleteApiV1Nominal-accountsBeneficiariesBeneficiaryidBank-detailsBankdetailsid" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" - name: "bankDetailsId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/{beneficiaryId}/bank-details/{bankDetailsId}/set-default: post: tags: - "Бенефициары и реквизиты" summary: "Установить банковские реквизиты бенефициара по умолчанию" description: "\nВыставляет банковские реквизиты бенефициара как реквизиты по\ \ умолчанию.\n\n\nОграничение на использование метода — 10 запросов в секу\ нду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsBeneficiariesBeneficiaryidBank-detailsBankdetailsidSet-default" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" - name: "bankDetailsId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/{beneficiaryId}/add-card-requests: post: tags: - "Бенефициары и реквизиты" summary: "Создать запрос на добавление реквизитов типа CARD для бенефициара" description: "\nСоздаёт запрос на добавление реквизитов типа `CARD` для бене\ фициара и возвращает его с ID, который нужен для дальнейшего взаимодействи\ я.\n\n\nОграничение на использование метода — 10 запросов в секунду.\n\n\n\ Чтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsBeneficiariesBeneficiaryidAdd-card-requests" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/AddCardRequestRequest" example: terminalKey: "1573803282696E2C" required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AddCardRequestResponse" example: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" addCardRequestId: "49e46893-9a7e-409b-8c79-647aecaae555" terminalKey: "1573803282696E2C" status: "PENDING" addCardUrl: "https://securepay.tinkoff.ru/e2c/f36d8e7f-4bc6-4250-9f64-7fe986d3dc62" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/beneficiaries/{beneficiaryId}/add-card-requests/{addCardRequestId}: get: tags: - "Бенефициары и реквизиты" summary: "Получить запрос на добавление реквизитов типа CARD для бенефициара" description: "\nВозвращает состояние запроса на добавление реквизитов типа `CARD`\ \ для бенефициара.\n\n\nОграничение на использование метода — 10 запросов\ \ в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsBeneficiariesBeneficiaryidAdd-card-requestsAddcardrequestid" parameters: - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" - name: "addCardRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса на добавление карты." responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AddCardRequestResponse" examples: карта в процессе добавления.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" addCardRequestId: "49e46893-9a7e-409b-8c79-647aecaae555" terminalKey: "1573803282696E2C" status: "PENDING" addCardUrl: "https://securepay.tinkoff.ru/e2c/f36d8e7f-4bc6-4250-9f64-7fe986d3dc62" карта успешно добавлена.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" addCardRequestId: "49e46893-9a7e-409b-8c79-647aecaae555" terminalKey: "1573803282696E2C" status: "READY" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" не удалось добавить карту.: value: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" addCardRequestId: "49e46893-9a7e-409b-8c79-647aecaae555" terminalKey: "1573803282696E2C" status: "FAILED" errorMessage: "Внутренняя ошибка системы [9999]" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v2/nominal-accounts/beneficiaries/scoring: get: tags: - "Бенефициары и реквизиты" summary: "Получить результаты проверки бенефициаров в финансовом мониторинге" description: "\nВозвращает информацию о результатах проверки бенефициаров в\ \ финансовом мониторинге:\n\n * Для ФЛ резидентов (FL_RESIDENT) — корректн\ ость паспортных данных, действительность паспорта и проверка по чёрным спи\ скам.\n * Для ИП резидентов (IP_RESIDENT) — корректность паспортных данных\ , действительность паспорта и проверка в ЕГРЮЛ.\n * Для ИП нерезидентов (IP_NONRESIDENT)\ \ — проверка в ЕГРЮЛ.\n * Для ЮЛ резидентов (UL_RESIDENT) — проверка в ЕГР\ ЮЛ.\n\n\nСписок возможных кодов непройденных проверок:\n\n * INVALID_INN —\ \ не пройдена проверка на корректность паспортных данных бенефициара.\n *\ \ INVALID_PASSPORT — не пройдена проверка на действительность паспорта бен\ ефициара.\n * IN_BLACKLIST — бенефициар найден в чёрных списках.\n * UL_CLOSED,\ \ UL_NOT_FOUND — не пройдена проверка бенефициара в ЕГРЮЛ.\n\n\nКритичн\ ые проверки\n\n * INVALID_INN\n * INVALID_PASSPORT\n * UL_CLOSED\n * UL_NOT_FOUND\n\ \n\nКоды всех непройденных критичных проверок вернутся в массиве errors.\n\ \n\n⚠️ Если не пройдена хотя бы одна критичная проверка, итоговый статус б\ удет FAILED.\n\nВыплата с участием такого бенефициара через м\ етод Завершить этап сделки\nили через метод Выполнить платеж в пользу бенефициара на реальный счёт\nне сможет зав\ ершиться успешно, потому что такое лицо не может быть бенефициаром по номи\ нальному счёту.\n\n\nНекритичные проверки\n\n * IN_BLACKLIST\n\n\nК\ оды всех непройденных некритичных проверок вернутся в массиве warnings.\n\ \n\n⚠️ Непрохождение некритичных проверок не влияет на выплаты бенефициара\ м.\n\n\nОграничение на использование метода — 10 запросов в секунду.\n\n\n\ Чтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV2Nominal-accountsBeneficiariesScoring" parameters: - name: "beneficiaryId" in: "query" description: "\nИдентификатор бенефициара, по которому необходимо вернуть\ \ результаты проверки.\nЕсли вы не передаёте параметр, возвращаются резу\ льтаты по всем бенефициарам." required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" example: "61f656e0-0a86-4ec2-bd43-232499f7ad66" - name: "passed" in: "query" description: "Фильтр по результату проверки (прошёл/не прошёл)." required: false style: "form" explode: true schema: type: "boolean" example: true - name: "offset" in: "query" description: "Количество результатов проверки, которое нужно пропустить. З\ начение по умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество результатов проверки, которое нужно вывести. Знач\ ение по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BeneficiaryScoringInfoListResponseV2" example: offset: 0 limit: 50 size: 3 total: 3 results: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" status: "FAILED" - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" status: "SUCCEEDED" warnings: - code: "IN_BLACKLIST" description: "Бенефициар найден в черных списках." - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" status: "FAILED" warnings: - code: "IN_BLACKLIST" description: "Бенефициар найден в черных списках." errors: - code: "INVALID_INN" description: "Данные паспорта физического лица или ИП некоррек\ тны — проверка по ФИО, паспортным данным и дате рождения. По\ пробуйте доуточнить данные.Исключение — случаи, по которым И\ НН нет в принципе. В таком случае обратитесь к сотруднику по\ ддержки, чтобы вам помогли выключить проверку." - code: "INVALID_PASSPORT" description: "Паспорт бенефициара найден в базе недействителен\ ых паспортов — например, истёк срок действия или утерян." - code: "UL_CLOSED" description: "Юридическое лицо или ИП больше не существует (ли\ квидировано). Данный контрагент не может являться бенефициар\ ом по номинальному счёту." - code: "UL_NOT_FOUND" description: "Юридическое лицо или ИП не найдено в ЕГРЮЛ — вер\ оятнее всего, ошибка в ИНН. Заполните данные ещё раз." "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals: get: tags: - "Управление сделками" summary: "Получить список сделок" description: "\nПозволяет получить список сделок компании.\n\n\nОграничение\ \ на использование метода — 10 запросов в секунду.\n\n\nЧтобы использовать\ \ метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsDeals" parameters: - name: "offset" in: "query" description: "Количество сделок, которое нужно пропустить. Значение по умо\ лчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество сделок, которое нужно вывести. Значение по умолча\ нию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DealListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" accountNumber: "40702810110011000777" status: "DRAFT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] post: tags: - "Управление сделками" summary: "Создать сделку" description: "\nПозволяет создать сделку. Вам понадобится номер номинального\ \ счёта.\n\n\nОграничение на использование метода — 10 запросов в секунду\ .\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDeals" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/DealRequest" example: accountNumber: "40702810110011000777" required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DealResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" accountNumber: "40702810110011000777" status: "DRAFT" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/draft: post: tags: - "Управление сделками" summary: "Перевести сделку в черновик" description: "\nПозволяет перевести сделку в статус `DRAFT`. В этом статусе\ \ сделку можно редактировать.\n\n\nОграничение на использование метода — 10\ \ запросов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDealsDealidDraft" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/accept: post: tags: - "Управление сделками" summary: "Подтвердить параметры сделки" description: "\nПозволяет перевести сделку в статус `ACCEPTED` — после `DRAFT`.\n\ \n\nОграничение на использование метода — 10 запросов в секунду.\n\n\nЧтоб\ ы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDealsDealidAccept" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/cancel: post: tags: - "Управление сделками" summary: "Отменить сделку" description: "\nПозволяет перевести сделку в статус `CANCELLED`, чтобы её от\ менить.\n\n\nОграничение на использование метода — 10 запросов в секунду.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDealsDealidCancel" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps: get: tags: - "Управление этапами сделок" summary: "Получить список этапов сделки" description: "\nПозволяет получить список этапов сделки компании.\n\n\nОгран\ ичение на использование метода — 10 запросов в секунду.\n\n\nЧтобы использ\ овать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsDealsDealidSteps" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "offset" in: "query" description: "Количество этапов, которое нужно пропустить. Значение по умо\ лчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество этапов, которое необходимо вывести. Значение по у\ молчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/StepListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" stepNumber: 1 description: "Описание этапа сделки" status: "NEW" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] post: tags: - "Управление этапами сделок" summary: "Создать этап сделки" description: "\nКогда сделка создана, нужно создать этап(-ы) сделки для сове\ ршения финансовых операций.\nЕсли в рамках сделки совершаются только однов\ ременные выплаты, создайте только один этап.\n\n\nОграничение на использов\ ание метода — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен\ \ доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDealsDealidSteps" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/StepRequest" example: description: "Описание этапа сделки" required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/StepResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" stepNumber: 1 description: "Описание этапа сделки" status: "NEW" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}/complete: post: tags: - "Управление этапами сделок" summary: "Завершить этап сделки" description: "\nПозволяет завершить этап для совершения выплат конечным полу\ чателям — реципиентам (recipients),\nкогда все условия сделки выполнены.\n\ \n\nОграничение на использование метода — 10 запросов в секунду.\n\n\nЧтоб\ ы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDealsDealidStepsStepidComplete" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}/deponents/{beneficiaryId}: get: tags: - "Депоненты и реципиенты" summary: "Получить депонента по ID бенефициара" description: "\nПозволяет получить депонента по ID бенефициара.\n\n\nОгранич\ ение на использование метода — 10 запросов в секунду.\n\n\nЧтобы использов\ ать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsDealsDealidStepsStepidDeponentsBeneficiaryid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DeponentResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" amount: 100 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] put: tags: - "Депоненты и реципиенты" summary: "Создать или обновить депонента на этапе сделки" description: "\nПозволяет создать или обновить депонента на этапе сделки. То\ лько для сделок в статусе `DRAFT`.\n\n\nОграничение на использование метод\ а — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "putApiV1Nominal-accountsDealsDealidStepsStepidDeponentsBeneficiaryid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/DeponentRequest" example: amount: 100 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DeponentResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" amount: 100 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] delete: tags: - "Депоненты и реципиенты" summary: "Удалить депонента" description: "\nПозволяет удалить депонента на этапе сделки. Только для сдел\ ок в статусе `DRAFT`.\n\n\nОграничение на использование метода — 10 запрос\ ов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "deleteApiV1Nominal-accountsDealsDealidStepsStepidDeponentsBeneficiaryid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "beneficiaryId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}/deponents: get: tags: - "Депоненты и реципиенты" summary: "Получить всех депонентов этапа" description: "\nПозволяет получить всех депонентов этапа сделки.\n\n\nОграни\ чение на использование метода — 10 запросов в секунду.\n\n\nЧтобы использо\ вать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsDealsDealidStepsStepidDeponents" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "offset" in: "query" description: "Количество депонентов, которое нужно пропустить. Значение по\ \ умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество депонентов, которое нужно вывести. Значение по ум\ олчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DeponentListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" amount: 100 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}/recipients/{recipientId}: get: tags: - "Депоненты и реципиенты" summary: "Получить реципиента по ID реципиента" description: "\nПозволяет получить получателя денежных средств — реципиента\ \ (recipient) по ID реципиента (recipientId).\n\n\nОграничение на использо\ вание метода — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен\ \ доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами.\n\n\nОтдельный recipientId\ \ создаётся для идентификации каждого реципиента, так как один и тот же\nб\ енефициар может использоваться в рамках одного этапа несколько раз." operationId: "getApiV1Nominal-accountsDealsDealidStepsStepidRecipientsRecipientid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "recipientId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор реципиента." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/RecipientResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 90 tax: 5 purpose: "Назначение платежа" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" keepOnVirtualAccount: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] put: tags: - "Депоненты и реципиенты" summary: "Изменить реципиента на этапе сделки" description: "\nПозволяет изменить данные получателя денежных средств — реци\ пиента (recipient) на этапе сделки. Только для сделок в статусе `DRAFT`.\n\ \n\nОграничение на использование метода — 10 запросов в секунду.\n\n\nЧтоб\ ы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами.\n\n\nЕсли вы делаете пер\ евод на реквизиты — укажите `bankDetailsId`. При переводе на виртуальный с\ чёт в рамках номинального счёта\nукажите `keepOnVirtualAccount = true`." operationId: "putApiV1Nominal-accountsDealsDealidStepsStepidRecipientsRecipientid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "recipientId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор реципиента." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/RecipientRequest" example: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" amount: 90 tax: 5 purpose: "Назначение платежа" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" keepOnVirtualAccount: false required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/RecipientResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 90 tax: 5 purpose: "Назначение платежа" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" keepOnVirtualAccount: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] delete: tags: - "Депоненты и реципиенты" summary: "Удалить реципиента" description: "\nПозволяет удалить получателя денежных средств — реципиента (recipient)\ \ на этапе сделки. Только для сделок в статусе `DRAFT`.\n\n\nОграничение н\ а использование метода — 10 запросов в секунду.\n\n\nЧтобы использовать ме\ тод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "deleteApiV1Nominal-accountsDealsDealidStepsStepidRecipientsRecipientid" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "recipientId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор реципиента." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}/recipients: get: tags: - "Депоненты и реципиенты" summary: "Получить всех реципиентов этапа" description: "\nПозволяет получить всех получателей денежных средств — рецип\ иентов (recipients) этапа сделки.\n\n\nОграничение на использование метода\ \ — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsDealsDealidStepsStepidRecipients" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "offset" in: "query" description: "Количество реципиентов, которое нужно пропустить. Значение п\ о умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество реципиентов, которое нужно вывести. Значение по у\ молчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/RecipientListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 90 tax: 5 purpose: "Назначение платежа" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" keepOnVirtualAccount: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] post: tags: - "Депоненты и реципиенты" summary: "Создать реципиента на этапе сделки" description: "\nПозволяет создать получателя денежных средств — реципиента (recipient)\ \ на этапе сделки. Только для сделок в статусе `DRAFT`.\n\n\nОграничение н\ а использование метода — 10 запросов в секунду.\n\n\nЧтобы использовать ме\ тод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами.\n\n\nЕсли вы делаете пер\ евод на реквизиты, укажите `bankDetailsId`. При переводе на виртуальный сч\ ёт в рамках номинального счёта\nукажите `keepOnVirtualAccount = true`." operationId: "postApiV1Nominal-accountsDealsDealidStepsStepidRecipients" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/RecipientRequest" example: beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" amount: 90 tax: 5 purpose: "Назначение платежа" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" keepOnVirtualAccount: false required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/RecipientResponse" example: dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 90 tax: 5 purpose: "Назначение платежа" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" keepOnVirtualAccount: false "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/deals/{dealId}/steps/{stepId}/recipients/{recipientId}/update-bank-details: post: tags: - "Депоненты и реципиенты" summary: "Обновить банковские реквизиты у реципиента на этапе сделки" description: "\nПозволяет обновить банковские реквизиты у получателя денежны\ х средств — реципиента (recipient) при неуспешности платежа.\nТолько для с\ делок в статусе `PAYMENT_FAILED`.\n\n\nОграничение на использование метода\ \ — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsDealsDealidStepsStepidRecipientsRecipientidUpdate-bank-details" parameters: - name: "dealId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор сделки." format: "uuid" - name: "stepId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор этапа сделки." format: "uuid" - name: "recipientId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор реципиента." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateRecipientBankDetailsRequest" example: bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/payments: get: tags: - "Биллинг" summary: "Получить список платежей" description: "\nПозволяет получить список платежей в рамках одной сделки.\n\n\ \nОграничение на использование метода — 10 запросов в секунду.\n\n\nЧтобы\ \ использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsPayments" parameters: - name: "beneficiaryId" in: "query" description: "ID бенефициара." required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" example: "61f656e0-0a86-4ec2-bd43-232499f7ad66" - name: "dealId" in: "query" description: "ID сделки." required: false style: "form" explode: true schema: type: "string" description: "Идентификатор сделки." format: "uuid" example: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" - name: "accountNumber" in: "query" description: "Номер номинального счёта." required: false style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." example: 40702810110011000777 - name: "offset" in: "query" description: "Количество платежей, которое нужно пропустить. Значение по у\ молчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество платежей, которое нужно вывести. Значение по умол\ чанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PaymentListResponse" example: offset: 0 limit: 50 size: 8 total: 8 results: - type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Проверьте номер счёта банка получателя — возможно\ , вы указали неправильные цифры" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "CARD" cardId: "70000000707" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "CARD" cardId: "70000000707" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Transaction not permitted to card" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "SBP" phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "SBP" phoneNumber: "+79001112233" bankId: "100000000004" terminalKey: "1573803282696E2C" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Specified bank is not SBP member" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "TAX" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 status: "SUCCEEDED" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по ис\ полнительному листу от 01.08.2021 по делу N 2-2733/2021" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" - type: "TAX" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 status: "FAILED" errorMessage: "Проверьте номер счёта банка получателя — возможно\ , вы указали неправильные цифры" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по ис\ полнительному листу от 01.08.2021 по делу N 2-2733/2021" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] post: tags: - "Биллинг" summary: "Выполнить платёж в пользу бенефициара на реальный счёт" description: "\nПозволяет напрямую вывести средства с виртуального счёта бен\ ефициара на реальный счёт.\nДля налогового платежа можно указать реквизиты\ \ целиком. Только для типа `PAYMENT_DETAILS`.\n\n\nОграничение на использо\ вание метода — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен\ \ доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsPayments" parameters: - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePaymentRequest1" examples: Обычный платеж.: value: type: "REGULAR" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetailsId: "49e46893-9a7e-409b-8c79-647aecaae555" amount: 100 purpose: "Назначение платежа" Налоговый платеж.: value: type: "TAX" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 purpose: "Сумма налога на имущество, Иванов Иван Иванович, по ис\ полнительному листу от 01.08.2021 по делу N 2-2733/2021" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" required: true responses: "201": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PaymentResponse" examples: Успешный обычный платёж по реквизитам счёта.: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "SUCCEEDED" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Неуспешный обычный платёж по реквизитам счёта.: value: type: "REGULAR" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "044525974" kpp: "773401001" inn: "906858195320" name: "Киняев Фома Семёнович" bankName: "АО \"Тинькофф Банк\"" accountNumber: "11223344556677889900" corrAccountNumber: "30101810145250000974" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" amount: 100 status: "FAILED" errorMessage: "Проверьте номер счёта банка получателя — возмож\ но, вы указали неправильные цифры" purpose: "Назначение платежа" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Успешный налоговый платёж.: value: type: "TAX" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 status: "SUCCEEDED" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по\ \ исполнительному листу от 01.08.2021 по делу N 2-2733/2021" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" Неуспешный налоговый платёж.: value: type: "TAX" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" bankDetails: type: "PAYMENT_DETAILS" bik: "444555666" kpp: "111222333" inn: "1234567890" name: "Какой-то отдел ФНС" bankName: "Чемпион" accountNumber: "11122233344455566677" corrAccountNumber: "12345678901234567890" amount: 100 status: "FAILED" errorMessage: "Проверьте номер счёта банка получателя — возмож\ но, вы указали неправильные цифры" purpose: "Сумма налога на имущество, Иванов Иван Иванович, по\ \ исполнительному листу от 01.08.2021 по делу N 2-2733/2021" uin: "0" tax: payerStatus: "19" kbk: "18210301000011000110" oktmo: "50701000" evidence: "0" period: "0" docNumber: "01;0201251245" docDate: "0" thirdParty: inn: "123456789012" kpp: "0" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/payments/{paymentId}/retry: post: tags: - "Биллинг" summary: "Повторить неуспешный платёж в рамках сделки" description: "\nПозволяет повторить неуспешный платёж в рамках сделки по ID\ \ платежа.\n\n\nОграничение на использование метода — 10 запросов в секунд\ у.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsPaymentsPaymentidRetry" parameters: - name: "paymentId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор платежа." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/RetryPaymentResponse" example: retryPaymentId: "126ffab2-62e9-11ec-bca6-43f40eceb896" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/incoming-transactions: get: tags: - "Биллинг" summary: "Получить список неидентифицированных пополнений" description: "\nПозволяет получить список транзакций пополнения номинального\ \ счёта, которые ещё не прошли идентификацию.\n\n\nОграничение на использо\ вание метода — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен\ \ доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsIncoming-transactions" parameters: - name: "accountNumber" in: "query" description: "Номер номинального счёта." required: false style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." example: 40702810110011000777 - name: "offset" in: "query" description: "Количество неидентифицированных пополнений, которое нужно пр\ опустить. Значение по умолчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество неидентифицированных пополнений, которое нужно вы\ вести. Значение по умолчанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/IncomingTransactionListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - accountNumber: "40702810110011000777" operationId: "171f9b1f-9f7c-4d7d-b6b3-4bf4a1d6cc7d" amount: 7500 currency: "643" operationAmount: 100 operationCurrency: "840" payerBik: "044525974" payerKpp: "773401001" payerInn: "906858195320" payerBankName: "АО \"Тинькофф Банк\"" payerBankSwiftCode: "TICSRUMMXXX" payerAccountNumber: "40802810300002711854" payerCorrAccountNumber: "30101810145250000974" payerName: "Киняев Фома Семёнович" paymentPurpose: "Назначение платежа" documentNumber: "287846" chargeDate: "2022-01-20T14:10:56Z" authorizationDate: "2022-01-20T14:10:56Z" transactionDate: "2022-01-20T14:10:56Z" drawDate: "2022-01-20T14:10:56Z" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/incoming-transactions/{operationId}/identify: post: tags: - "Биллинг" summary: "Идентифицировать пополнение" description: "\nПозволяет идентифицировать одну из операций пополнения.\n\n\n\ Ограничение на использование метода — 10 запросов в секунду.\n\n\nЧтобы ис\ пользовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "postApiV1Nominal-accountsIncoming-transactionsOperationidIdentify" parameters: - name: "operationId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "ID операции пополнения." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/IdentifyIncomingTransactionRequest" example: amountDistribution: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" amount: 100 - beneficiaryId: "75c0d3c4-1a5b-11ec-8669-0326f772aecb" amount: 50 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/virtual-accounts/balances: get: tags: - "Биллинг" summary: "Получить информацию по остаткам на виртуальных счетах бенефициаров" description: "\nПозволяет получить список балансов бенефициаров по одному ил\ и нескольким виртуальным счетам\nв рамках номинального счёта.\n\n\nОгранич\ ение на использование метода — 10 запросов в секунду.\n\n\nЧтобы использов\ ать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsVirtual-accountsBalances" parameters: - name: "accountNumber" in: "query" description: "Номер номинального счёта." required: false style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." example: 40702810110011000777 - name: "beneficiaryId" in: "query" description: "ID бенефициара." required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" example: "61f656e0-0a86-4ec2-bd43-232499f7ad66" - name: "offset" in: "query" description: "Количество балансов, которое нужно пропустить. Значение по у\ молчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество балансов, которое нужно вывести. Значение по умол\ чанию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BalanceListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" amount: 7500 amountOnHold: 1000 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/nominal-accounts/virtual-accounts/holds: get: tags: - "Биллинг" summary: "Получить информацию по холдам на виртуальных счетах бенефициаров" description: "\nПозволяет получить список холдов на виртуальных счетах бенеф\ ициаров в рамках номинального счёта.\n\n\nОграничение на использование мет\ ода — 10 запросов в секунду.\n\n\nЧтобы использовать метод, нужен доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nominal-accounts/manage\ \ — Управление номинальными счетами." operationId: "getApiV1Nominal-accountsVirtual-accountsHolds" parameters: - name: "accountNumber" in: "query" description: "Номер номинального счёта." required: false style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." example: 40702810110011000777 - name: "beneficiaryId" in: "query" description: "ID бенефициара." required: false style: "form" explode: true schema: type: "string" description: "Идентификатор бенефициара." format: "uuid" example: "61f656e0-0a86-4ec2-bd43-232499f7ad66" - name: "offset" in: "query" description: "Количество холдов, которое нужно пропустить. Значение по умо\ лчанию — 0." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно пропустить." format: "int32" example: 0 - name: "limit" in: "query" description: "Количество холдов, которое нужно вывести. Значение по умолча\ нию — 50." required: false style: "form" explode: true schema: type: "integer" description: "Количество элементов в списке, которое нужно вывести." format: "int32" example: 50 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/HoldListResponse" example: offset: 0 limit: 50 size: 1 total: 1 results: - beneficiaryId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" accountNumber: "40702810110011000777" holdId: "7540c2ca-2373-472a-a099-7756475484a9" dealId: "dd6c3237-9958-47d9-9ba0-f6faeaa0e788" stepId: "c87d3297-f4ae-4f88-add9-6722c1fc0b8c" recipientId: "00021d4e-536f-11ec-ac0b-370ccfeacec2" paymentId: "58097aa1-9660-47e7-8550-f2167fa80cea" amount: 100 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/tacq/operations/terminal/{terminalKey}: get: tags: - "Торговый эквайринг" summary: "Получить операции по терминалу за период" description: "Метод возвращает список операций и информацию по ним за указан\ ный период. Значение суммы операции возвращается в копейках.\n\n\nЧтобы ис\ пользовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/tacq/operations/get\ \ — Получение операций по терминалам торгового эквайринга.\n\n\ \nЗапросы с количеством операций более 1000 или периодом более одного дня\ \ не поддерживаются — вернётся ошибка. Задержка получения операций может с\ оставлять до двух часов.\n\n\nОграничение на использование метода — 1 запр\ ос в секунду.\n " operationId: "getApiV1TacqOperationsTerminalTerminalkey" parameters: - name: "terminalKey" in: "path" description: "Серийный номер терминала." required: true style: "simple" explode: false schema: type: "string" example: "7L594999" - name: "from" in: "query" description: "Дата начала периода в формате UTC." required: true style: "form" explode: true schema: type: "string" format: "date-time" example: "2015-12-12T13:10:10Z" - name: "till" in: "query" description: "Дата окончания периода в формате UTC." required: true style: "form" explode: true schema: type: "string" format: "date-time" example: "2015-12-13T12:10:10Z" - name: "limit" in: "query" description: "Максимальное количество операций." required: true style: "form" explode: true schema: maximum: 1000 type: "integer" format: "int64" example: 1000 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TacqOperationResponse" example: lastTransactionDate: "2020-10-20T13:10:09Z" operations: - rrn: "999999999999" transactionDate: "2020-10-20T13:10:09Z" amount: 1000 cardNumber: "999999xxxxxx9999" type: "Debit" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/tacq/terminals: get: tags: - "Торговый эквайринг" summary: "Получить терминалы по компании" description: "Метод возвращает информацию по активным терминалам компании —\ \ полностью подготовленным и готовым проводить платежи. Пользователь долже\ н дать согласие на получение списка терминалов компании.\n\n\nЧтобы исполь\ зовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/tacq/terminals/get\ \ — Получение информации о терминалах компании торгового эквайринга\ .\n\n\nОграничение на использование метода — 1 запрос в секунду." operationId: "getApiV1TacqTerminals" parameters: - name: "page" in: "query" description: "Номер возвращаемой страницы с данными по терминалам. Нумерац\ ия с нуля." required: true style: "form" explode: true schema: type: "integer" format: "int64" example: 1 - name: "size" in: "query" description: "Размер страницы (количество терминалов) с данными." required: true style: "form" explode: true schema: type: "integer" format: "int64" example: 10 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TacqTerminalsResponse" example: totalPages: 3 totalElements: 15 first: false last: true terminals: - key: "6K417293" id: "10056003" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/card/{ucid}/limits: get: tags: - "Бизнес-карты" summary: "Получить установленные лимиты по карте и доступный карточный остат\ ок" description: "Метод возвращает информацию о расходном лимите и лимите на сня\ тие наличных.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/limit/get\ \ — Получение информации о лимитах и остатках по картам компании.\n\ \n\nОграничение на использование метода — 40 запросов в секунду." operationId: "getApiV1CardUcidLimits" parameters: - name: "ucid" in: "path" description: "Уникальный идентификатор карты." required: true style: "simple" explode: false schema: type: "integer" format: "int64" example: 1074372738 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CardLimitsResponse" example: ucid: 1074372738 spendLimit: limitValue: 9001 limitRemain: 7000 limitPeriod: "IRREGULAR" cashLimit: limitValue: 5000 limitRemain: 3000 limitPeriod: "DAY" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/{ucid}/spend-limit: post: tags: - "Бизнес-карты" summary: "Установить расходный лимит по карте" description: "Метод для установки лимита и периода обновления доступного ост\ атка.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/limit/set\ \ — Изменение лимитов по картам компании.\n\n\nОграничение на\ \ использование метода — 10 запросов в секунду." operationId: "postApiV1CardUcidSpend-limit" parameters: - name: "ucid" in: "path" description: "Уникальный идентификатор карты." required: true style: "simple" explode: false schema: type: "integer" format: "int64" example: 1074372738 requestBody: content: application/json: schema: $ref: "#/components/schemas/SetLimitRequest" example: limitValue: 9001 limitPeriod: "IRREGULAR" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/{ucid}/cash-limit: post: tags: - "Бизнес-карты" summary: "Установить лимит на снятие наличных по карте" description: "Метод для установки лимита и периода обновления доступного ост\ атка.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/limit/set\ \ — Изменение лимитов по картам компании.\n\n\nОграничение на\ \ использование метода — 10 запросов в секунду." operationId: "postApiV1CardUcidCash-limit" parameters: - name: "ucid" in: "path" description: "Уникальный идентификатор карты." required: true style: "simple" explode: false schema: type: "integer" format: "int64" example: 1074372738 requestBody: content: application/json: schema: $ref: "#/components/schemas/SetLimitRequest" example: limitValue: 5000 limitPeriod: "DAY" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/{ucid}/block: post: tags: - "Бизнес-карты" summary: "Заблокировать бизнес-карту" description: "Метод позволяет заблокировать любую бизнес-карту компании, нез\ ависимо от её владельца.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/block\ \ — Блокировка любой карты компании, независимо от её владельца.\n\ \n\nОграничение на использование метода — 5 запросов в секунду." operationId: "postApiV1CardUcidBlock" parameters: - name: "ucid" in: "path" description: "Уникальный идентификатор карты." required: true style: "simple" explode: false schema: type: "integer" format: "int64" example: 1074372738 requestBody: content: application/json: schema: $ref: "#/components/schemas/BlockCardRequest" example: reason: "CLIENTINITIATED" comment: "Сотрудник покинул компанию" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/{ucid}: get: tags: - "Бизнес-карты" summary: "Получить данные по одной карте компании" description: "Метод для получения данный по карте компании — имя держателя,\ \ уникальный идентификатор карты, статус карты, BIN карты, номер расчётног\ о счёта, к которому привязана карта.\n\n\nПользователь должен дать согласи\ е на получение информации о картах компании.\n\n\nЧтобы использовать метод\ , нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/get — П\ олучение информации о картах компании.\n\n\nОграничение на использо\ вание метода — 10 запросов в секунду." operationId: "getApiV1CardUcid" parameters: - name: "ucid" in: "path" description: "Уникальный идентификатор карты." required: true style: "simple" explode: false schema: type: "integer" format: "int64" example: 1074372738 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CardInfoResponse" example: ucid: 1074372738 accountNumber: "40702810110011000777" cardBin: "553420" cardLastFourDigits: "2781" isActive: true status: "NORM" embossedName: "IVAN IVANOV" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/card: get: tags: - "Бизнес-карты" summary: "Получить данные по картам компании" description: "Метод для получения данных по картам компании. Пользователь до\ лжен дать согласие на получение информации о картах компании.\n\n\nЧтобы и\ спользовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/get\ \ — Получение информации о картах компании." operationId: "getApiV1Card" parameters: - name: "accountNumber" in: "query" description: "Номер расчётного счёта, к которому привязана карта." required: false style: "form" explode: true schema: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." example: 40702810110011000777 - name: "offset" in: "query" description: "Количество карт, которые нужно пропустить. Значение по умолч\ анию — `0`." required: false style: "form" explode: true schema: type: "integer" format: "int32" example: 0 - name: "limit" in: "query" description: "Количество карт, которые нужно вывести. Значение по умолчани\ ю — `1000`." required: false style: "form" explode: true schema: type: "integer" format: "int32" example: 1000 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CardInfoSeqResponse" example: cards: - ucid: 1074372738 accountNumber: "40702810110011000777" cardBin: "553420" cardLastFourDigits: "2781" isActive: true status: "NORM" embossedName: "IVAN IVANOV" offset: 0 limit: 1 totalNumber: 2 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/card/virtual/{ucid}/requisites: get: tags: - "Бизнес-карты" summary: "Получить полные немаскированные реквизиты виртуальной карты" description: "Метод для получения полных немаскированных реквизитов виртуаль\ ной карты — номер, имя держателя, CVC, срок действия карты.\n\n\nПользоват\ ель должен дать согласие на получение полных немаскированных реквизитов ви\ ртуальных карт компании.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/virtual/requisites\ \ — Получение полных немаскированных реквизитов виртуальных карт ком\ пании.\n\n\nОграничение на использование метода — 10 запросов в сек\ унду." operationId: "getApiV1CardVirtualUcidRequisites" parameters: - name: "ucid" in: "path" description: "Уникальный идентификатор карты." required: true style: "simple" explode: false schema: type: "integer" format: "int64" example: 1074372738 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/VirtualCardRequisitesResponse" example: number: "1111222233334444" embossedName: "IVAN IVANOV" cvc: "123" expiryDate: year: 2022 month: 5 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/virtual/reissue: post: tags: - "Бизнес-карты" summary: "Отправить заявку на перевыпуск виртуальной карты" description: "Метод для отправки заявки на перевыпуск виртуальной карты. Пол\ ьзователь должен дать согласие на перевыпуск виртуальных карт компании.\n\n\ \nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/virtual/reissue\ \ — Перевыпуск виртуальных карт компании.\n\n\nОграничение на\ \ использование метода — 10 запросов в секунду." operationId: "postApiV1CardVirtualReissue" requestBody: content: application/json: schema: $ref: "#/components/schemas/ReissueVirtualCardRequest" example: ucid: 1074372738 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ReissueVirtualCardResponse" example: correlationId: "24166fc5-ae8a-412a-8eb0-2e86d3c8dc73" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/virtual/reissue/result: get: tags: - "Бизнес-карты" summary: "Получить статус заявки на перевыпуск виртуальной карты" description: "Метод возвращает статус заявки на перевыпуск виртуальной карты\ . Пользователь должен дать согласие на перевыпуск виртуальных карт компани\ и.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/card/virtual/reissue\ \ — Перевыпуск виртуальных карт компании.\n " operationId: "getApiV1CardVirtualReissueResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор заявки на перевыпуск виртуальной карты." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "24166fc5-ae8a-412a-8eb0-2e86d3c8dc73" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ReissueVirtualCardResultResponse" examples: Заявка находится в работе: value: status: "IN_PROGRESS" Заявка была исполнена, карта перевыпущена: value: status: "READY" info: oldUcid: 1074372738 newUcid: 1095637483 cardBin: "553420" cardLastFourDigits: "2781" Произошла ошибка при обработке заявки: value: status: "ERROR" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/virtual/issue/application: post: tags: - "Бизнес-карты" summary: "Создать заявку на выпуск виртуальной бизнес-карты с удалённой иден\ тификацией сотрудника" description: "Метод создаёт заявку на выпуск виртуальной бизнес-карты на сот\ рудника и в случае успеха отдаёт её ID,\nс помощью которого можно проверят\ ь статус заявки. Чтобы использовать метод,\nподготовьте данные для удалённ\ ой идентификации сотрудника через вызов соответствующих методов.\n\n\nПоль\ зователь должен дать согласие на выпуск виртуальных бизнес-карт на сотрудн\ иков компании.\n\n\nВ поле `scope` у токена должен присутствовать доступ в\ ида `opensme/inn/[{inn}]/kpp/[{kpp}]/card/virtual/issue/for-employee`, где\ \ {inn} — ИНН клиента, а {kpp} — КПП клиента.\n\n\nОграничение на использо\ вание метода — 10 запросов в секунду." operationId: "postApiV1CardVirtualIssueApplication" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateApplicationRequest" example: employeeIdentificationApplicationId: "1713e109-31e4-4eed-b804-2c0cb8ef6ef3" accountNumber: "40702810110011000777" cardNetwork: "MASTERCARD" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateApplicationResponse" example: cardIssueApplicationId: "4e954a4f-19dc-4bd5-9a84-aef64e9d71ce" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/card/virtual/issue/application/{cardIssueApplicationId}: get: tags: - "Бизнес-карты" summary: "Получить статус заявки на выпуск виртуальной бизнес-карты с удалён\ ной идентификацией сотрудника" description: "Метод возвращает статус заявки на выпуск виртуальной бизнес-ка\ рты на сотрудника.\n\n\nЕсли карта уже выпущена, кроме статуса в ответе во\ звращается UCID выпущенной карты.\nЕсли выпуск карты неуспешен, кроме стат\ уса в ответе возвращается причина неудачного выпуска.\n\n\nПользователь до\ лжен дать согласие на выпуск виртуальных бизнес-карт на сотрудников компан\ ии.\n\n\nВ поле `scope` у токена должен быть доступ вида `opensme/inn/[{inn}]/kpp/[{kpp}]/card/virtual/issue/for-employee`,\n\ где {inn} — ИНН клиента, а {kpp} — КПП клиента.\n\n\nОграничение на исполь\ зование метода — 10 запросов в секунду.\"" operationId: "getApiV1CardVirtualIssueApplicationCardissueapplicationid" parameters: - name: "cardIssueApplicationId" in: "path" description: "Идентификатор заявки на выпуск бизнес-карты." required: true style: "simple" explode: false schema: type: "string" format: "uuid" example: "6bcbca1f-b01d-4796-88bb-d4e868c07a68" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CardIssueApplicationStatusResponse" example: cardIssueApplicationId: "6bcbca1f-b01d-4796-88bb-d4e868c07a68" status: "IDENTIFICATION" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/employee-remote-identification/application: post: tags: - "Удалённая идентификация сотрудников" summary: "Создать черновик заявки на удалённую идентификацию сотрудника" description: "Метод создаёт черновик заявки на удалённую идентификацию сотру\ дника.\n\n\nЧерновик действителен 30 минут — за это время вы прикрепляете\ \ к нему документы и отправляете в работу.\n\n\nПользователь должен дать с\ огласие на удалённую идентификацию сотрудников.\nВ поле scope у токена дол\ жен быть доступ вида `opensme/inn/[{inn}]/kpp/[{kpp}]/employee-remote-identification`,\ \ где {inn} — ИНН клиента, а {kpp} — КПП клиента.\n\n\nОграничение на испо\ льзование метода — 10 запросов в секунду." operationId: "postApiV1Employee-remote-identificationApplication" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateDraftRequest" example: lastName: "Петров" firstName: "Иван" secondName: "Сергеевич" birthDate: "1980-04-15" placeOfBirth: "г. Москва РСФСР СССР" phoneNumber: "+79991234567" passport: series: "1234" number: "567890" issuerName: "ОВД Чистые Пруды" issuerCode: "000-123" issueDate: "2000-04-25" registrationAddress: zipCode: "312098" country: "РОССИЯ" region: "г МОСКВА" city: "Москва" settlement: "ЦАО" street: "Большая Садовая ул" house: "12" apartment: "50" actualAddress: zipCode: "125212" country: "РОССИЯ" region: "г МОСКВА" city: "Москва" settlement: "СЗАО" street: "Головинское шоссе" house: "5" building: "1" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateDraftResponse" example: applicationId: "1713e109-31e4-4eed-b804-2c0cb8ef6ef3" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/employee-remote-identification/application/{applicationId}/{documentType}: post: tags: - "Удалённая идентификация сотрудников" summary: "Добавить скан или фото документа к заявке на удалённую идентификац\ ию сотрудника" description: "Метод прикрепляет скан или фото документа к заявке на удалённу\ ю идентификацию сотрудника. Последовательными вызовами этого метода\nприкр\ епляются изображения всех нужных страниц паспорта через `documentType=PASSPORT`,\n\ а также фото с паспортом в руках через `documentType=SELFIE_WITH_PASSPORT`,\ \ чтобы заявку можно было запустить в работу.\n\n\nЕсли подаётся заявка на\ \ ранее идентифицированного сотрудника, повторно прикреплять фото документ\ ов к заявке не нужно.\n\n\nПользователь должен дать согласие на удалённую\ \ идентификацию сотрудников.\nВ поле `scope` у токена должен быть доступ в\ ида `opensme/inn/[{inn}]/kpp/[{kpp}]/employee-remote-identification`, где\ \ {inn} — ИНН клиента, а {kpp} — КПП клиента.\n\n\nОграничение на использо\ вание метода — 1 запрос в секунду." operationId: "postApiV1Employee-remote-identificationApplicationApplicationidDocumenttype" parameters: - name: "applicationId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "ID заявки на удалённую идентификацию сотрудника." format: "uuid" - name: "documentType" in: "path" description: "Тип фото для загрузки." required: true style: "simple" explode: false schema: $ref: "#/components/schemas/DocumentType2" example: "SELFIE_WITH_PASSPORT" - name: "Content-Length" in: "header" description: "Размер загружаемого скана или фото документа в байтах." required: true style: "simple" explode: false schema: maximum: 5242880 minimum: 1 type: "integer" format: "int64" requestBody: description: "Скан или фото документа в формате `JPEG`, `PNG` или `PDF`." content: application/octet-stream: schema: type: "string" format: "binary" required: true responses: "200": description: "Скан или фото документа добавлено к заявке." headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/tasks: post: tags: - "Партнёрская доставка" summary: "Создать задание на доставку" description: "\nМетод создаёт задание и возвращает его ID в ответе для дальн\ ейшего взаимодействия.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/create\ \ — Создание задания на доставку.\n\n\nОграничение на использ\ ование метода — 10 запросов в секунду" operationId: "DeliveryCreateTask" parameters: - name: "Idempotency-Key" in: "header" required: false style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateTaskRequest" example: template: "PartnerDelivery" commentForAgent: "Проверить паспорт" parentTaskId: "39df83a3-edc7-4c83-ba53-9eaae38c225f" meta: dealNumber: "456793" contacts: - id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" role: "Риэлтор" firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1990-05-05" phones: - type: "MOBILE" number: "+79546523687" documents: - type: "PASSPORT" number: "123467" series: "3456" divisionName: "УВД Раменского района" issueDate: "1990-05-05" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateTaskResponse" example: id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/tasks/{id}/cancel: post: tags: - "Партнёрская доставка" summary: "Отменить задание на доставку" description: "Метод для отмены задания. После отмены дальнейшая работа по за\ данию не производится.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/create\ \ — Создание задания на доставку." operationId: "DeliveryCancelTask" parameters: - name: "id" in: "path" description: "Идентификатор задания." required: true style: "simple" explode: false schema: type: "string" example: "39df83a3-edc7-4c83-ba53-9eaae38c225f" requestBody: content: application/json: schema: $ref: "#/components/schemas/CancelTaskRequest" example: reason: "Отказ клиента" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/tasks/{id}: get: tags: - "Партнёрская доставка" summary: "Получить информацию по заданию на доставку" description: "\nМетод возвращает информацию о текущем состоянии задания.\nЧт\ обы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/create\ \ — Создание задания на доставку.\n" operationId: "DeliveryGetTask" parameters: - name: "id" in: "path" description: "Идентификатор задания." required: true style: "simple" explode: false schema: type: "string" example: "39df83a3-edc7-4c83-ba53-9eaae38c225f" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DeliveryTask" example: id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" status: "NEW" template: "partner_delivery" meetResult: "Успешная встреча" resolution: "Документы подписаны" subResolution: "Подписан договор аренды" parentTaskId: "39df83a3-edc7-4c83-ba53-9eaae38c225f" meta: dealNumber: "456793" attachments: - id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" type: "Договор аренды" meta: cadastreNumber: "77:997987687" noticeNumber: "123-456789" photos: - id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" type: "Паспорт" subType: "Страница регистрации" sheetNumber: 1 review: status: "DISCARDED" decisionSource: "service" decisionReason: - "stranger" - "from-screen" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] put: tags: - "Партнёрская доставка" summary: "Обновить задание на доставку" description: "\nМетод позволяет обновить уже созданное задание по его ID. Ес\ ли вызов успешный, в ответе возвращается ошибка или пустой объект.\n\n\nЧт\ обы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/update\ \ — Обновление задания на доставку.\n" operationId: "DeliveryUpdateTask" parameters: - name: "id" in: "path" description: "Идентификатор задания." required: true style: "simple" explode: false schema: type: "string" example: "39df83a3-edc7-4c83-ba53-9eaae38c225f" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateTaskRequest" example: template: "PartnerDelivery" commentForAgent: "Проверить паспорт" parentTaskId: "39df83a3-edc7-4c83-ba53-9eaae38c225f" meta: dealNumber: "456793" contacts: - id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" role: "Риэлтор" firstName: "Иван" lastName: "Иванов" middleName: "Иванович" birthDate: "1990-05-05" phones: - type: "MOBILE" number: "+79546523687" documents: - type: "PASSPORT" number: "123467" series: "3456" divisionName: "УВД Раменского района" issueDate: "1990-05-05" photos: - id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" review: status: "ACCEPTED" - id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" review: status: "DISCARDED" decisionReason: - "всё очень плохо" - "могло бы быть и лучше" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/meetings/intervals: post: tags: - "Партнёрская доставка" summary: "Получить доступные временные интервалы для назначения встречи" description: "Метод позволяет получить доступные временные интервалы для наз\ начения встреч. Временной интервал — промежуток времени, в который может б\ ыть проведена встреча.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/create\ \ — Создание задания на доставку." operationId: "DeliveryGetIntervals" requestBody: content: application/json: schema: $ref: "#/components/schemas/GetIntervalsRequest" example: taskIds: - "39df83a3-edc7-4c83-ba53-9eaae38c225f" address: fullAddress: "г. Москва, 3-я улица Строителей, д.25, кв.12" zipCode: "1234" country: "Россия" region: "Москва" area: "Москва" city: "Москва" street: "3-я улица Строителей" house: "12" building: "3" flat: "12" construction: "2" settlement: "" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/GetIntervalsResponse" example: appointmentId: "39df83a3-edc7-4c83-ba53-9eaae38c225f" timeOffset: "+03:00" intervals: - startInterval: "2021-10-19T10:00" endInterval: "2021-10-19T12:00" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/meetings: post: tags: - "Партнёрская доставка" summary: "Назначить встречу" description: "Метод позволяет подтвердить временной интервал из списка, полу\ ченного через метод получения интервалов, и назначить на него встречу для\ \ заданий.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/tasks/create\ \ — Создание задания на доставку." operationId: "DeliveryCreateMeeting" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateMeetingRequest" example: appointmentId: "39df83a3-edc7-4c83-ba53-9eaae38c225f" intervalStartTime: "2020-11-23T10:00" intervalEndTime: "2020-11-23T10:00" commentForAgent: "Test comment" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CreateMeetingResponse" example: meetingId: "39df83a3-edc7-4c83-ba53-9eaae38c225f" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/documents: post: tags: - "Партнёрская доставка" summary: "Загрузить документ к заданию" description: "Метод позволяет загрузить документ и его метаданные и привязат\ ь документ к заданию.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/documents/create\ \ — Загрузка документа в задание на доставку.\n\n\nОграничени\ е на использование метода — 10 запросов в секунду." operationId: "postApiV1DeliveryDocuments" requestBody: content: multipart/form-data: schema: required: - "content" - "taskId" - "type" type: "object" properties: taskId: type: "string" description: "ID задания, с которым нужно связать документ." type: type: "string" description: "Тип документа." content: type: "string" description: "Состав документа, который нужно загрузить и связат\ ь с заданием." format: "binary" prevDocId: type: "string" description: "ID предыдущего документа. Нужен, чтобы обновить уж\ е загруженный документ." description: type: "string" description: "Описание документа. Содержит дополнительную информ\ ацию, которая нужна для взаимодействия с ним." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON." required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/UploadTaskFileResponse" example: id: "39df83a3-edc7-4c83-ba53-9eaae38c225f" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/delivery/documents/{id}: get: tags: - "Партнёрская доставка" summary: "Выгрузить документ по ID" description: "Метод позволяет выгрузить документ по его ID.\n\n\nЧтобы испол\ ьзовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/delivery/documents/create\ \ — Загрузка документа в задание на доставку." operationId: "getApiV1DeliveryDocumentsId" parameters: - name: "id" in: "path" description: "Идентификатор документа." required: true style: "simple" explode: false schema: type: "string" example: "f123" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/octet-stream: schema: type: "string" format: "binary" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/loyalty/offers/active: get: tags: - "Cпецпредложения и кэшбэк" summary: "Получить все активные доступные спецпредложения" description: "\nМетод для получения списка всех активных офферов с неперсона\ лизированной информацией по ним.\n\n\nВ поле `scopes` у токена должен быть\ \ доступ вида\n`opensme/inn/[{inn}]/kpp/[{kpp}]/loyalty/offers/active`, гд\ е {inn} — ИНН клиента, а {kpp} — КПП клиента." operationId: "getApiV1LoyaltyOffersActive" parameters: - name: "test" in: "query" description: "Если передается 'true', то будут использоваться тестовые дан\ ные. Иначе продовые." required: false style: "form" explode: true schema: type: "boolean" example: true - name: "offset" in: "query" description: "На данный момент не учитывается. Отдаются все элементы. Сдви\ г от начала списка офферов." required: false style: "form" explode: true schema: type: "integer" format: "int32" example: 0 - name: "limit" in: "query" description: "На данный момент не учитывается. Отдаются все элементы. Кол\ -во офферов на странице." required: false style: "form" explode: true schema: type: "integer" format: "int32" example: 1000 responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ActiveOffersResponse" example: data: - id: 12895 openDate: "2020-11-23T00:00:00.001+03:00" closeDate: "2021-02-28T00:00:00.001+03:00" advert: title: "10 месяцев" text: "Рекламный текст." textFormatted: "

Форматированный текст. Форматирован\ ный текст.

" boundMoneyMax: 0 boundMoneyMin: 0 topBorder: 0 cashbackAmount: 0 cashbackPercent: 0 numberOfRealised: 0 single: false adultsOnly: false offerType: "SPECIAL_CREDIT" merchantName: "Магазин" web: "https://www.shop.ru/" merchantSubcategory: "Электроника" onlineSale: false merchantCategories: [] image280: "https://samplecdn.ru/123.png" image1252: "https://samplecdn.ru/1233.png" image626: "https://samplecdn.ru/12345.png" disableAutoCharge: false - id: 9993 openDate: "2019-10-25T00:00:00.001+03:00" closeDate: "2021-11-12T00:00:00.001+03:00" advert: text: "Рекламный текст" textFormatted: "

Форматированный текст

" boundMoneyMax: 0 boundMoneyMin: 0 cashbackAmount: 0 cashbackPercent: 10 numberOfRealised: 0 single: false adultsOnly: true offerType: "STANDARD" merchantName: "Онлайн Магазин" web: "https://onlineshop.ru/" onlineSale: true merchantCategories: [] image280: "https://samplecdn.ru/321.png" image1252: "https://samplecdn.ru/3321.png" image626: "https://samplecdn.ru/54321.png" daysForCharge: 7 disableAutoCharge: true "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/loyalty/offers/client: post: tags: - "Cпецпредложения и кэшбэк" summary: "Получить все спецпредложения, доступные клиенту" description: "\nМетод для получения списка всех офферов, доступных клиенту.\n\ \n\nВ поле `scopes` у токена должен быть доступ вида\n`opensme/inn/[{inn}]/kpp/[{kpp}]/loyalty/offers/client`,\ \ где {inn} — ИНН клиента, а {kpp} — КПП клиента." operationId: "postApiV1LoyaltyOffersClient" parameters: - name: "test" in: "query" description: "Если передается 'true', то будут использоваться тестовые дан\ ные. Иначе продовые." required: false style: "form" explode: true schema: type: "boolean" example: true - name: "offset" in: "query" description: "На данный момент не учитывается. Отдаются все элементы. Сдви\ г от начала списка офферов." required: false style: "form" explode: true schema: type: "integer" format: "int32" example: 0 - name: "limit" in: "query" description: "На данный момент не учитывается. Отдаются все элементы. Кол\ -во офферов на странице." required: false style: "form" explode: true schema: type: "integer" format: "int32" example: 1000 requestBody: content: application/json: schema: $ref: "#/components/schemas/ClientOffersRequest" example: phoneNumber: "79990001122" region: "02" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ClientOffersResponse" example: data: - id: 15872 cbAmount: 0 cbPercent: 50 countOfRealised: 0 viewDate: "2021-02-03T00:00:00.001+03:00" weight: 0 merchantCategories: - categoryId: 18 categoryWeight: 82 merchantCategoryWeight: 0 - categoryId: 602 categoryWeight: 290 merchantCategoryWeight: 0 - categoryId: 617 categoryWeight: 100 merchantCategoryWeight: 0 - id: 9987 cbAmount: 0 cbPercent: 20 countOfRealised: 2 viewDate: "2019-10-25T00:00:00.001+03:00" weight: 10 merchantCategories: - categoryId: 18 categoryWeight: 82 merchantCategoryWeight: 50 - categoryId: 395 categoryWeight: 99 merchantCategoryWeight: 100 web: "http://example.ru/ru/" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/loyalty/offers/view: post: tags: - "Cпецпредложения и кэшбэк" summary: "Зафиксировать просмотр оффера клиентом" description: "\nВ поле `scopes` у токена должен быть доступ вида\n`opensme/inn/[{inn}]/kpp/[{kpp}]/loyalty/offers/view`,\ \ где {inn} — ИНН клиента, а {kpp} — КПП клиента." operationId: "postApiV1LoyaltyOffersView" parameters: - name: "test" in: "query" description: "Если передается 'true', то будут использоваться тестовые дан\ ные. Иначе продовые." required: false style: "form" explode: true schema: type: "boolean" example: true requestBody: content: application/json: schema: $ref: "#/components/schemas/OfferViewRequest" example: phoneNumber: "79990001122" offerId: 123242442 required: true responses: "200": description: "Просмотр оффера клиентом зафиксирован" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/loyalty/receipt: post: tags: - "Cпецпредложения и кэшбэк" summary: "Отправить чек на обработку" description: "\nМетод обрабатывает чек и возвращает информацию о начислениях\ \ или 202 HTTP-код с пустым телом ответа, если обработка запланирована.\n\n\ \nВ поле `scopes` у токена должен присутствовать scope вида:\n`opensme/inn/[{inn}]/kpp/[{kpp}]/loyalty/receipt`,\ \ где {inn} — ИНН клиента, а {kpp} — КПП клиента." operationId: "postApiV1LoyaltyReceipt" parameters: - name: "test" in: "query" description: "Если передается 'true', то будут использоваться тестовые дан\ ные. Иначе продовые." required: false style: "form" explode: true schema: type: "boolean" example: true requestBody: content: application/json: schema: $ref: "#/components/schemas/SendReceiptRequest" example: phoneNumber: "79990001122" qrCodeAsString: "t=20210115T1715&s=312.00&fn=9287440300782352&i=12747&fp=3093752358&n=1" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ImmediateReceiptResponse" example: totalBalance: 123.4 cashbackAmount: 77.1 accruals: - offerId: 123 cashbackAmount: 56.7 newResult: false - offerId: 124 cashbackAmount: 20.4 newResult: true offerIds: - 123 - 124 delayedChargeOfferIds: - 321 rejectedOffers: - offerId: 125 errorCode: "NOT_IN_TIME" errorMessage: "Чек не попадает в период действия акции" "202": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: text/plain: schema: type: "string" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/loyalty/clients/cashback/balance: post: tags: - "Cпецпредложения и кэшбэк" summary: "Получить баланс клиента и информацию по кэшбэку" description: "\nВ поле `scopes` у токена должен быть доступ вида\n`opensme/inn/[{inn}]/kpp/[{kpp}]/loyalty/clients/cashback/balance`,\ \ где {inn} — ИНН клиента, а {kpp} — КПП клиента." operationId: "postApiV1LoyaltyClientsCashbackBalance" parameters: - name: "test" in: "query" description: "Если передается 'true', то будут использоваться тестовые дан\ ные. Иначе продовые." required: false style: "form" explode: true schema: type: "boolean" example: true requestBody: content: application/json: schema: $ref: "#/components/schemas/CashbackBalanceRequest" example: phoneNumber: "79990001122" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CashbackBalanceResponse" example: balance: 320.5 monthCashback: 530.79 allTimeCashback: 15530.99 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/loyalty/clients/cashback/history: post: tags: - "Cпецпредложения и кэшбэк" summary: "Получить историю кэшбэка клиента" description: "\nВ поле `scopes` у токена должен быть доступ вида\n`opensme/inn/[{inn}]/kpp/[{kpp}]/loyalty/clients/cashback/history`,\ \ где {inn} — ИНН клиента, а {kpp} — КПП клиента." operationId: "postApiV1LoyaltyClientsCashbackHistory" parameters: - name: "test" in: "query" description: "Если передается 'true', то будут использоваться тестовые дан\ ные. Иначе продовые." required: false style: "form" explode: true schema: type: "boolean" example: true requestBody: content: application/json: schema: $ref: "#/components/schemas/CashbackHistoryRequest" example: phoneNumber: "79990001122" page: 0 size: 10 required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CashbackHistoryResponse" example: data: - status: "PENDING" receipt: qrCodeAsString: "t=20210115T1712&s=316.00&fn=9287440300782352&i=12747&fp=3093752358&n=1" date: "2021-02-03T00:00:00.001+03:00" rejectedOffers: [] delayedChargeOffers: - 10 - status: "PENDING" receipt: qrCodeAsString: "t=20210115T1713&s=316.00&fn=9287440300782352&i=12747&fp=3093752358&n=1" date: "2021-03-03T00:00:00.001+03:00" rejectedOffers: [] delayedChargeOffers: [] - status: "ERROR" receipt: qrCodeAsString: "t=20210115T1714&s=316.00&fn=9287440300782352&i=12747&fp=3093752358&n=1" date: "2021-04-03T00:00:00.001+03:00" cancellationInfo: type: "RECEIPT_ERROR" message: "Некорректный чек" rejectedOffers: [] delayedChargeOffers: - 10 - status: "ERROR" receipt: qrCodeAsString: "t=20210115T1715&s=316.00&fn=9287440300782352&i=12747&fp=3093752358&n=1" date: "2021-05-03T00:00:00.001+03:00" cancellationInfo: type: "CASHBACK_OFFERS_ERROR" message: "Офферы, подходящие для начислений, не найдены" rejectedOffers: - offerId: 1 errorCode: "CASHBACK_NO_OFFERS_AVAILABLE" errorMessage: "Офферы для данного чека не найдены" - offerId: 2 errorCode: "NOT_IN_TIME" errorMessage: "Чек не попадает в период действия акции" delayedChargeOffers: [] - status: "DONE" receipt: qrCodeAsString: "t=20210115T1716&s=316.00&fn=9287440300782352&i=12747&fp=3093752358&n=1" date: "2021-06-03T00:00:00.001+03:00" cashback: - amount: 22.5 date: "2021-02-08T00:00:00.001+03:00" offerId: 1231 - amount: 51.3 date: "2021-02-07T00:00:00.001+03:00" offerId: 546 rejectedOffers: [] delayedChargeOffers: - 10 total: 5 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/safe-deal/beneficiaries: post: tags: - "Безопасная сделка" summary: "Проверить бенефициаров" description: "Метод для проверки бенефициаров на действительность персональн\ ых.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/safe-deal/beneficiaries/post\ \ — Запуск проверки бенефициаров на действительность персональных да\ нных и получение результатов этой проверки.\n\n\nОграничение исполь\ зования метода — 4 запроса в секунду." operationId: "postApiV1Safe-dealBeneficiaries" requestBody: content: application/json: schema: $ref: "#/components/schemas/CheckBeneficiariesRequest" examples: Сценарий 1. Серия и номер "1111111111" — передача ПД с некорректными ИИН и паспортом: value: firstName: "Иван" middleName: "Иванович" lastName: "Иванов" phone: "+79996661313" email: "ololo@kek.com" passport: birthDate: "2021-05-24" birthPlace: "Г. МОСКВА" citizenship: "РФ" serialNumber: "1111111111" unitName: "УМВД РОССИИ ПО Г. МОСКВЕ" issueDate: "2021-05-24" unitCode: "123-456" address: "г. Урюпинск, ул. Ленина, 2" Сценарий 2. Серия и номер "2222222222" — передача ПД с корректным ИИН и некорректным паспортом: value: firstName: "Иван" middleName: "Иванович" lastName: "Иванов" phone: "+79996661313" email: "ololo@kek.com" passport: birthDate: "2021-05-24" birthPlace: "Г. МОСКВА" citizenship: "РФ" serialNumber: "2222222222" unitName: "УМВД РОССИИ ПО Г. МОСКВЕ" issueDate: "2021-05-24" unitCode: "123-456" address: "г. Урюпинск, ул. Ленина, 2" Сценарий 3. Серия и номер "3333333333" — передача ПД с некорректным ИИН и корректным паспортом: value: firstName: "Иван" middleName: "Иванович" lastName: "Иванов" phone: "+79996661313" email: "ololo@kek.com" passport: birthDate: "2021-05-24" birthPlace: "Г. МОСКВА" citizenship: "РФ" serialNumber: "3333333333" unitName: "УМВД РОССИИ ПО Г. МОСКВЕ" issueDate: "2021-05-24" unitCode: "123-456" address: "г. Урюпинск, ул. Ленина, 2" Сценарий 4. Другие серия и номер — передача ПД с корректными ИИН и паспортом: value: firstName: "Иван" middleName: "Иванович" lastName: "Иванов" phone: "+79996661313" email: "ololo@kek.com" passport: birthDate: "2021-05-24" birthPlace: "Г. МОСКВА" citizenship: "РФ" serialNumber: "1234567890" unitName: "УМВД РОССИИ ПО Г. МОСКВЕ" issueDate: "2021-05-24" unitCode: "123-456" address: "г. Урюпинск, ул. Ленина, 2" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CheckBeneficiariesResponse" example: correlationId: "cf99df08-0829-4614-8da3-0e440fd23fe0" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/safe-deal/beneficiaries/result: get: tags: - "Безопасная сделка" summary: "Получить статус проверки бенефициара" description: "Метод для получения статуса проверки бенефициара на действител\ ьность персональных данных.\n\n\nЧтобы использовать метод, нужен доступ —\ \ opensme/inn/[{inn}]/kpp/[{kpp}]/safe-deal/beneficiaries/post\ \ — Запуск проверки бенефициаров на действительность персональных да\ нных и получение результатов этой проверки." operationId: "getApiV1Safe-dealBeneficiariesResult" parameters: - name: "correlationId" in: "query" description: "Идентификатор, связывающий запрос создания с запросом получе\ ния ответа." required: true style: "form" explode: true schema: type: "string" format: "uuid" example: "cf99df08-0829-4614-8da3-0e440fd23fe0" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/GetBeneficiariesResultResponse" examples: Проверка в процессе: value: status: "IN_PROGRESS" Проверка завершена. ИНН и паспорт некорректные: value: status: "READY" result: isInnCorrect: false isPassportCorrect: false Проверка завершена. ИНН корректный, паспорт некорректный: value: status: "READY" result: isInnCorrect: true isPassportCorrect: false Проверка завершена. ИНН некорректный, паспорт корректный: value: status: "READY" result: isInnCorrect: false isPassportCorrect: true Проверка завершена. ИНН и паспорт корректные: value: status: "READY" result: isInnCorrect: true isPassportCorrect: true "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://business.tinkoff.ru/openapi" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox" description: "Sandbox" /api/v1/self-employed/taxpayers/{inn}/bind: post: tags: - "Самозанятые" summary: "Отправить запрос на подключение самозанятого к Тинькофф" description: "\nМетод для отправки запроса самозанятому на подключение к Тин\ ькофф.\n\n\n⚠️ Вызовы метода платные. Чтобы ознакомиться с тарифами, обрат\ итесь к менеджеру.\n\n\nСамозанятый получит уведомление в сервисе «Мой нал\ ог».\nЕсли он его примет, Тинькофф сможет проверять его статус, формироват\ ь чеки и выполнять другие операции от его имени в налоговой.\n\n\nУспешный\ \ ответ на вызов метода не гарантирует, что подключение самозанятого завер\ шится успешно.\nВызов метода инициирует процесс подключения, который может\ \ завершиться с ошибкой — например, из-за недоступности сервисов ФНС. \nВ\ \ таком случае метод Получить статус самозанятого возвращает `INTERNAL_ERROR`\nв поле reason\ \ объекта application, и попытку подключения самозанятого нужно пов\ торить.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/taxpayers/bind\ \ — Привязка самозанятых к Тинькофф.\n\n\nОграничение на испо\ льзование метода — 1 запрос в секунду." operationId: "postApiV1Self-employedTaxpayersInnBind" parameters: - name: "inn" in: "path" required: true style: "simple" explode: false schema: pattern: "^(\\d{12})$" type: "string" description: "ИНН" - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/BindTaxpayerRequest" example: firstName: "Фома" lastName: "Киняев" middleName: "Семёнович" phoneNumber: "+79998887766" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/taxpayers/{inn}/receipts: post: tags: - "Самозанятые" summary: "Зарегистрировать доход самозанятого" description: "\nМетод для регистрации дохода самозанятого в налоговой, если\ \ он подключён к Тинькофф.\n\n\n⚠️ Вызовы метода платные. Чтобы ознакомить\ ся с тарифами, обратитесь к менеджеру.\n\n\nЧтобы использовать метод, нуже\ н доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/taxpayers/create-receipt\ \ — Зарегистрировать доход самозанятого.\n\n\nОграничение на\ \ использование метода — 1 запрос в секунду." operationId: "postApiV1Self-employedTaxpayersInnReceipts" parameters: - name: "inn" in: "path" required: true style: "simple" explode: false schema: pattern: "^(\\d{12})$" type: "string" description: "ИНН" - name: "Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateReceiptRequest" examples: Доход от физического лица.: value: incomeType: "FROM_INDIVIDUAL" services: - name: "Оплата самозанятому по договору" price: 1500.42 Доход от компании.: value: incomeType: "FROM_LEGAL_ENTITY" incomeReceivedAt: "2022-09-01T11:09:22.858Z" services: - name: "Оплата самозанятому по договору" price: 1500.42 customerInn: "7710140679" customerOrganization: "ООО Рога и копыта" Доход от иностранной компании.: value: incomeType: "FROM_FOREIGN_AGENCY" services: - name: "Оплата самозанятому по договору" price: 1500.42 customerOrganization: "Иностранная компания" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ReceiptResponse" example: receiptId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" incomeType: "FROM_INDIVIDUAL" incomeReceivedAt: "2022-05-12T14:03:40Z" incomeStatedAt: "2022-05-12T14:03:40Z" status: "REGISTERED" totalAmount: 1500.42 services: - name: "Оплата самозанятому по договору" price: 1500.42 operations: - status: "IN_PROGRESS" type: "REGISTRATION" createdAt: "2022-05-12T14:03:40Z" - status: "SUCCESS" type: "REGISTRATION" createdAt: "2022-05-12T14:23:40Z" fnsLink: "https://lknpd.nalog.ru/api/v1/receipt/504511355012/2017i8xslu/print" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/taxpayers/{inn}/status: get: tags: - "Самозанятые" summary: "Получить статус самозанятого" description: "\nМетод возвращает информацию о статусе самозанятого, дате пос\ тановки на учёт, выданных Тинькофф правах, регионе и виде деятельности.\n\n\ \nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/taxpayers/status\ \ — Получение статуса привязки самозанятых к Тинькофф.\n\n\nО\ граничение на использование метода — 10 запросов в секунду." operationId: "getApiV1Self-employedTaxpayersInnStatus" parameters: - name: "inn" in: "path" required: true style: "simple" explode: false schema: pattern: "^(\\d{12})$" type: "string" description: "ИНН" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/GetTaxpayerStatusResponse" examples: Пример ответа Registered Done.: value: status: "Registered" info: registeredAt: "2022-05-12T14:03:40Z" activityCodes: - "100" oktmo: "29000000" permissions: - "PAYMENT_INFORMATION" - "TAXPAYER_UPDATE" - "CANCEL_ANY_INCOME" - "CANCEL_INCOME" - "INCOME_SUMMARY" - "INCOME_REGISTRATION" - "INCOME_LIST" - "PERMISSIONS_MGMT" - "TAX_PAYMENT" application: status: "DONE" changedAt: "2022-05-20T09:20:19Z" result: "REGISTERED" Пример ответа NotRegistered с заявкой.: value: status: "NotRegistered" application: status: "IN_PROGRESS" subStatus: "PERMISSION_REQUESTED" changedAt: "2022-08-16T09:35:33Z" Пример ответа NotRegistered без заявки.: value: status: "NotRegistered" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" deprecated: true security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/taxpayers/{inn}/receipts/{receiptId}/cancel: post: tags: - "Самозанятые" summary: "Аннулировать доход самозанятого" description: "\nМетод для аннулирования дохода самозанятого в налоговой, есл\ и он подключён к Тинькофф.\n\n\n⚠️ Вызовы метода платные. Чтобы ознакомить\ ся с тарифами, обратитесь к менеджеру.\n\n\nЧтобы использовать метод, нуже\ н доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/self-employed/taxpayers/cancel-receipt\ \ — Аннулировать доход самозанятого.\n\n\nОграничение на испо\ льзование метода — 1 запрос в секунду." operationId: "postApiV1Self-employedTaxpayersInnReceiptsReceiptidCancel" parameters: - name: "inn" in: "path" required: true style: "simple" explode: false schema: pattern: "^(\\d{12})$" type: "string" description: "ИНН" - name: "receiptId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор чека." format: "uuid" requestBody: content: application/json: schema: $ref: "#/components/schemas/CancelReceiptRequest" example: reason: "MISTAKE" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/CancelReceiptResponse" example: receiptId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" operation: status: "IN_PROGRESS" type: "CANCELLATION" createdAt: "2022-09-20T11:09:22.858Z" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/self-employed/taxpayers/{inn}/receipts/{receiptId}: get: tags: - "Самозанятые" summary: "Получить информацию о чеке" description: "Метод возвращает информацию по конкретному чеку." operationId: "getApiV1Self-employedTaxpayersInnReceiptsReceiptid" parameters: - name: "inn" in: "path" required: true style: "simple" explode: false schema: pattern: "^(\\d{12})$" type: "string" description: "ИНН" - name: "receiptId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор чека." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/ReceiptResponse" example: receiptId: "61f656e0-0a86-4ec2-bd43-232499f7ad66" incomeType: "FROM_INDIVIDUAL" incomeReceivedAt: "2022-05-12T14:03:40Z" incomeStatedAt: "2022-05-12T14:03:40Z" status: "REGISTERED" totalAmount: 1500.42 services: - name: "Оплата самозанятому по договору" price: 1500.42 operations: - status: "IN_PROGRESS" type: "REGISTRATION" createdAt: "2022-05-12T14:03:40Z" - status: "SUCCESS" type: "REGISTRATION" createdAt: "2022-05-12T14:23:40Z" fnsLink: "https://lknpd.nalog.ru/api/v1/receipt/504511355012/2017i8xslu/print" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/ndfl-3/requests/{taxRequestId}/info/personal: get: tags: - "Декларации 3-НДФЛ" summary: "Получить персональные данные клиента, для которого требуется форми\ рование декларации" description: "\nМетод возвращает персональные данные клиента по идентификато\ ру заявки — `taxRequestId`.\nПолучить данные по одному идентификатору заяв\ ки можно только один раз: следующие вызовы будут завершаться 422 ошибкой.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/ndfl3-automation/info/personal\ \ — Декларации 3-НДФЛ — Получение персональных данных клиента.\n\ \n\nОграничение на использование метода — 10 запросов в секунду." operationId: "getApiV1Ndfl-3RequestsTaxrequestidInfoPersonal" parameters: - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/PersonalDataResponse" example: birthDate: "1986-10-13" birthPlace: "г. Москва" inn: "123456789012" lastName: "Фамилия" middleName: "Отчество, если есть" firstName: "Имя" address: "Адрес регистрации" bic: "044525974" accountNumber: "12345678901234567890" passport: serialNumber: "8006123123" unitName: "Октябрьским РУВД г. Екатеринбург" unitCode: "321-890" issueDate: "2000-04-07" citizenship: "RU" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/ndfl-3/requests/{taxRequestId}/info/document-data: get: tags: - "Декларации 3-НДФЛ" summary: "Получить машиночитаемые данные документа" description: "\nМетод возвращает машиночитаемые данные документа, тип которо\ го передан в параметре `documentType`\nдля заявки с идентификатором `taxRequestId`.\n\ \n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/ndfl3-automation/info/document-data-get\ \ — Декларации 3-НДФЛ — Получение машиночитаемых данных документа.\n\ \n\nОграничение на использование метода — 10 запросов в секунду." operationId: "getApiV1Ndfl-3RequestsTaxrequestidInfoDocument-data" parameters: - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" - name: "documentType" in: "query" description: "Тип документа" required: true style: "form" explode: true schema: $ref: "#/components/schemas/DocumentType3" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/DocumentDataResponse" example: documentType: "Ndfl2" documentData: clientData: taxPayerStatus: "1" deps: - depInfo: oktmo: "45344000" phone: "(495)6481000" inn: "7710140679" kpp: "771301001" companyName: "АО «ТИНЬКОФФ БАНК»" rates: - rate: 13 incomes: - month: 8 incomeCode: "1530" incomeSum: 207597.72 recs: - recCode: "201" recSum: 2500.8 totalIncomeTax: incomeTotalSum: 79702.94 taxBase: 3016.06 taxSumCalc: 1494 prepaymentFixedSum: 0 taxSumWithheld: 1494 taxSumTransfer: 1494 taxSumOverWithheld: 0 taxSumNotWithheld: 0 "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/ndfl-3/requests/{taxRequestId}/tax-form/upload: post: tags: - "Декларации 3-НДФЛ" summary: "Загрузить файл с готовой декларацией" description: "\nМетод загружает готовую декларацию клиента по идентификатору\ \ заявки — `taxRequestId`.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/ndfl3-automation/tax-form/upload\ \ — Декларации 3-НДФЛ — Загрузить файл с готовой декларацией.\n\ \n\nОграничение на использование метода — 1 запрос в секунду." operationId: "postApiV1Ndfl-3RequestsTaxrequestidTax-formUpload" parameters: - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" - name: "X-Idempotency-Key" in: "header" required: true style: "simple" explode: false schema: type: "string" description: "Ключ идемпотентности. Подробнее." format: "uuid" requestBody: content: multipart/form-data: schema: required: - "file" type: "object" properties: description: type: "string" file: type: "string" format: "binary" required: true responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/Empty" example: {} "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/ndfl-3/requests/{taxRequestId}/info/form: get: tags: - "Декларации 3-НДФЛ" summary: "Получить заполненную клиентом анкету с составом декларации 3-НДФЛ" description: "\nМетод возвращает заполненную анкету клиента по идентификатор\ у заявки — `taxRequestId`.\nЕсли анкета не будет найдена, вернётся ошибка\ .\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/ndfl3-automation/info/form\ \ — Декларации 3-НДФЛ — Получить заполненную клиентом анкету.\n\ \n\nОграничение на использование метода — 10 запросов в секунду." operationId: "getApiV1Ndfl-3RequestsTaxrequestidInfoForm" parameters: - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" responses: "200": description: "" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/FormDataResponse" example: year: 2022 isResident: true type: "Primary" incomeSources: - title: "Доходы за рубежом" options: - title: "Сдача недвижимости в аренду" documents: - id: "4f73de13-4054-448e-b07f-500e09cd6d56" title: "Document" fileName: "filename.pdf" mime: "application/pdf" size: 10000 taxReturnReasons: - title: "Социальный налоговый вычет" options: - title: "Лечение" documents: - id: "4f73de13-4054-448e-b07f-500e09cd6d56" title: "Document" fileName: "filename.pdf" mime: "application/pdf" size: 10000 casVersion: 1 createdAt: "2005-08-09T18:31:42+03:30" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" /api/v1/ndfl-3/requests/{taxRequestId}/info/form/attachments/{attachmentId}: get: tags: - "Декларации 3-НДФЛ" summary: "Получить вложение из заполненной анкеты клиента" description: "\nМетод возвращает файл из анкеты клиента по идентификатору за\ явки — `taxRequestId` и идентификатору файла — `attachmentId`.\nЕсли файл\ \ не будет найден или будет недоступен для скачивания после закрытия запро\ са, вернётся ошибка.\n\n\nЧтобы использовать метод, нужен доступ — opensme/inn/[{inn}]/kpp/[{kpp}]/ndfl3-automation/info/form/attachments\ \ — Декларации 3-НДФЛ — Получить вложение из заполненной анкеты клие\ нта.\n\n\nОграничение на использование метода — 10 запросов в секун\ ду." operationId: "getApiV1Ndfl-3RequestsTaxrequestidInfoFormAttachmentsAttachmentid" parameters: - name: "taxRequestId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор заявки." format: "uuid" - name: "attachmentId" in: "path" required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор вложения." format: "uuid" responses: "200": description: "" headers: Content-Disposition: required: true style: "simple" explode: false schema: type: "string" X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/octet-stream: schema: type: "string" format: "binary" "400": description: "Некорректный запрос" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InvalidRequestResponse" examples: Ошибка при неправильно заполненном ИНН: value: errorId: "retw6789" errorMessage: "Некорректно заполнен ИНН" errorCode: "VALIDATION_ERROR" Ошибка при неправильно переданном значении поля fieldName: value: errorId: "cde4zxc5" errorMessage: "Ваш запрос невалиден" errorCode: "INVALID_DATA" errorDetails: fieldName: "expected fieldName to be one of (1, 2, 3, 4, 5),\ \ but got \"0\"" Ошибка при неправильно переданной дате платежа: value: errorId: "cde4zxc5" errorMessage: "Данные не соответствуют формату платежного пору\ чения" errorCode: "INVALID_DATA" errorDetails: Дата платежа: "Дата исполнения платежа не может быть в прошл\ ом" "401": description: "Ошибка аутентификации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthenticationFailedResponse" example: errorMessage: "Не хватает учетных данных" errorCode: "UNAUTHORIZED" errorId: "asdq3412" "403": description: "Ошибка авторизации" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/AuthorizationFailedResponse" example: errorMessage: "Неправильный Tls сертификат" errorCode: "FORBIDDEN" errorId: "rtbe4567" "422": description: "Ошибка при обработке данных" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/BusinessErrorResponse" example: errorMessage: "На балансе недостаточно средств" errorCode: "INSUFFICIENT_FUNDS" errorId: "bcde3412" "429": description: "Слишком много запросов" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsErrorResponse" example: errorMessage: "Слишком много запросов. Попробуйте позже" errorCode: "TOO_MANY_REQUESTS" errorId: "acdf000" "500": description: "Ошибка сервера" headers: X-Request-Id: required: true style: "simple" explode: false schema: type: "string" description: "Идентификатор запроса." content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorResponse" example: errorMessage: "Непредвиденная ошибка. Пожалуйста, попробуйте позже" errorCode: "INTERNAL_ERROR" errorId: "asdq3412" security: - httpAuth: [] servers: - url: "https://secured-openapi.business.tinkoff.ru" description: "Production" - url: "https://business.tinkoff.ru/openapi/sandbox/secured" description: "Sandbox" components: schemas: TaxReportCalculation: required: - "couponBase" - "couponBaseExcess" - "couponDebt" - "couponExcessDebt" - "couponExcessTaxRate" - "couponTax" - "couponTaxExcess" - "couponTaxRate" - "couponTaxWithheld" - "couponTaxWithheldExcess" - "dividendBase" - "dividendDebt" - "dividendTax" - "dividendTaxRate" - "dividendTaxWithheld" - "exrepoBase" - "exrepoDebt" - "exrepoTax" - "exrepoTaxRate" - "exrepoTaxWithheld" - "finresSellNocb" - "finresSellOcb" - "pecuniaryLoss" - "repoBaseNocb" - "repoBaseOcb" - "saldoSellNocb" - "saldoSellOcb" - "tax" - "taxDebt" - "taxRate" - "taxWithheld" - "totalBase" - "totalCalculateTax" - "totalTaxDebt" - "totalTaxIn" - "totalTaxOut" - "totalWithheldTax" - "year" type: "object" properties: year: type: "integer" format: "int32" finresSellOcb: type: "number" description: "Сумма" repoBaseOcb: type: "number" description: "Сумма" saldoSellOcb: type: "number" description: "Сумма" finresSellNocb: type: "number" description: "Сумма" repoBaseNocb: type: "number" description: "Сумма" saldoSellNocb: type: "number" description: "Сумма" totalBase: type: "number" description: "Сумма" taxRate: type: "integer" format: "int32" tax: type: "number" description: "Сумма" taxWithheld: type: "number" description: "Сумма" taxDebt: type: "number" description: "Сумма" pecuniaryLoss: type: "number" description: "Сумма" dividendBase: type: "number" description: "Сумма" dividendTaxRate: type: "integer" format: "int32" dividendTax: type: "number" description: "Сумма" dividendTaxWithheld: type: "number" description: "Сумма" dividendDebt: type: "number" description: "Сумма" couponBaseExcess: type: "number" description: "Сумма" couponExcessTaxRate: type: "integer" format: "int32" couponTaxExcess: type: "number" description: "Сумма" couponTaxWithheldExcess: type: "number" description: "Сумма" couponExcessDebt: type: "number" description: "Сумма" couponBase: type: "number" description: "Сумма" couponTaxRate: type: "integer" format: "int32" couponTax: type: "number" description: "Сумма" couponTaxWithheld: type: "number" description: "Сумма" couponDebt: type: "number" description: "Сумма" exrepoBase: type: "number" description: "Сумма" exrepoTaxRate: type: "integer" format: "int32" exrepoTax: type: "number" description: "Сумма" exrepoTaxWithheld: type: "number" description: "Сумма" exrepoDebt: type: "number" description: "Сумма" totalCalculateTax: type: "number" description: "Сумма" totalWithheldTax: type: "number" description: "Сумма" totalTaxOut: type: "number" description: "Сумма" totalTaxIn: type: "number" description: "Сумма" totalTaxDebt: type: "number" description: "Сумма" PaymentRegistrySubmitResultResponse: required: - "paymentRegistryId" - "status" type: "object" properties: paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" status: $ref: "#/components/schemas/SubmissionStatus" error: required: - "errorCode" - "errorMessage" type: "object" properties: errorCode: type: "string" description: "Код ошибки." errorMessage: type: "string" description: "Описание ошибки." description: "Общая ошибка, произошедшая при создании реестра." paymentErrors: type: "array" description: "Платежи внутри реестра, содержащие ошибки." items: $ref: "#/components/schemas/EmployedSubmitPaymentError" Rate: required: - "rate" - "totalIncomeTax" type: "object" properties: rate: type: "integer" description: "Налоговая ставка по доходу." format: "int32" incomes: type: "array" description: "Доходы, разделённые по месяцам и кодам дохода." items: $ref: "#/components/schemas/Income" standardRecs: type: "array" description: "Стандартные, социальные и имущественные налоговые вычеты." items: $ref: "#/components/schemas/StandardRec" totalIncomeTax: $ref: "#/components/schemas/TotalIncomeTax" BeneficiaryIpResidentRequest: required: - "addresses" - "birthDate" - "citizenship" - "documents" - "firstName" - "inn" - "lastName" - "registrationDate" - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона. phoneNumber или email обязателен к заполне\ нию." email: type: "string" description: "Электронная почта. phoneNumber или email обязателен к запо\ лнению." documents: minItems: 1 type: "array" description: "Документы. Для ИП резидента обязателен тип PASSPORT." items: $ref: "#/components/schemas/Document2" addresses: minItems: 1 type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" registrationDate: type: "string" description: "Дата регистрации." format: "date" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." ogrn: pattern: "^(\\d{15})$" type: "string" description: "Основной государственный регистрационный номер." StepListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество этапов сделки для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество этапов сделки для вывода." format: "int32" size: type: "integer" description: "Количество этапов сделки в ответе." format: "int32" total: type: "integer" description: "Всего этапов сделки, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список этапов сделки." items: $ref: "#/components/schemas/StepResponse" SelfEmployedStatusResponse: required: - "isSelfEmployed" type: "object" properties: isSelfEmployed: type: "boolean" description: "Является ли пользователь самозанятым." ApplicationSubStatus: type: "string" description: "Субстатус, присутствует только у заявок, где status = IN_PROGRESS." enum: - "PERMISSION_REQUESTED" Balance: required: - "authorized" - "otb" - "pendingPayments" - "pendingRequisitions" type: "object" properties: otb: type: "number" description: "Доступный остаток — деньги на счёте + сумма доступного ове\ рдрафта, если он подключен." authorized: type: "number" description: "Сумма авторизаций — захолдированные на счёте средства." pendingPayments: type: "number" description: "Сумма платежей в картотеке клиента — собственные платежи." pendingRequisitions: type: "number" description: "Сумма платежей в картотеке банка — требования к клиенту." description: "Баланс счёта." CashbackHistoryItem: required: - "receipt" - "status" type: "object" properties: status: type: "string" description: "Статус обработки чека. Может принимать следующие значения\n\ * `DONE` — обработан\n* `ERROR` — обработан с ошибкой\n* `PENDING` — в\ \ обработке" enum: - "DONE" - "ERROR" - "PENDING" receipt: $ref: "#/components/schemas/ReceiptHistoryItem" cancellationInfo: $ref: "#/components/schemas/CashbackCancellationInfo" cashback: type: "array" description: "Детали кэшбэка за чек" items: $ref: "#/components/schemas/CashbackInfoHistoryItem" rejectedOffers: type: "array" description: "Отклонённые офферы" items: $ref: "#/components/schemas/RejectedOffer" delayedChargeOffers: type: "array" description: "Офферы, ожидающие начисления" items: type: "integer" format: "int64" BeneficiariesResult: required: - "isInnCorrect" - "isPassportCorrect" type: "object" properties: isInnCorrect: type: "boolean" description: "Наличие ИНН по полученным персональным данным." isPassportCorrect: type: "boolean" description: "Действительность персональнных данных." description: "Результат проверки бенефициара. Возвращается в ответе, если ст\ атус — READY." ReceiptService: required: - "name" - "price" type: "object" properties: name: type: "string" description: "Название услуги." price: type: "number" description: "Цена." BeneficiaryScoringInfoListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество результатов проверки для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество результатов проверки для вывода." format: "int32" size: type: "integer" description: "Количество результатов проверки в ответе." format: "int32" total: type: "integer" description: "Всего результатов проверки, подходящих под условия запроса\ ." format: "int32" results: type: "array" description: "Список результатов проверки." items: $ref: "#/components/schemas/BeneficiaryScoringInfo" PhoneType1: type: "string" description: "Тип телефона." enum: - "Мобильный" - "По месту жительства" - "Рабочий" BeneficiaryLiteContactRequest: required: - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" description: "Не требующий идентификации контакт." Passport1: required: - "issueDate" - "issuerCode" - "issuerName" - "number" - "series" type: "object" properties: series: pattern: "^\\d{4}$" type: "string" description: "Серия." number: pattern: "^\\d{6}$" type: "string" description: "Номер." issuerName: type: "string" description: "Кем выдан." issuerCode: type: "string" description: "Код подразделения." issueDate: type: "string" description: "Дата выдачи в формате `yyyy-MM-dd`." format: "date" description: "Данные паспорта." CardPayerRequisites: required: - "accountNumber" type: "object" properties: accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта для списания." description: "Реквизиты плательщика." SubmitPaymentError: required: - "number" type: "object" properties: number: type: "integer" description: "Идентификатор платежа, переданный клиентом при создании." format: "int32" accountNumber: type: "string" description: "Номер счёта сотрудника." errors: type: "array" description: "Ошибки валидации." items: $ref: "#/components/schemas/FieldValidationError" SelfEmployedCreationDate: type: "object" properties: from: type: "string" description: "Дата начала периода." format: "date-time" to: type: "string" description: "Дата окончания периода." format: "date-time" description: "Период даты добавления." Passport: required: - "date" - "division" - "number" - "serial" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" serial: type: "string" description: "Серия документа." number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" organization: type: "string" description: "Кем выдан." division: pattern: "^(\\d{3}-\\d{3})$" type: "string" description: "Код подразделения." Ndfl2: required: - "clientData" type: "object" properties: clientData: $ref: "#/components/schemas/ClientData" deps: type: "array" items: $ref: "#/components/schemas/DepsData" StandardRec: required: - "recCode" - "recSum" type: "object" properties: recCode: type: "string" description: "Код вычета" recSum: type: "number" description: "Сумма вычета" description: "Стандартные, социальные и имущественные налоговые вычеты" Photo: required: - "id" type: "object" properties: id: type: "string" type: type: "string" description: "Тип фото." subType: type: "string" description: "Подтип фото." sheetNumber: type: "integer" description: "Номер страницы." format: "int32" review: type: "object" additionalProperties: type: "string" description: "Результат проверки фото в формате `JSON`." CreatePhone: required: - "number" - "type" type: "object" properties: type: $ref: "#/components/schemas/PhoneType" number: type: "string" description: "Номер телефона." CreateEmployeesResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" SubscriptionResponse: required: - "type" type: "object" properties: type: $ref: "#/components/schemas/BundleCode" GetBeneficiariesResultResponse: oneOf: - $ref: "#/components/schemas/InProgress1" - $ref: "#/components/schemas/Ready1" Terminal: required: - "id" - "key" type: "object" properties: key: type: "string" description: "Серийный номер терминала." id: type: "string" description: "Идентификатор терминала." DriverLicensesResponse: type: "object" properties: licenses: type: "array" description: "Водительские удостоверения физического лица." items: $ref: "#/components/schemas/DriverLicenseResponse" Address2: required: - "fullAddress" type: "object" properties: fullAddress: type: "string" description: "Полный адрес." zipCode: type: "string" description: "Почтовый индекс." country: type: "string" description: "Страна." region: type: "string" description: "Регион." area: type: "string" description: "Район." city: type: "string" description: "Город." street: type: "string" description: "Улица." house: type: "string" description: "Дом." building: type: "string" description: "Корпус." flat: type: "string" description: "Квартира." construction: type: "string" description: "Строение." settlement: type: "string" description: "Поселение." description: "Адрес, по которому нужно получить доступные интервалы для назн\ ачения встречи." OfficialPassport: required: - "date" - "number" - "organization" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" organization: type: "string" description: "Кем выдан." SelfEmployedPayPaymentRegistryResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" PaymentError: required: - "number" type: "object" properties: number: type: "integer" description: "Идентификатор платежа, переданный клиентом при создании." format: "int32" accountNumber: type: "string" description: "Номер счёта сотрудника." errors: type: "array" description: "Ошибки валидации." items: required: - "errorDescription" - "fieldName" type: "object" properties: fieldName: type: "string" description: "Название поля, в котором возникла ошибка, на русском\ \ языке." errorDescription: type: "string" description: "Описание ошибки." RkcBankDetails: required: - "accountNumber" - "bankName" - "bik" - "corrAccountNumber" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя.\n\n\nС 1 января 2021 года при перечи\ слении налоговых платежей указываются новые значения БИК банков получа\ теля.\n\n\nПодробнее о полях платёжного поручения " kpp: pattern: "^(\\d{9})$" type: "string" description: "КПП получателя" inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН. Укажите 0, чтобы не заполнять." name: maxLength: 160 type: "string" description: "Наименование получателя." bankName: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка получателя.\n\n\nС 1 января 2021 года п\ ри заполнении платежей на перечисление налогов после названия банка ук\ азывается название счёта казначейства через знак //. " accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." corrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя.\n\n\nС 1 января 2021\ \ года при уплате налогов указывается номер счёта банка получателя, вх\ одящий в состав единого казначейского счёта (ЕКС). Раньше это поле зап\ олнялось нулями. " UpdateTaskRequest: required: - "template" type: "object" properties: template: type: "string" description: "Шаблон, определяющий бизнес-логику задания." commentForAgent: type: "string" description: "Комментарий к заданию для представителя." parentTaskId: type: "string" description: "Идентификатор родительского задания." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON." contacts: type: "array" description: "Группа объектов с информацией о данных каждого участника з\ адания, подлежащего удостоверению на встрече." items: $ref: "#/components/schemas/Contact" photos: type: "array" description: "Группа объектов с информацией о фото, относящихся к задани\ ю." items: $ref: "#/components/schemas/Photo" SelfEmployedPaymentRegistrySubmitRequest: required: - "correlationId" - "paymentRegistryId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" UnderMinAmountError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Сумма чека меньше необходимой" type: type: "string" description: "UNDER_MIN_AMOUNT" IisOpen: type: "object" properties: agreements: type: "array" description: "Список ИИС." items: $ref: "#/components/schemas/IisAgreement" Patent: required: - "date" - "expireDate" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" CancelReceiptResponse: required: - "operation" - "receiptId" type: "object" properties: receiptId: type: "string" description: "Идентификатор чека." format: "uuid" operation: $ref: "#/components/schemas/ReceiptOperation" TemporaryResidencePermit: required: - "date" - "expireDate" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" TooManyRequestsErrorResponse: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorId: type: "string" errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." errorCode: maxLength: 50 type: "string" description: "Код ошибки." PositionInfo: required: - "currency" - "currentBalance" - "currentBalanceForWithdrawal" type: "object" properties: currency: type: "string" description: "Код валюты." currentBalance: type: "number" description: "Общий баланс по валюте." currentBalanceForWithdrawal: type: "number" description: "Сумма денежных средств, доступных для вывода." blockedQuantity: type: "number" description: "Количество заблокированной валюты." BeneficiaryIpResidentResponse: required: - "beneficiaryId" - "birthDate" - "firstName" - "lastName" - "registrationDate" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона." email: type: "string" description: "Электронная почта." documents: type: "array" description: "Документы." items: $ref: "#/components/schemas/Document2" addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" registrationDate: type: "string" description: "Дата регистрации." format: "date" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." ogrn: pattern: "^(\\d{15})$" type: "string" description: "Основной государственный регистрационный номер." IN_PROGRESS: required: - "beneficiaryId" - "status" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" status: type: "string" description: "Статус проверки в финансовом мониторинге." enum: - "IN_PROGRESS" - "SUCCEEDED" - "FAILED" TransitAccount: required: - "accountNumber" type: "object" properties: accountNumber: type: "string" description: "Номер транзитного банковского счёта." description: "Информация о транзитном счёте. Актуально для валютных счетов." DeponentRequest: required: - "amount" type: "object" properties: amount: type: "number" description: "Сумма депонента." GetIntervalsResponse: required: - "appointmentId" - "timeOffset" type: "object" properties: appointmentId: type: "string" description: "Идентификатор назначения встречи." timeOffset: type: "string" description: "Временная зона адреса, для которого выбирается временной и\ нтервал в формате `ISO 8601`. Например, +03:00." intervals: type: "array" description: "Cписок объектов, содержащих информацию о начале и окончани\ и временного интервала." items: $ref: "#/components/schemas/Interval" BeneficiaryFlNonresidentRequest: required: - "addresses" - "birthDate" - "citizenship" - "documents" - "firstName" - "isSelfEmployed" - "lastName" - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." isSelfEmployed: type: "boolean" description: "Самозанятый." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона. phoneNumber или email обязателен к заполне\ нию." email: type: "string" description: "Электронная почта. phoneNumber или email обязателен к запо\ лнению." documents: minItems: 1 type: "array" description: "Документы. Обязательно — минимум 2.\n\n\nВ большинстве слу\ чаев основной документ нерезидента РФ — `FOREIGN_PASSPORT`. Второй док\ умент — любой из документов, подтверждающих право на пребывание в РФ.\ \ Подробнее о документах.\n\n\nДля нерезидентов с гражданством BY д\ остаточно одного документа с типом `FOREIGN_PASSPORT`." items: $ref: "#/components/schemas/Document2" addresses: minItems: 1 type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." DocumentType1: type: "string" description: "Тип документа." enum: - "Паспорт" - "Иностранный паспорт" - "Загр. паспорт иностранного гр." - "Служебный/официальный паспорт" - "Дипломатический паспорт" - "Миграционная карта" - "Разр. на временное проживание" - "Виза" - "Вид на жительство" IncomingTransactionListItem: required: - "accountNumber" - "amount" - "operationId" type: "object" properties: accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер счета." operationId: type: "string" description: "ID операции пополнения." format: "uuid" amount: type: "number" description: "Сумма пополнения в валюте счёта." currency: pattern: "^\\d{3}$" type: "string" description: "Валюта пополнения в валюте счёта." operationAmount: type: "number" description: "Сумма пополнения в валюте пополнения." operationCurrency: pattern: "^\\d{3}$" type: "string" description: "Валюта пополнения в валюте пополнения." payerBik: pattern: "\\d{9}" type: "string" description: "БИК плательщика." payerKpp: pattern: "^(\\d{9})$" type: "string" description: "КПП плательщика." payerInn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН плательщика." payerBankName: maxLength: 255 minLength: 1 type: "string" description: "Наименования банка плательщика." payerBankSwiftCode: type: "string" description: "SWIFT-код банка плательщика." payerAccountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер счёта плательщика." payerCorrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корр. счёт плательщика." payerName: maxLength: 160 type: "string" description: "Имя плательщика." paymentPurpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." documentNumber: type: "string" description: "Номер платёжного поручения." chargeDate: type: "string" description: "Дата и время пополнения." format: "date-time" authorizationDate: type: "string" description: "Дата авторизации." format: "date-time" transactionDate: type: "string" description: "Дата транзакции." format: "date-time" drawDate: type: "string" description: "Дата списания." format: "date-time" BankStatement: required: - "accountNumber" - "income" - "outcome" - "saldoIn" - "saldoOut" type: "object" properties: accountNumber: type: "string" description: "Расчётный счёт организации." saldoIn: type: "number" description: "Баланс на начало периода." income: type: "number" description: "Обороты входящих платежей." outcome: type: "number" description: "Обороты исходящих платежей." saldoOut: type: "number" description: "Баланс на конец периода." operation: type: "array" description: "Список операций по счёту." items: $ref: "#/components/schemas/BankStatementOperation" PaymentStatus: type: "string" description: "Статус платежа:\n" enum: - "IN_PROGRESS" - "EXECUTED" - "FAILED" - "CANCELLED" DealListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество сделок для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество сделок для вывода." format: "int32" size: type: "integer" description: "Количество сделок в ответе." format: "int32" total: type: "integer" description: "Всего сделок, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список сделок." items: $ref: "#/components/schemas/DealResponse" ActiveOfferAdvert: type: "object" properties: title: type: "string" description: "Рекламный заголовок оффера" text: type: "string" description: "Рекламный текст оффера" textFormatted: type: "string" description: "Форматированный рекламный текст оффера" description: "Рекламная информация оффера" ReceiptOperationType: type: "string" description: "Тип операции." enum: - "REGISTRATION" - "REGISTRATION_OFFLINE" - "CANCELLATION" CardBankDetails: required: - "cardId" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" cardId: maxLength: 256 minLength: 1 type: "string" description: "Идентификатор карты в системе банка." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." SelfEmployedReceipts: required: - "status" type: "object" properties: status: $ref: "#/components/schemas/SelfEmployedReceiptsRequestStatus" error: required: - "errorCode" - "errorMessage" type: "object" properties: errorCode: type: "string" description: "Код ошибки." errorMessage: type: "string" description: "Описание ошибки." description: "Ошибка получения чеков по реестру." receipts: type: "array" description: "Результат регистрации дохода." items: $ref: "#/components/schemas/SelfEmployedReceipt" AddCardRequestResponse: oneOf: - $ref: "#/components/schemas/FailedAddCardRequestResponse" - $ref: "#/components/schemas/PendingAddCardRequestResponse" - $ref: "#/components/schemas/ReadyAddCardRequestResponse" SelfEmployedCreatePaymentRegistryResultResponse: required: - "status" type: "object" properties: paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" status: $ref: "#/components/schemas/CreationRegisterStatus" error: $ref: "#/components/schemas/FieldValidationError" paymentErrors: type: "array" description: "Платежи внутри реестра, содержащие ошибки." items: $ref: "#/components/schemas/PaymentError1" PayerRequisites: required: - "accountNumber" type: "object" properties: accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта для списания." description: "Реквизиты плательщика." LimitRealisedError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Превышен лимит" type: type: "string" description: "LIMIT_REALISED" Visa: required: - "date" - "expireDate" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" Phone2: required: - "number" - "type" type: "object" properties: type: $ref: "#/components/schemas/PhoneType2" number: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер телефона в формате +7xxxxxxxxxx" AccountInfo1: required: - "accountNumber" - "accountType" - "balance" - "bankBik" - "currency" - "name" type: "object" properties: accountNumber: type: "string" description: "Расчётный счёт организации." name: type: "string" description: "Наименование счёта." currency: type: "string" description: "Код валюты счёта по ОКВ (цифрами)." bankBik: pattern: "\\d{9}" type: "string" description: "БИК банка." accountType: type: "string" description: "Тип счета\n* `Current` — расчетный счет\n* `Tax` — счет Ти\ нькофф Бухгалтерии\n* `Tender` — специальный счет для участия в госзак\ упках\n* `Overnight` — счет Overnight" enum: - "Current" - "Tax" - "Tender" - "Overnight" balance: $ref: "#/components/schemas/Balance" transitAccount: $ref: "#/components/schemas/TransitAccount" EmployeeStatus1: type: "string" description: "Статус самозанятого:
" enum: - "PROCESSING" - "DRAFT" - "PROCESSING_ERROR" - "ACTIVE" - "ERROR" - "REJECTED" - "DELETED" - "MTNG_SCHD" - "MTNG_WAIT" - "MTNG_CANC" CreateTaskResponse: required: - "id" type: "object" properties: id: type: "string" description: "Уникальный идентификатор задания." IisAgreement: required: - "agreementNumber" - "openedDate" type: "object" properties: openedDate: type: "string" description: "Дата открытия." format: "date" agreementNumber: type: "string" description: "Номер счёта." closedDate: type: "string" description: "Дата закрытия." format: "date" accounts: type: "array" items: $ref: "#/components/schemas/IisAccount" CheckBeneficiariesResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" PaymentPayResult: required: - "number" - "paymentStatus" type: "object" properties: number: type: "integer" description: "Номер платежа." format: "int32" paymentStatus: $ref: "#/components/schemas/PayStatus" accountNumber: type: "string" description: "Номер счёта." errors: type: "array" description: "Ошибки валидации." items: $ref: "#/components/schemas/FieldValidationError1" IdentificationDocument: oneOf: - $ref: "#/components/schemas/Passport2" MerchantCategory: required: - "categoryId" - "categoryType" - "categoryWeight" - "code" - "imagePath" - "merchantCategoryWeight" - "name" type: "object" properties: categoryId: type: "integer" description: "Id категории." format: "int64" code: type: "string" description: "Код категории." name: type: "string" description: "Наименование категории." categoryType: type: "string" description: "Тип категории. Доступные значения 'STANDARD', 'PROMO'." imagePath: type: "string" description: "Ссылка на картинку категории." categoryWeight: type: "integer" description: "Вес категории." format: "int32" merchantCategoryWeight: type: "integer" description: "Вес партнера в категории." format: "int32" Card: type: "object" properties: ucid: type: "string" description: "UCID" mcc: type: "string" description: "MCC" number: type: "string" description: "Номер карты" description: "Информация о карте" PaymentListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество платежей для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество платежей для вывода." format: "int32" size: type: "integer" description: "Количество платежей в ответе." format: "int32" total: type: "integer" description: "Всего платежей." format: "int32" results: type: "array" description: "Список платежей." items: $ref: "#/components/schemas/PaymentResponse" SelfEmployedRegistryCreateTypeRequest: type: "string" description: "\nМожет принимать одно из двух значений:\n\nЗначение по умолчанию —\ \ FAIL_ERRORS.\n" enum: - "IGNORE_ERRORS" - "FAIL_ERRORS" IisAccount: required: - "accountNumber" - "currency" type: "object" properties: accountNumber: type: "string" currency: type: "string" CardBankDetailsResponse: required: - "bankDetailsId" - "beneficiaryId" - "cardId" - "terminalKey" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" isDefault: type: "boolean" description: "Являются ли реквизиты основными для бенефициара. По умолча\ нию для первых добавленных реквизитов — `true`, для следующих — `false`." cardId: maxLength: 256 minLength: 1 type: "string" description: "Идентификатор карты в системе банка." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." BeneficiaryScoringError: required: - "code" - "description" type: "object" properties: code: type: "string" description: "Код ошибки." description: type: "string" description: "Описание ошибки." description: "Ошибка по результатам проверки бенефициара в финансовом монито\ ринге." ReceiptResponse: oneOf: - $ref: "#/components/schemas/FromForeignAgencyReceiptResponse" - $ref: "#/components/schemas/FromIndividualReceiptResponse" - $ref: "#/components/schemas/FromLegalEntityReceiptResponse" SelfEmployedPayPaymentRegistryResultRequest: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" BundleCode: type: "string" description: "Тип подписки." enum: - "PRO" - "PREMIUM" - "PRIVATE" - "TEAM_PRO" - "TEAM_SELECT" - "TEAM_PREMIUM" - "TEAM_PRIVATE" - "DEFAULT" TaxThirdParty: required: - "inn" - "kpp" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН третьего лица." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП третьего лица." description: "Реквизиты для оплаты налогов за третьих лиц. Подробнее." BankDetailsListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество реквизитов для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество реквизитов для вывода." format: "int32" size: type: "integer" description: "Количество реквизитов в ответе." format: "int32" total: type: "integer" description: "Всего реквизитов, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список реквизитов бенефициара." items: $ref: "#/components/schemas/BankDetailsResponse" CancelTaskRequest: required: - "reason" type: "object" properties: reason: type: "string" description: "Причина отмены задания." CancelReceiptRequest: required: - "reason" type: "object" properties: reason: type: "string" description: "Причина аннулирования." enum: - "MISTAKE" - "REFUND" ReceiptOperation: oneOf: - $ref: "#/components/schemas/ReceiptFailedOperation" - $ref: "#/components/schemas/ReceiptInProgressOperation" - $ref: "#/components/schemas/ReceiptSuccessOperation" RejectedOffer: required: - "errorCode" - "errorMessage" - "offerId" type: "object" properties: offerId: type: "integer" description: "ID оффера" format: "int64" errorCode: type: "string" description: "Код ошибки" errorMessage: type: "string" description: "Текст сообщения об ошибке" Balance1: required: - "authorized" - "balance" - "otb" - "pendingPayments" - "pendingRequisitions" - "realOtb" type: "object" properties: balance: type: "number" description: "Текущий остаток на счёте." realOtb: type: "number" description: "Доступный остаток без учета овердрафта и с вычетом блокиро\ вок." otb: type: "number" description: "Доступный остаток — деньги на счёте + сумма доступного ове\ рдрафта, если он подключен." authorized: type: "number" description: "Сумма авторизаций — захолдированные на счёте средства." pendingPayments: type: "number" description: "Сумма платежей в картотеке клиента — собственные платежи." pendingRequisitions: type: "number" description: "Сумма платежей в картотеке банка — требования к клиенту." description: "Баланс счёта." PersonalDataResponse: required: - "address" - "birthDate" - "birthPlace" - "firstName" - "inn" - "lastName" - "passport" type: "object" properties: birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." lastName: type: "string" description: "Фамилия." middleName: type: "string" description: "Отчество, если есть." firstName: type: "string" description: "Имя." address: type: "string" description: "Адрес регистрации." bic: pattern: "\\d{9}" type: "string" description: "БИК банка." accountNumber: type: "string" description: "Номер лицевого счёта в Тинькофф." passport: $ref: "#/components/schemas/Passport3" Merch: type: "object" properties: id: type: "string" description: "Идентификатор" name: type: "string" description: "Имя" address: type: "string" description: "Место совершения операции (Адрес)" city: type: "string" description: "Место совершения операции (Город)" country: type: "string" description: "Место совершения операции (Страна)" description: "Информация о контрагенте" ClientOffersRequest: required: - "phoneNumber" - "region" type: "object" properties: phoneNumber: type: "string" description: "Номер телефона клиента в формате E.164" region: pattern: "\\d{2}" type: "string" description: "Регион клиента" Ready: required: - "beneficiaryId" - "result" - "status" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" status: type: "string" description: "Статус проверки в финансовом мониторинге." enum: - "IN_PROGRESS" - "READY" result: $ref: "#/components/schemas/BeneficiaryScoringResult" SbpBankDetailsResponse: required: - "bankDetailsId" - "bankId" - "beneficiaryId" - "phoneNumber" - "terminalKey" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" isDefault: type: "boolean" description: "Являются ли реквизиты основными для бенефициара. По умолча\ нию для первых добавленных реквизитов — `true`, для следующих — `false`." phoneNumber: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер мобильного телефона." bankId: pattern: "^\\d{12}$" type: "string" description: "Идентификатор банка в системе быстрых платежей." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." CheckBeneficiariesRequest: required: - "firstName" - "lastName" - "passport" - "phone" type: "object" properties: firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." phone: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер телефона в формате E.164." email: type: "string" description: "Электронная почта." passport: $ref: "#/components/schemas/BeneficiariesPassport" CreatePhoneType: type: "string" description: "Тип телефона." enum: - "Мобильный" - "По месту жительства" - "Рабочий" Address: required: - "address" - "type" type: "object" properties: type: type: "string" description: "\nТип адреса.\nДля типов `FL_RESIDENT`, `FL_NONRESIDENT`,\ \ `IP_RESIDENT`, `IP_NONRESIDENT` обязателен один из адресов:\n\n * `REGISTRATION_ADDRESS`\ \ — адрес регистрации по месту жительства;\n * `RESIDENCE_ADDRESS` — а\ дрес регистрации по месту пребывания.\n\nДля типов `UL_RESIDENT`, `UL_NONRESIDENT`\ \ обязательно передавать `LEGAL_ENTITY_ADDRESS` — адрес юридического л\ ица.\n" enum: - "POSTAL_ADDRESS" - "REGISTRATION_ADDRESS" - "RESIDENCE_ADDRESS" - "LEGAL_ENTITY_ADDRESS" - "OFFICE_OF_FOREIGN_LEGAL_ENTITY_ADDRESS" address: maxLength: 256 type: "string" description: "Адрес." description: "Адрес бенефициара." CreateSelfEmployedResultResponse: type: "object" properties: recipientResults: type: "array" description: "Список результатов создания самозанятых." items: $ref: "#/components/schemas/CreateSelfEmployed" BeneficiaryFlResidentRequest: required: - "addresses" - "birthDate" - "citizenship" - "documents" - "firstName" - "isSelfEmployed" - "lastName" - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." isSelfEmployed: type: "boolean" description: "Самозанятый." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона. Номер телефона или электронная почта обяза\ тельны к заполнению." email: type: "string" description: "Электронная почта. Номер телефона или электронная почта об\ язательны к заполнению." documents: minItems: 1 type: "array" description: "Документы. Обязательный тип для физического лица-резидента\ \ — `PASSPORT`." items: $ref: "#/components/schemas/Document2" addresses: minItems: 1 type: "array" description: "Адреса" items: $ref: "#/components/schemas/Address" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН" snils: pattern: "^(\\d{11})$" type: "string" description: "СНИЛС" ApiBlacklistResponse: required: - "isBlacklisted" type: "object" properties: isBlacklisted: type: "boolean" description: "Находится ли пользователь в чёрных списках." SelfEmployedReceiptsResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" SelfEmployedPaymentRegistry: required: - "paymentsCount" - "status" - "totalSum" type: "object" properties: status: $ref: "#/components/schemas/PaymentRegistryStatus1" loadDate: type: "string" description: "Дата исполнения реестра." paymentsCount: type: "integer" description: "Количество платежей в реестре." format: "int32" totalSum: type: "number" description: "Общая сумма платежей в реестре." payments: type: "array" description: "Список платежей внутри реестра." items: $ref: "#/components/schemas/SelfEmployedPaymentInfo" BeneficiaryUlNonresidentRequest: required: - "addresses" - "name" - "registrationDate" - "registrationNumber" - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" name: type: "string" description: "Наименование организации." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона. phoneNumber или email обязателен к заполне\ нию." email: type: "string" description: "Электронная почта. phoneNumber или email обязателен к запо\ лнению." addresses: minItems: 1 type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" nza: type: "string" description: "Номер записи об аккредитации." registrationDate: type: "string" description: "Дата регистрации." format: "date" registrationNumber: type: "string" description: "Номер регистрации." opf: type: "string" description: "Организационно-правовая форма." inn: pattern: "^(\\d{10})$" type: "string" description: "ИНН." kio: type: "string" description: "Код иностранной организации. Обязателен, если ИНН не задан\ ." CreateAddress1: required: - "postalCode" - "state" - "type" type: "object" properties: type: $ref: "#/components/schemas/CreateAddressType" country: type: "string" description: "Страна." postalCode: type: "string" description: "Индекс." state: type: "string" description: "Регион." city: type: "string" description: "Город." district: type: "string" description: "Район." settlement: type: "string" description: "Населённый пункт." street: type: "string" description: "Улица." house: type: "string" description: "Дом." building: type: "string" description: "Здание." construction: type: "string" description: "Корпус." apartment: type: "string" description: "Квартира." CashbackNoOffersAvailable: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Офферы для данного чека не найдены" type: type: "string" description: "CASHBACK_NO_OFFERS_AVAILABLE" Contract: required: - "date" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" ForeignIncomeStatementLine: required: - "currency" - "isin" - "issuerCountry" - "paymentDate" - "securityName" - "taxWithheld" - "totalPaymentBeforeTax" - "type" type: "object" properties: paymentDate: type: "string" format: "date" type: type: "integer" format: "int32" isin: type: "string" issuerCountry: type: "string" securityName: type: "string" description: "Краткое наименование ценной бумаги" totalPaymentBeforeTax: type: "number" description: "Сумма" taxWithheld: type: "number" description: "Сумма" currency: type: "string" ApplicationStatus: type: "string" description: "Статус заявки." enum: - "IN_PROGRESS" - "DONE" ReissueVirtualCardRequest: required: - "ucid" type: "object" properties: ucid: type: "integer" description: "Уникальный идентификатор карты." format: "int64" ReadyAddCardRequestResponse: required: - "addCardRequestId" - "bankDetailsId" - "beneficiaryId" - "status" - "terminalKey" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" addCardRequestId: type: "string" description: "Идентификатор запроса на добавление карты." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." status: type: "string" description: "Статус запроса на добавление карты:\n* `PENDING` — карта в\ \ процессе добавления.\n* `READY` — карта успешно добавлена.\n* `FAILED`\ \ — не удалось добавить карту." enum: - "PENDING" - "READY" - "FAILED" bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" DiplomaticPassport: required: - "date" - "number" - "organization" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" organization: type: "string" description: "Кем выдан." SbpBankDetails: required: - "bankId" - "phoneNumber" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" phoneNumber: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер мобильного телефона." bankId: pattern: "^\\d{12}$" type: "string" description: "Идентификатор банка в системе быстрых платежей." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." CreateDocument: required: - "date" - "organization" - "serial" - "type" type: "object" properties: type: $ref: "#/components/schemas/DocumentType" serial: type: "string" description: "Серия." number: type: "string" description: "Номер документа." date: type: "string" description: "Дата." format: "date" organization: type: "string" description: "Кем выдан." division: type: "string" description: "Код подразделения." expireDate: type: "string" description: "Дата истечения." format: "date" AccountOperationType: type: "string" description: "Тип операции" enum: - "debit" - "credit" DealRequest: required: - "accountNumber" type: "object" properties: accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." BeneficiaryScoringInfoListResponseV2: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество результатов проверки для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество результатов проверки для вывода." format: "int32" size: type: "integer" description: "Количество результатов проверки в ответе." format: "int32" total: type: "integer" description: "Всего результатов проверки, подходящих под условия запроса\ ." format: "int32" results: type: "array" description: "Список результатов проверки." items: $ref: "#/components/schemas/BeneficiaryScoringInfoV2" EmployeeResponse: type: "object" properties: employees: type: "array" description: "Список сотрудников." items: $ref: "#/components/schemas/Employee" SubmissionStatus1: type: "string" description: "Статус подписания платёжного реестра." enum: - "ACCEPTED" - "ERROR" - "IN_PROGRESS" ClientOffersResponse: type: "object" properties: data: type: "array" description: "Клиентские офферы текущей страницы" items: $ref: "#/components/schemas/ClientOffer" SUCCEEDED: required: - "beneficiaryId" - "status" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" status: type: "string" description: "Статус проверки в финансовом мониторинге." enum: - "IN_PROGRESS" - "SUCCEEDED" - "FAILED" warnings: type: "array" items: $ref: "#/components/schemas/BeneficiaryScoringError" Document1: required: - "type" type: "object" properties: type: $ref: "#/components/schemas/DocumentType1" serial: type: "string" description: "Серия." number: type: "string" description: "Номер документа." date: type: "string" description: "Дата." format: "date" organization: type: "string" description: "Кем выдан." division: type: "string" description: "Код подразделения." expireDate: type: "string" description: "Дата истечения." format: "date" OperationsResponse: required: - "arrests" type: "object" properties: etpFees: type: "array" description: "Список картотек ЭТП." items: $ref: "#/components/schemas/Etp" contractBreaches: type: "array" description: "Список списаний за нарушения контракта." items: $ref: "#/components/schemas/Etp" arrests: $ref: "#/components/schemas/ListOfArrest" RkcBankDetailsRequest: required: - "accountNumber" - "bankName" - "bik" - "corrAccountNumber" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" isDefault: type: "boolean" description: "Являются ли реквизиты основными для бенефициара. По умолча\ нию для первых добавленных реквизитов — `true`, для следующих — `false`." bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя.\n\n\nС 1 января 2021 года при перечи\ слении налоговых платежей указываются новые значения БИК банков получа\ теля.\n\n\nПодробнее о полях платёжного поручения " kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП получателя. Чтобы не заполнять, передайте `0`. Обязате\ льно только для бенефициаров юридических лиц-резидентов (UL_RESIDENT)." inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "\nИНН бенефициара. Если платёж выполняется в пользу физиче\ ского или юридического лица-нерезидента (FL_RESIDENT/FL_NONRESIDENT/UL_NONRESIDENT)\ \ и его ИНН неизвестен, передайте `0`.\nВ остальных случаях передавайт\ е фактический ИНН получателя.\n \nЕсли у бенефициара в методе создания\ \ бенефициара был заполнен ИНН, поле ИНН заполнять не нужно.\nИНН подс\ тавляется автоматически по информации из бенефициара в момент отправки\ \ платежа. Для корректной работы передавать `0` не нужно.\n" name: maxLength: 160 type: "string" description: "Наименование получателя." bankName: maxLength: 160 minLength: 1 type: "string" description: "Наименование банка получателя." accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта получателя." corrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя." ReceiptError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Некорректный чек" type: type: "string" description: "RECEIPT_ERROR" DeponentResponse: required: - "amount" - "beneficiaryId" - "dealId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа сделки." format: "uuid" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" amount: type: "number" description: "Сумма депонента." CreationEmployedStatus: type: "string" description: "Статус создания:
" enum: - "CREATED" - "ERROR" - "QUEUED" AccrualDto: required: - "cashbackAmount" - "newResult" - "offerId" type: "object" properties: offerId: type: "integer" description: "ID оффера, по которому было начисление кэшбэка" format: "int64" cashbackAmount: type: "number" description: "Сумма кэшбэка" newResult: type: "boolean" description: "Флаг нового начисления" ResidencePermit: required: - "date" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" serial: type: "string" description: "Серия документа." number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" GetTaxpayerStatusResponse: required: - "status" type: "object" properties: status: type: "string" description: "Статус самозанятости в Тинькофф." info: $ref: "#/components/schemas/Info" application: $ref: "#/components/schemas/Application" BeneficiaryLiteContactResponse: required: - "beneficiaryId" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" description: "Не требующий идентификации контакт." Passport3: required: - "citizenship" - "issueDate" - "serialNumber" - "unitCode" - "unitName" type: "object" properties: serialNumber: pattern: "^\\d{4}\\d{6}$" type: "string" description: "Серия и номер." unitName: type: "string" description: "Кем выдан." unitCode: pattern: "^\\d{3}-\\d{3}$" type: "string" description: "Код подразделения." issueDate: pattern: "^\\d{4}-\\d{2}-\\d{2}$" type: "string" description: "Дата выдачи в формате `yyyy-mm-dd`." citizenship: type: "string" description: "Гражданство. Код страны в формате ISO 3166-1 alpha-2." description: "Паспортные данные." FromIndividualReceiptResponse: required: - "incomeReceivedAt" - "incomeStatedAt" - "incomeType" - "receiptId" - "status" - "totalAmount" type: "object" properties: receiptId: type: "string" description: "Идентификатор чека." format: "uuid" incomeType: type: "string" description: "От кого самозанятый получил доход." enum: - "FROM_INDIVIDUAL" - "FROM_LEGAL_ENTITY" - "FROM_FOREIGN_AGENCY" incomeReceivedAt: type: "string" description: "Дата и время получения дохода в UTC. Возвращается в формат\ е ISO-8601." format: "date-time" incomeStatedAt: type: "string" description: "Дата и время заявления дохода в UTC. Возвращается в формат\ е ISO-8601." format: "date-time" status: $ref: "#/components/schemas/ReceiptStatus" totalAmount: type: "number" description: "Сумма заявленного дохода." services: type: "array" description: "Массив объектов с информацией об оказанных услугах." items: $ref: "#/components/schemas/ReceiptService" operations: type: "array" description: "Массив объектов с информацией по операциям, произведённым\ \ с чеком." items: $ref: "#/components/schemas/ReceiptOperation" tinkoffLink: type: "string" description: "Ссылка на временный чек в случае недоступности сервисов ФН\ С." fnsLink: type: "string" description: "Ссылка на чек в случае успешной регистрации в ФНС." CreateSelfEmployedResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" DriverLicenseResponse: required: - "docNumber" type: "object" properties: docNumber: type: "string" description: "Номер документа водительского удостоверения." issueDate: type: "string" description: "Дата выдачи водительского удостоверения." format: "date" Contact: required: - "id" type: "object" properties: id: type: "string" description: "Уникальный идентификатор контакта." role: type: "string" description: "Роль." firstName: type: "string" description: "Имя." lastName: type: "string" description: "Фамилия." middleName: type: "string" description: "Отчество." birthDate: type: "string" description: "Дата рождения." format: "date" phones: type: "array" description: "Телефон." items: $ref: "#/components/schemas/Phone2" documents: type: "array" description: "Документы, удостоверяющие личность. Для роли `REALTOR` пар\ аметр можно не передавать." items: $ref: "#/components/schemas/IdentificationDocument" CashLimit: required: - "limitPeriod" - "limitRemain" - "limitValue" type: "object" properties: limitValue: type: "number" description: "Лимит на снятия наличных в валюте счёта, к которому привяз\ ана карта." limitRemain: type: "number" description: "Доступный остаток лимита на снятия наличных в валюте счёта\ , к которому привязана карта." limitPeriod: $ref: "#/components/schemas/OutputLimitPeriod" description: "Объект с информацией о лимите на снятие наличных." CashbackCancellationInfo: oneOf: - $ref: "#/components/schemas/AboveMaxAmountError" - $ref: "#/components/schemas/AccrualsDayLimitExceeded" - $ref: "#/components/schemas/AllTimeLimitError" - $ref: "#/components/schemas/CashbackAlreadyProcessedError" - $ref: "#/components/schemas/CashbackNoOffersAvailable" - $ref: "#/components/schemas/CashbackOffersError" - $ref: "#/components/schemas/InternalError" - $ref: "#/components/schemas/LimitRealisedError" - $ref: "#/components/schemas/MonthLimitError" - $ref: "#/components/schemas/NotInTimeError" - $ref: "#/components/schemas/OfferConditionsNotMetError" - $ref: "#/components/schemas/ReceiptError" - $ref: "#/components/schemas/UnderMinAmountError" CreatePaymentDraftRequest: required: - "accountNumber" - "amount" - "bankAcnt" - "bankBik" - "documentNumber" - "inn" - "kbk" - "kpp" - "oktmo" - "paymentPurpose" - "recipientName" - "taxDocDate" - "taxDocNumber" - "taxEvidence" - "taxPayerStatus" - "taxPeriod" - "uin" type: "object" properties: documentNumber: pattern: "^(\\d{1,6})$" type: "string" description: "Номер распоряжения, определяемый клиентом." date: type: "string" description: "Дата и время исполнения платежа. Может быть в будущем или\ \ не передаваться. Если поле не передано, подписанный документ будет п\ ринят к исполнению немедленно." format: "date-time" amount: type: "number" description: "Сумма платежа." recipientName: type: "string" description: "Получатель." inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН получателя. Если платёж выполняется в пользу физ. лица\ \ и его ИНН неизвестен, передайте 0. Во всех остальных сл\ учаях передавайте фактический ИНН получателя." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП получателя. Если у получателя платежа нет КПП, наприме\ р, это физ. лицо или ИП, передайте 0." bankAcnt: type: "string" description: "Номер счёта получателя." bankBik: type: "string" description: "БИК банка." accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта для списания." paymentPurpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." executionOrder: maximum: 5 minimum: 1 type: "integer" description: "Очерёдность платежа." format: "int32" deprecated: true taxPayerStatus: type: "string" description: "Статус составителя расчётного документа. Поле платёжки 101.\ \ Если платёж не бюджетный, передайте 0." kbk: type: "string" description: "Код бюджетной классификации. Поле платёжки 104. Если платё\ ж не бюджетный или КБК отсутствует, передайте 0." oktmo: type: "string" description: "Код ОКТМО территории, на которой мобилизуются денежные сре\ дства от уплаты налога, сбора и иного платежа. Если платёж не бюджетны\ й, передайте 0." taxEvidence: type: "string" description: "Основание налогового платежа. Поле платёжки 106. Если плат\ ёж не бюджетный или основание неизвестно, передайте 0." taxPeriod: type: "string" description: "Налоговый период. Поле платёжки 107. Формат — ДД.ММ.ГГГГ,\ \ первые два символа могут быть буквами. Если платёж не бюджетный или\ \ период отсутствует, передайте 0." uin: type: "string" description: "Уникальный идентификатор платежа. Если платёж не бюджетный\ , передайте 0." taxDocNumber: type: "string" description: "Номер налогового документа. Поле платёжки 108. Если платёж\ \ не бюджетный или задолженность оплачивается в добровольном порядке,\ \ передайте 0." taxDocDate: type: "string" description: "Дата налогового документа. Поле платёжки 109. Формат — ДД\ .ММ.ГГГГ. Если платёж не бюджетный или дата отсутствует, передайте 0." revenueTypeCode: type: "string" description: "Код вида выплаты. Обязательное поле для платежей в пользу\ \ физ. лиц. Подробнее." enum: - "1" - "2" - "3" - "4" - "5" collectionAmountNumber: type: "number" description: "Удержанная сумма из заработной платы и иных доходов работн\ ика в рублях. Подробнее\ ." recipientCorrAccountNumber: type: "string" description: "Корреспондентский счёт банка получателя. Для налогового пл\ атежа обязательно указывается номер счёта банка получателя средств — н\ омер банковского счёта, который входит в состав единого казначейского\ \ счёта (ЕКС). Подробнее." thirdParty: $ref: "#/components/schemas/ThirdPartyInfo" ReceiptOperationStatus: type: "string" description: "Статус операции." enum: - "IN_PROGRESS" - "SUCCESS" - "FAILED" CreateSelfEmployedData: required: - "birthDate" - "birthPlace" - "citizenship" - "firstName" - "lastName" - "number" type: "object" properties: number: type: "integer" description: "Идентификатор самозанятого на стороне клиента." format: "int32" firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: type: "string" description: "Гражданство." email: type: "string" description: "Электронная почта." latinFirstName: type: "string" description: "Имя (латиница)." latinLastName: type: "string" description: "Фамилия (латиница)." phones: type: "array" description: "Мобильный телефон." items: $ref: "#/components/schemas/CreatePhone1" addresses: type: "array" description: "Адреса места жительства и регистрации." items: $ref: "#/components/schemas/CreateAddress1" documents: type: "array" description: "Для граждан РФ укажите данные паспорта.\n\n\nДля иностранн\ ых граждан укажите:\n\n " items: $ref: "#/components/schemas/CreateDocument1" registrationInfo: $ref: "#/components/schemas/CreateSelfEmployedRegistrationInfo" FromLegalEntityReceiptResponse: required: - "customerInn" - "customerOrganization" - "incomeReceivedAt" - "incomeStatedAt" - "incomeType" - "receiptId" - "status" - "totalAmount" type: "object" properties: receiptId: type: "string" description: "Идентификатор чека." format: "uuid" incomeType: type: "string" description: "От кого самозанятый получил доход." enum: - "FROM_INDIVIDUAL" - "FROM_LEGAL_ENTITY" - "FROM_FOREIGN_AGENCY" incomeReceivedAt: type: "string" description: "Дата и время получения дохода в UTC. Возвращается в формат\ е ISO-8601." format: "date-time" incomeStatedAt: type: "string" description: "Дата и время заявления дохода в UTC. Возвращается в формат\ е ISO-8601." format: "date-time" status: $ref: "#/components/schemas/ReceiptStatus" totalAmount: type: "number" description: "Сумма заявленного дохода." services: type: "array" description: "Массив объектов с информацией об оказанных услугах." items: $ref: "#/components/schemas/ReceiptService" operations: type: "array" description: "Массив объектов с информацией по операциям, произведённым\ \ с чеком." items: $ref: "#/components/schemas/ReceiptOperation" customerInn: pattern: "^(\\d{10})$" type: "string" description: "ИНН компании-заказчика, которой самозанятый оказал услугу." customerOrganization: type: "string" description: "Название компании-заказчика, которой самозанятый оказывал\ \ услуги." tinkoffLink: type: "string" description: "Ссылка на временный чек в случае недоступности сервисов ФН\ С." fnsLink: type: "string" description: "Ссылка на чек в случае успешной регистрации в ФНС." RejectDto: required: - "errorCode" - "errorMessage" - "offerId" type: "object" properties: offerId: type: "integer" description: "ID оффера, по которому было отказ в начилении кэшбэка" format: "int64" errorCode: type: "string" description: "Код причины неначисления кэшбека" errorMessage: type: "string" description: "Детальное сообщение" SbpBankDetailsRequest: required: - "bankId" - "phoneNumber" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" isDefault: type: "boolean" description: "Являются ли реквизиты основными для бенефициара. По умолча\ нию для первых добавленных реквизитов — `true`, для следующих — `false`." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." phoneNumber: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер мобильного телефона." bankId: pattern: "^\\d{12}$" type: "string" description: "Идентификатор банка в системе быстрых платежей." Interval: required: - "endInterval" - "startInterval" type: "object" properties: startInterval: type: "string" description: "Время начала интервала. Локальное время в формате `ISO 8601`." endInterval: type: "string" description: "Время окончания интервала. Локальное время в формате `ISO\ \ 8601`." CreateForeignAgencyReceiptRequest: required: - "customerOrganization" - "incomeType" type: "object" properties: incomeType: type: "string" description: "От кого самозанятый получил доход:\n* `FROM_INDIVIDUAL` —\ \ от физического лица;\n* `FROM_LEGAL_ENTITY` — от компании;\n* `FROM_FOREIGN_AGENCY`\ \ — от иностранной компании." enum: - "FROM_INDIVIDUAL" - "FROM_LEGAL_ENTITY" - "FROM_FOREIGN_AGENCY" incomeReceivedAt: type: "string" description: "Дата и время получения дохода в UTC. Ожидается в ISO-8601\ \ формате yyyy-MM-ddTHH:mm:ss<.fff>, где:\n* HH — ча\ сы в 24-часовой нотации. Допускаются значения от 00 до 23.\n* .fff — о\ пциональная часть, содержащая доли секунд. Допускается не больше трёх\ \ знаков.\n* TZDSuffix — опциональный суффикс. Допускается значение Z\ \ или +00:00." format: "date-time" services: type: "array" description: "Список услуг." items: $ref: "#/components/schemas/ReceiptService" customerOrganization: type: "string" description: "Название организации, которой самозанятый оказывал услуги." AllTimeLimitError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Превышен лимит по кэшбэку" type: type: "string" description: "ALL_TIME_LIMIT" CreateApplicationResponse: required: - "cardIssueApplicationId" type: "object" properties: cardIssueApplicationId: type: "string" description: "ID заявки на выпуск виртуальной карты на сотрудника." format: "uuid" HoldListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество холдов для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество холдов для вывода." format: "int32" size: type: "integer" description: "Количество холдов в ответе." format: "int32" total: type: "integer" description: "Всего холдов, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список холдов." items: $ref: "#/components/schemas/HoldListItem" EmployeesInfoRequest: type: "object" properties: employeeIds: type: "array" description: "Идентификаторы сотрудников." items: type: "integer" format: "int32" CreatePaymentRegistryResultResponse: required: - "status" type: "object" properties: paymentRegistryId: type: "integer" description: "Идентификатор платежного реестра" format: "int32" status: $ref: "#/components/schemas/CreationRegistryStatus" error: required: - "errorDescription" - "fieldName" type: "object" properties: fieldName: type: "string" description: "Название поля, в котором возникла ошибка, на русском я\ зыке." errorDescription: type: "string" description: "Описание ошибки." description: "Общая ошибка, произошедшая при создании реестра." paymentErrors: type: "array" description: "Платежи внутри реестра, содержащие ошибки." items: $ref: "#/components/schemas/PaymentError" CardIssueApplicationStatusResponse: required: - "cardIssueApplicationId" - "status" type: "object" properties: cardIssueApplicationId: type: "string" description: "Идентификатор заявки на выпуск бизнес-карты." format: "uuid" status: $ref: "#/components/schemas/CardIssueApplicationStatus" failedReason: type: "string" description: "Описание причины неуспешной обработки. Возвращается только\ \ для статусов `FAILED_NON_FATAL` и `FAILED_FATAL`." ucid: type: "integer" description: "Идентификатор карты. Возвращается только для статуса `CARD_ISSUED`." format: "int64" DocumentResponse: required: - "fileName" - "id" - "mime" - "size" - "title" type: "object" properties: id: type: "string" description: "ID документа." format: "uuid" title: type: "string" description: "Тип документа." fileName: type: "string" description: "Название файла." mime: type: "string" description: "Формат файла." size: type: "integer" description: "Размер файла." format: "int64" Email: type: "object" properties: email: type: "string" description: "Электронная почта." ApiPDLResponse: required: - "isPublicOfficialPerson" type: "object" properties: isPublicOfficialPerson: type: "boolean" description: "Является ли пользователь публичным должностным лицом." BeneficiaryIpNonresidentResponse: required: - "beneficiaryId" - "birthDate" - "citizenship" - "firstName" - "lastName" - "registrationDate" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона." email: type: "string" description: "Электронная почта." documents: type: "array" description: "Документы." items: $ref: "#/components/schemas/Document2" addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" registrationDate: type: "string" description: "Дата регистрации." format: "date" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." ogrn: pattern: "^(\\d{15})$" type: "string" description: "Основной государственный регистрационный номер." CreateSelfEmployed: required: - "firstName" - "lastName" - "number" - "status" type: "object" properties: number: type: "integer" description: "Номер самозанятого, переданный клиентом при создании." format: "int32" recipientId: type: "integer" description: "Идентификатор самозанятого. Может не прийти, если при созд\ ании самозанятого возникли ошибки." format: "int32" firstName: type: "string" description: "Имя." lastName: type: "string" description: "Фамилия." middleName: type: "string" description: "Отчество." status: $ref: "#/components/schemas/CreationSelfEmployedStatus" errors: type: "array" description: "Список ошибок." items: $ref: "#/components/schemas/FieldValidationError" Recipient1: required: - "account" - "bankAccount" - "bankName" - "bik" - "inn" - "kpp" - "name" type: "object" properties: name: type: "string" inn: pattern: "^(\\d{10})$" type: "string" description: "ИНН" kpp: pattern: "^(\\d{9})$" type: "string" description: "КПП получателя" account: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." bankName: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка получателя.\n\n\nС 1 января 2021 года п\ ри заполнении платежей на перечисление налогов после названия банка ук\ азывается название счёта казначейства через знак //. " bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя.\n\n\nС 1 января 2021 года при перечи\ слении налоговых платежей указываются новые значения БИК банков получа\ теля.\n\n\nПодробнее о полях платёжного поручения " bankAccount: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя.\n\n\nС 1 января 2021\ \ года при уплате налогов указывается номер счёта банка получателя, вх\ одящий в состав единого казначейского счёта (ЕКС). Раньше это поле зап\ олнялось нулями. " EmployedSubmitPaymentError: required: - "number" type: "object" properties: number: type: "integer" description: "Идентификатор платежа, переданный клиентом при создании." format: "int32" accountNumber: type: "string" description: "Номер счёта сотрудника." errors: type: "array" description: "Ошибки валидации." items: required: - "errorDescription" - "fieldName" type: "object" properties: fieldName: type: "string" description: "Название поля, в котором возникла ошибка, на русском\ \ языке." errorDescription: type: "string" description: "Описание ошибки." SetLimitRequest: required: - "limitPeriod" - "limitValue" type: "object" properties: limitValue: maximum: 1000000000000 exclusiveMaximum: true minimum: 0 type: "number" description: "Величина лимита в валюте счёта, к которому привязана карта\ . До двух дробных знаков." limitPeriod: $ref: "#/components/schemas/InputLimitPeriod" BankInfo: required: - "bik" - "corAccount" - "name" type: "object" properties: bik: pattern: "\\d{9}" type: "string" description: "БИК." corAccount: pattern: "\\d{20}" type: "string" description: "Корреспондентский счет." name: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка." description: "Информация о банке." CreatePaymentRegistryResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" ClientMerchantCategory: required: - "categoryId" type: "object" properties: categoryId: type: "integer" description: "Id категории" format: "int64" categoryWeight: type: "integer" description: "Вес категории для клиента" format: "int32" merchantCategoryWeight: type: "integer" description: "Вес партнера в категории для клиента" format: "int32" PayStatus: type: "string" description: "Статус платежа." enum: - "IN_PROGRESS" - "EXECUTED" - "ERROR" - "SENT" SelfEmployedPaymentInfo: required: - "selfEmployedInfo" - "status" - "sum" type: "object" properties: number: type: "integer" description: "Идентификатор платежа на стороне клиента. Не возвращается\ , если платёжный реестр был создан через личный кабинет." format: "int32" status: $ref: "#/components/schemas/PaymentInfoRegistryStatus1" selfEmployedInfo: required: - "firstName" - "lastName" type: "object" properties: firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." description: "Данные самозанятого." accountNumber: type: "string" description: "Номер счёта самозанятого." paymentPurpose: type: "string" description: "Назначение платежа." sum: type: "number" description: "Сумма платежа." revenueTypeCode: type: "string" description: "Код вида дохода." enum: - "1" - "2" - "3" - "4" - "5" collectionAmount: type: "number" description: "Удержанная сумма." OfferViewRequest: required: - "offerId" - "phoneNumber" type: "object" properties: phoneNumber: type: "string" description: "Номер телефона клиента в формате E.164" offerId: type: "integer" description: "Id просмотренного оффера" format: "int64" SelfEmployedCreatePaymentRegistryRequest: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" companyAccountNumber: type: "string" description: "\nНомер счёта компании, с которого будут списаны деньги дл\ я оплаты реестра — при наличии РКО в Тинькофф.
\nЕсли номер счёта\ \ не передан, средства спишутся с основного счёта компании.\n " registryCreateType: $ref: "#/components/schemas/SelfEmployedRegistryCreateTypeRequest" payments: type: "array" description: "Список платежей внутри реестра." items: $ref: "#/components/schemas/SelfEmployedCreatePaymentInfo" taxHolding: type: "boolean" description: "\n\nЗначение по умолчанию — false." incomeType: $ref: "#/components/schemas/SelfEmployedIncomeType" CreateMeetingResponse: required: - "meetingId" type: "object" properties: meetingId: type: "string" description: "Идентификатор назначенной встречи" CreateJobInfo: required: - "position" type: "object" properties: position: type: "string" description: "Должность." description: "Информация о работе." Phone1: required: - "type" type: "object" properties: type: $ref: "#/components/schemas/PhoneType1" number: type: "string" description: "Номер телефона." BeneficiaryIpNonresidentRequest: required: - "addresses" - "birthDate" - "citizenship" - "documents" - "firstName" - "inn" - "lastName" - "registrationDate" - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона. phoneNumber или email обязателен к заполне\ нию." email: type: "string" description: "Электронная почта. phoneNumber или email обязателен к запо\ лнению." documents: minItems: 1 type: "array" description: "\nДокументы. Обязательно — минимум 2 документа. Основной д\ окумент нерезидента РФ в большинстве случаев — `FOREIGN_PASSPORT`. Вто\ рой документ — любой из документов, подтверждающих право на пребывание\ \ в РФ. Подробнее о документах.\n\n\n Для нерезидентов с гражданством BY\ \ достаточно 1 документа с типом `FOREIGN_PASSPORT`\n" items: $ref: "#/components/schemas/Document2" addresses: minItems: 1 type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" registrationDate: type: "string" description: "Дата регистрации." format: "date" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." ogrn: pattern: "^(\\d{15})$" type: "string" description: "Основной государственный регистрационный номер." BeneficiaryListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество бенефициаров для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество бенефициаров для вывода." format: "int32" size: type: "integer" description: "Количество бенефициаров в ответе." format: "int32" total: type: "integer" description: "Всего бенефициаров у компании." format: "int32" results: type: "array" description: "Список бенефициаров." items: $ref: "#/components/schemas/BeneficiaryResponse" FieldValidationError1: required: - "errorDescription" - "fieldName" type: "object" properties: fieldName: type: "string" description: "Название поля с ошибкой." errorDescription: type: "string" description: "Описание ошибки." AboveMaxAmountError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Сумма чека больше необходимой" type: type: "string" description: "ABOVE_MAX_AMOUNT" CardInfoSeqResponse: required: - "limit" - "offset" - "totalNumber" type: "object" properties: cards: type: "array" description: "Список карт компании." items: $ref: "#/components/schemas/CardInfoResponse" offset: type: "integer" description: "Количество пропущенных карт." format: "int32" limit: type: "integer" description: "Количество карт на странице." format: "int32" totalNumber: type: "integer" description: "Общее количество карт." format: "int32" PaymentRegistryStatus1: type: "string" description: "Статус платёжного реестра:
" enum: - "DRAFT" - "ERROR" - "ACCEPTED" - "EXECUTED" - "PART_EXEC" - "REJECTED" - "CANCELLED" - "DELETED" CardType: type: "string" description: "Тип карты — кредитная или дебетовая." enum: - "CREDIT" - "DEBIT" SelfEmployedPaymentRegistryResultSubmitResponse: required: - "paymentRegistryId" - "status" type: "object" properties: paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" status: $ref: "#/components/schemas/SubmissionStatus1" error: required: - "errorCode" - "errorMessage" type: "object" properties: errorCode: type: "string" description: "Код ошибки." errorMessage: type: "string" description: "Описание ошибки." description: "Общая ошибка, произошедшая при создании реестра." paymentErrors: type: "array" description: "Платежи внутри реестра, содержащие ошибки." items: $ref: "#/components/schemas/SubmitPaymentError" IdentifyIncomingTransactionRequest: type: "object" properties: amountDistribution: type: "array" description: "Список распределений по бенефициарам." items: $ref: "#/components/schemas/AmountDistributionItem" DeclarationType: type: "string" description: "Тип декларации." enum: - "Primary" - "Clarifying" ReceiverRequisites: required: - "accountNumber" - "bik" - "inn" - "name" type: "object" properties: name: type: "string" description: "Получатель." inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "\nИНН получателя. Если платёж выполняется в пользу физ. ли\ ца\nи его ИНН неизвестен, передайте `0`.\nВо всех остальных случаях пе\ редавайте фактический ИНН получателя.\n" kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП получателя." bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя.\n\n\nС 1 января 2021 года при перечи\ слении налоговых платежей указываются новые значения БИК банков получа\ теля.\n\n\nПодробнее о полях платёжного поручения " bankName: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка получателя.\n\n\nС 1 января 2021 года п\ ри заполнении платежей на перечисление налогов после названия банка ук\ азывается название счёта казначейства через знак //. " corrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя.\n\n\nС 1 января 2021\ \ года при уплате налогов указывается номер счёта банка получателя, вх\ одящий в состав единого казначейского счёта (ЕКС). Раньше это поле зап\ олнялось нулями. " accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчетного счета. ВАЖНО: Для бюджетных платежей с 01.01.2021\ \ в данном поле нужно указывать новые номера казначейских счетов." description: "Реквизиты получателя платежа." CreatePaymentRegistryRequest: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" companyAccountNumber: type: "string" description: "\nНомер счёта компании, с которого будут списаны деньги дл\ я оплаты реестра (при наличии РКО в Тинькофф).
\nЕсли номер счёта\ \ не передан, средства спишутся с основного счёта компании.\n " loadDate: type: "string" description: "Дата отправки реестра" registryCreateType: $ref: "#/components/schemas/EmployeeRegistryCreateTypeRequest" payments: type: "array" description: "Список платежей внутри реестра." items: $ref: "#/components/schemas/CreatePaymentInfo" PhoneType2: type: "string" description: "Тип телефона" enum: - "MOBILE" - "HOME" - "WORK" - "OTHER" RegistrationInfo: required: - "oktmo" type: "object" properties: oktmo: type: "string" description: "ОКТМО." activityCodes: type: "array" description: "Коды активностей." items: type: "string" description: "Информация, которая использовалась при постановке на учёт." SelfEmployed: required: - "bankInfo" - "firstName" - "id" - "lastName" - "selfEmployedStatus" - "status" type: "object" properties: id: type: "integer" description: "Идентификатор самозанятого." format: "int32" status: $ref: "#/components/schemas/EmployeeStatus1" selfEmployedStatus: $ref: "#/components/schemas/SelfEmployedStatus" firstName: type: "string" description: "Имя." lastName: type: "string" description: "Фамилия." middleName: type: "string" description: "Отчество." birthDate: type: "string" description: "Дата рождения." format: "date" phones: type: "array" description: "Номера телефонов." items: $ref: "#/components/schemas/Phone1" documents: type: "array" description: "Документы." items: $ref: "#/components/schemas/Document1" registrationInfo: $ref: "#/components/schemas/RegistrationInfo" bankInfo: $ref: "#/components/schemas/BankInfo2" inn: type: "string" description: "ИНН самозанятого." creationDate: type: "string" description: "Дата создания самозанятого." format: "date-time" CobrandAccount: required: - "cardType" - "loyaltyId" type: "object" properties: cardType: $ref: "#/components/schemas/CardType" loyaltyId: type: "string" description: "Номер программы лояльности." BankDetailsRequest: oneOf: - $ref: "#/components/schemas/CardBankDetailsRequest" - $ref: "#/components/schemas/RkcBankDetailsRequest" - $ref: "#/components/schemas/SbpBankDetailsRequest" PendingAddCardRequestResponse: required: - "addCardRequestId" - "addCardUrl" - "beneficiaryId" - "status" - "terminalKey" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" addCardRequestId: type: "string" description: "Идентификатор запроса на добавление карты." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." status: type: "string" description: "Статус запроса на добавление карты:\n* `PENDING` — карта в\ \ процессе добавления.\n* `READY` — карта успешно добавлена.\n* `FAILED`\ \ — не удалось добавить карту." enum: - "PENDING" - "READY" - "FAILED" addCardUrl: type: "string" description: "Ссылка на страницу добавления карты. Чтобы добавить карту\ , переадресуйте клиента на эту страницу." ActiveOffer: required: - "disableAutoCharge" - "id" - "merchantName" - "offerType" - "single" type: "object" properties: id: type: "integer" description: "Уникальный id оффера" format: "int64" openDate: type: "string" description: "Дата начала действия оффера для клиентов" format: "date-time" closeDate: type: "string" description: "Дата завершения действия оффера для клиентов" format: "date-time" advert: $ref: "#/components/schemas/ActiveOfferAdvert" boundMoneyMax: type: "integer" description: "Ограничение по сумме покупке сверху" format: "int64" boundMoneyMin: type: "integer" description: "Ограничение по сумме покупке снизу" format: "int64" topBorder: type: "integer" description: "Верхняя планка кэшбэка" format: "int64" cashbackAmount: type: "integer" description: "Фиксированный размер бонуса" format: "int64" cashbackPercent: type: "integer" description: "Процент начисления бонуса" format: "int64" numberOfRealised: type: "integer" description: "Количество покупок, на которое распространяется спецпредло\ жение" format: "int64" single: type: "boolean" description: "Флаг оффера на одну покупку" adultsOnly: type: "boolean" description: "Флаг, позволяющий идентифицировать офферы с ограничением п\ о возрасту 18+" offerType: type: "string" description: "Тип оффера. Доступные значения 'STANDARD', 'SPECIAL_CREDIT'" merchantName: type: "string" description: "Наименование партнера" web: type: "string" description: "Сайт партнера" merchantSubcategory: type: "string" description: "Подкатегория партнера" onlineSale: type: "boolean" description: "Флаг онлайн признака - оффер действует на покупки онлайн" merchantCategories: type: "array" description: "Категории партнера" items: $ref: "#/components/schemas/MerchantCategory" image280: type: "string" description: "Ссылка на лейбл, лого" image1252: type: "string" description: "Ссылка на картинку оффера размера 1252" image626: type: "string" description: "Ссылка на картинку оффера размера 626" daysForCharge: type: "integer" description: "Количество дней, в течение которых ожидается начисление бо\ нуса" format: "int64" disableAutoCharge: type: "boolean" description: "Флаг, позволяющий идентифицировать, будут ли ожидаться доп\ олнительные действия для начисления бонуса" Passport2: required: - "number" - "series" - "type" type: "object" properties: type: $ref: "#/components/schemas/IdentificationDocumentType" number: type: "string" description: "Номер документа" series: type: "string" description: "Серия документа" divisionName: type: "string" description: "Подразделение" issueDate: type: "string" description: "Дата выдачи документа" format: "date" FieldValidationError: required: - "errorDescription" - "fieldName" type: "object" properties: fieldName: type: "string" description: "Название поля, в котором возникла ошибка, на русском языке\ ." errorDescription: type: "string" description: "Описание ошибки." AuthenticationFailedResponse: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." errorCode: maxLength: 50 type: "string" description: "Код ошибки." SelfEmployedReceiptsStatus: type: "string" description: "Результат регистрации дохода:
" enum: - "IN_PROGRESS" - "SUCCESS" - "CANCELED" - "FISCALIZE_FAILED" - "ERROR" CashbackBalanceResponse: required: - "allTimeCashback" - "balance" - "monthCashback" type: "object" properties: balance: type: "number" description: "Текущий баланс кэшбэка клиента" monthCashback: type: "number" description: "Кэшбэк заработанный за календарный месяц" allTimeCashback: type: "number" description: "Кэшбэк заработанный за всё время" DebitAccountsResponse: type: "object" properties: accounts: type: "array" description: "Cчета." items: $ref: "#/components/schemas/DebitAccount" Operation: required: - "amount" - "cardNumber" - "rrn" - "transactionDate" - "type" type: "object" properties: rrn: type: "string" description: "Идентификатор банковской транзакции." transactionDate: type: "string" description: "Дата совершения операции в UTC. Формат — `yyyy-MM-ddTHH:mm:ssZ`." format: "date-time" amount: type: "integer" description: "Сумма операции в копейках." format: "int64" cardNumber: type: "string" description: "Номер карты." type: $ref: "#/components/schemas/OperationType" ReissueVirtualCardResultResponse: oneOf: - required: - "info" - "status" type: "object" properties: info: $ref: "#/components/schemas/ReissuedVirtualCardInfo" status: type: "string" description: "Статус заявки на перевыпуск виртуальной карты. status =\ \ READY - карта успешно перевыпущена, вы можете ей пользоваться" enum: - "READY" - "IN_PROGRESS" - "ERROR" - required: - "status" type: "object" properties: status: type: "string" description: "Статус заявки на перевыпуск виртуальной карты. status =\ \ ERROR - произошла ошибка при обработке заявки, попробуйте отправит\ ь новую" enum: - "READY" - "IN_PROGRESS" - "ERROR" - required: - "status" type: "object" properties: status: type: "string" description: "Статус заявки на перевыпуск виртуальной карты. status =\ \ IN_PROGRESS - заявка в работе, проверьте результат через некоторое\ \ время (обычно заявка исполняется в течение 5 минут)" enum: - "READY" - "IN_PROGRESS" - "ERROR" ForeignPassport: required: - "date" - "number" - "organization" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" organization: type: "string" description: "Кем выдан." CreateRegistryPaymentRequest: required: - "accountNumber" - "id" - "paymentRegistryId" - "purpose" type: "object" properties: id: maxLength: 64 minLength: 1 type: "string" description: "Идентификатор платежа. Должен быть уникален в пределах инт\ еграции." paymentRegistryId: type: "integer" description: "Идентификатор платежного реестра. Реестр должен находиться\ \ в статусе ACCEPTED." format: "int32" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта для списания." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." documentNumber: minimum: 1 type: "integer" description: "Номер распоряжения, определяемый клиентом. Заполняется на\ \ усмотрение плательщика. Номер документа — не больше 6 цифр. " format: "int32" executionOrder: maximum: 5 minimum: 1 type: "integer" description: "Очерёдность платежа." format: "int32" deprecated: true dueDate: type: "string" description: "Дата, до которой нужно провести платёж. При неуспешных поп\ ытках платежа он будет повторён вплоть до указанной даты. Если дату не\ \ передать, платёж не будет повторён в случае неуспешной попытки. Врем\ я на проведение платежа не может быть больше 30 дней." format: "date-time" meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON. Сохраняются при\ \ создании платежа и возвращаются при получении статуса." ApplicationResult: type: "string" description: "Результат по заявке со статусом DONE." enum: - "REGISTERED" - "DEREGISTERED" - "REGISTRATION_DENIED" - "DEREGISTRATION_DENIED" - "DEREGISTRATION_ERROR" - "REGISTRATION_ERROR" TaxReturnReasonResponse: required: - "title" type: "object" properties: title: type: "string" description: "Название группы налоговых вычетов." options: maxItems: 100 type: "array" description: "Детализация налоговых вычетов в рамках группы." items: $ref: "#/components/schemas/OptionResponse" BeneficiaryResponse: oneOf: - $ref: "#/components/schemas/BeneficiaryFlNonresidentResponse" - $ref: "#/components/schemas/BeneficiaryFlResidentResponse" - $ref: "#/components/schemas/BeneficiaryIpNonresidentResponse" - $ref: "#/components/schemas/BeneficiaryIpResidentResponse" - $ref: "#/components/schemas/BeneficiaryLiteContactResponse" - $ref: "#/components/schemas/BeneficiaryUlNonresidentResponse" - $ref: "#/components/schemas/BeneficiaryUlResidentResponse" Vat: type: "string" description: "НДС. `None` — без НДС." enum: - "None" - "0" - "10" - "18" - "20" Info: required: - "oktmo" - "registeredAt" type: "object" properties: registeredAt: type: "string" description: "Дата и время последней постановки на учет в UTC. Возвращае\ тся в формате ISO-8601." format: "date-time" activityCodes: type: "array" description: "Виды деятельности, которые самозанятый указал при регистра\ ции." items: type: "string" oktmo: type: "string" description: "Регион деятельности самозанятого." permissions: type: "array" description: "Список прав, которые самозанятый выдал Тинькофф." items: $ref: "#/components/schemas/PermissionTypeEnum" CreationSelfEmployedStatus: type: "string" description: "\nСтатус создания:\n\n\n " enum: - "CREATED" - "ERROR" - "QUEUED" CreateAddress: required: - "postalCode" - "state" - "type" type: "object" properties: type: $ref: "#/components/schemas/AddressType" country: type: "string" description: "Страна." postalCode: type: "string" description: "Индекс." state: type: "string" description: "Регион." city: type: "string" description: "Город." district: type: "string" description: "Район." settlement: type: "string" description: "Населённый пункт." street: type: "string" description: "Улица." house: type: "string" description: "Дом." building: type: "string" description: "Здание." construction: type: "string" description: "Корпус." apartment: type: "string" description: "Квартира." SelfEmployedStatus: type: "string" description: "Статус самозанятости:
" enum: - "REGISTRATION_WAIT" - "NOT_CONFIRM" - "NOT_ACTIVE" - "ACTIVE" FromForeignAgencyReceiptResponse: required: - "customerOrganization" - "incomeReceivedAt" - "incomeStatedAt" - "incomeType" - "receiptId" - "status" - "totalAmount" type: "object" properties: receiptId: type: "string" description: "Идентификатор чека." format: "uuid" incomeType: type: "string" description: "От кого самозанятый получил доход." enum: - "FROM_INDIVIDUAL" - "FROM_LEGAL_ENTITY" - "FROM_FOREIGN_AGENCY" incomeReceivedAt: type: "string" description: "Дата и время получения дохода в UTC. Возвращается в формат\ е ISO-8601." format: "date-time" incomeStatedAt: type: "string" description: "Дата и время заявления дохода в UTC. Возвращается в формат\ е ISO-8601." format: "date-time" status: $ref: "#/components/schemas/ReceiptStatus" totalAmount: type: "number" description: "Сумма заявленного дохода." services: type: "array" description: "Массив объектов с информацией об оказанных услугах." items: $ref: "#/components/schemas/ReceiptService" operations: type: "array" description: "Массив объектов с информацией по операциям, произведённым\ \ с чеком." items: $ref: "#/components/schemas/ReceiptOperation" customerOrganization: type: "string" description: "Название компании-заказчика, которой самозанятый оказывал\ \ услуги." tinkoffLink: type: "string" description: "Ссылка на временный чек в случае недоступности сервисов ФН\ С." fnsLink: type: "string" description: "Ссылка на чек в случае успешной регистрации в ФНС." TaxPaymentParameters: required: - "docDate" - "docNumber" - "evidence" - "kbk" - "oktmo" - "payerStatus" - "period" type: "object" properties: payerStatus: pattern: "\\d{2}" type: "string" description: "Статус составителя расчётного документа. Поле платёжки 101.\n\ \n\nПри оплате налога за третьих лиц указывается налоговый статус чело\ века, за которого происходит оплата. Может принимать следующие значени\ я:\n\nСтатус плательщика в платежном поручении в 2021 году — Бухонлайн (buhonline.ru)\n\ \ " kbk: pattern: "\\d{20}|0" type: "string" description: "Код бюджетной классификации. Поле платёжки 104. Подробнее." oktmo: pattern: "\\d{8}|\\d{11}|0" type: "string" description: "Код ОКТМО территории, на которой мобилизуются денежные сре\ дства от уплаты налога, сбора и иного платежа. Поле платёжки 105.\nПодробнее." evidence: pattern: "[A-Za-zА-Яа-я]{2}|00|0" type: "string" description: "Основание налогового платежа. Поле платёжки 106. Может при\ нимать следующие значения:\n\nНовые правила заполнения поля 106 платёжных поручений с 1 октября 2021\ \ года (26-2.ru)\n " period: pattern: "^(0)$|^(\\d{8})$|^(.{2}\\.\\d{2}\\.\\d{4})$" type: "string" description: "Налоговый период. Поле платёжки 107.\nФормат — ДД.ММ.ГГГГ\ , первые два символа могут быть буквами или цифрами. В поле можно пере\ дать `0`.\nПодробнее." docNumber: pattern: "[A-Za-zА-Яа-я]{2}\\d{13}|\\d{2};\\d{1,20}|[A-Za-zА-Яа-я]{2}|0{1}" type: "string" description: "Номер налогового документа. Поле платёжки 108. [Как заполн\ ить поля платёжного поручения без ошибок](https://azbuha.ru/uchet-denezhnyx-sredstv/kak-zapolnit-polya-platezhnogo-porucheniya/#:~:text=%D0%92%20%D0%BF%D0%BE%D0%BB%D0%B5%20108%20%D1%81%D1%82%D0%B0%D0%B2%D0%B8%D1%82%D1%81%D1%8F%20%C2%AB0%C2%BB%2C,%D0%9F%D0%BE%D0%BB%D0%B5%20109%20%C2%AB%D0%94%D0%B0%D1%82%D0%B0%20%D0%BE%D1%81%D0%BD%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%B0%C2%BB)." docDate: pattern: "\\d{2}\\.\\d{2}\\.\\d{4}|0" type: "string" description: "Дата налогового документа. Поле платёжки 109. Формат — ДД\ .ММ.ГГГГ или 0.\nПодробнее." thirdParty: $ref: "#/components/schemas/TaxThirdParty" description: "Реквизиты для уплаты налогов и иных бюджетных платежей." InProgress1: required: - "status" type: "object" properties: status: type: "string" description: "Статус проверки бенефициара. Если статус IN_PROGRESS\ \ — проверка в процессе, проверьте результат через некоторое время." enum: - "READY" - "IN_PROGRESS" BeneficiaryFlResidentResponse: required: - "beneficiaryId" - "birthDate" - "firstName" - "isSelfEmployed" - "lastName" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." isSelfEmployed: type: "boolean" description: "Самозанятый." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона." email: type: "string" description: "Электронная почта почта." documents: type: "array" description: "Документы." items: $ref: "#/components/schemas/Document2" addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." snils: pattern: "^(\\d{11})$" type: "string" description: "СНИЛС." EmployeesResponse: required: - "firstName" - "lastName" - "number" - "status" type: "object" properties: number: type: "integer" description: "Номер сотрудника, переданный клиентом при создании." format: "int32" employeeId: type: "integer" description: "Идентификатор сотрудника в зарплатном проекте. Может не пр\ ийти, если при создании сотрудника возникли ошибки." format: "int32" firstName: type: "string" description: "Имя." lastName: type: "string" description: "Фамилия." middleName: type: "string" description: "Отчество." status: $ref: "#/components/schemas/CreationEmployedStatus" errors: type: "array" description: "Список ошибок." items: required: - "errorDescription" - "fieldName" type: "object" properties: fieldName: type: "string" description: "Название поля, в котором возникла ошибка, на русском\ \ языке." errorDescription: type: "string" description: "Описание ошибки." SelfEmployedIncomeType: type: "string" description: "\nМожет принимать одно из двух значений:\n\nЗначение\ \ по умолчанию — FROM_LEGAL_ENTITY.\n" enum: - "FROM_LEGAL_ENTITY" - "FROM_INDIVIDUAL" Phone: required: - "type" type: "object" properties: type: $ref: "#/components/schemas/PhoneType" number: type: "string" description: "Номер телефона." InProgress: required: - "beneficiaryId" - "status" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" status: type: "string" description: "Статус проверки в финансовом мониторинге." enum: - "IN_PROGRESS" - "READY" ClientData: required: - "taxPayerStatus" type: "object" properties: taxPayerStatus: type: "string" description: "Статус налогоплательщика." description: "Данные клиента." BankDetailsResponse: oneOf: - $ref: "#/components/schemas/CardBankDetailsResponse" - $ref: "#/components/schemas/RkcBankDetailsResponse" - $ref: "#/components/schemas/SbpBankDetailsResponse" SubmissionStatus: type: "string" description: "Статус подписания платёжного реестра." enum: - "ACCEPTED" - "ERROR" - "IN_PROGRESS" IncomeRec: required: - "recCode" - "recSum" type: "object" properties: recCode: type: "string" description: "Код вычета" recSum: type: "number" description: "Сумма вычета" FailedAddCardRequestResponse: required: - "addCardRequestId" - "beneficiaryId" - "errorMessage" - "status" - "terminalKey" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" addCardRequestId: type: "string" description: "Идентификатор запроса на добавление карты." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." status: type: "string" description: "Статус запроса на добавление карты:\n* `PENDING` — карта в\ \ процессе добавления.\n* `READY` — карта успешно добавлена.\n* `FAILED`\ \ — не удалось добавить карту." enum: - "PENDING" - "READY" - "FAILED" errorMessage: type: "string" description: "\nКраткое сообщение об ошибке с кодом в формате `{Description}\ \ [{Code}]`.\nСписок кодов ошибок с описанием.\n" BeneficiariesPassport: required: - "address" - "birthDate" - "birthPlace" - "citizenship" - "issueDate" - "serialNumber" - "unitCode" - "unitName" type: "object" properties: birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: type: "string" description: "Гражданство." serialNumber: type: "string" description: "Серия и номер паспорта." unitName: type: "string" description: "Место выдачи паспорта." issueDate: type: "string" description: "Дата выдачи паспорта." format: "date" unitCode: type: "string" description: "Код подразделения." address: type: "string" description: "Адрес регистрации." description: "Паспорт." AuthorizationFailedResponse: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." errorCode: maxLength: 50 type: "string" description: "Код ошибки." CardLimitsResponse: required: - "cashLimit" - "spendLimit" - "ucid" type: "object" properties: ucid: type: "integer" description: "Уникальный идентификатор карты." format: "int64" spendLimit: $ref: "#/components/schemas/SpendLimit" cashLimit: $ref: "#/components/schemas/CashLimit" CreateDocumentType: type: "string" description: "Тип документа." enum: - "Паспорт" - "Иностранный паспорт" - "Загр. паспорт иностранного гр." - "Служебный/официальный паспорт" - "Дипломатический паспорт" - "Миграционная карта" - "Разр. на временное проживание" - "Виза" - "Вид на жительство" DocumentType3: type: "string" enum: - "Ndfl2" - "TaxReport" - "ForeignIncomeStatement" - "IisOpen" - "IisPaymentOrder" CreateSelfEmployedRegistrationInfo: required: - "activityCodes" - "oktmo" type: "object" properties: oktmo: type: "string" description: "ОКТМО." activityCodes: type: "array" description: "Коды активностей." items: type: "string" description: "Если значение передано, Тинькофф поставит исполнителя на учёт\ \ как самозанятого. Функция доступна клиентам, которые получили от исполни\ телей согласие на регистрацию." RetryPaymentResponse: required: - "retryPaymentId" type: "object" properties: retryPaymentId: type: "string" description: "Идентификатор повторённого платежа." format: "uuid" TacqTerminalsResponse: required: - "first" - "last" - "totalElements" - "totalPages" type: "object" properties: totalPages: type: "integer" description: "Общее количество страниц с данными по запросу клиента." format: "int64" totalElements: type: "integer" description: "Общее количество элементов (терминалов) на всех страницах." format: "int64" first: type: "boolean" description: "Флаг первой страницы." last: type: "boolean" description: "Флаг последней страницы." terminals: type: "array" description: "Страница данных с терминалами." items: $ref: "#/components/schemas/Terminal" TaxPaymentResponse: required: - "accountNumber" - "amount" - "bankDetails" - "beneficiaryId" - "paymentId" - "purpose" - "status" - "tax" - "type" - "uin" type: "object" properties: type: type: "string" description: "Тип платежа:\n* `REGULAR` — обычный.\n* `TAX` — налоговый." enum: - "REGULAR" - "TAX" paymentId: type: "string" description: "Идентификатор платежа." format: "uuid" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." bankDetails: $ref: "#/components/schemas/BankDetails" amount: type: "number" description: "Сумма платежа." status: type: "string" description: "Статус платежа \n\n![payment-statuses](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/payment-statuses.svg)\n\ * `PENDING` — Ожидает обработки.\n* `IN_PROGRESS` — В процессе.\n* `FAILED`\ \ — Неуспешен.\n* `CANCELLED` — Отменен.\n* `SUCCEEDED` — Успешно заве\ ршен." enum: - "PENDING" - "IN_PROGRESS" - "FAILED" - "CANCELLED" - "SUCCEEDED" errorMessage: type: "string" description: "Описание ошибки в случае неуспешности платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." uin: pattern: "0|[А-Яа-яA-Za-z0-9]{4}|[А-ЯA-Z0-9]{15}|[а-яА-Яa-zA-Z0-9№\\s!\"\ #$%;'()*+,-\\.\\/:;;=>?@\\]\\[\\\\\\^_`{|}~]{20}|[а-яА-Яa-zA-Z0-9№\\s!\"\ #$%;'()*+,-\\.\\/:;;=>?@\\]\\[\\\\\\^_`{|}~]{25}" type: "string" description: "Уникальный идентификатор платежа." tax: $ref: "#/components/schemas/TaxPaymentParameters" operationId: type: "string" description: "Уникальный ID операции." format: "uuid" ImmediateReceiptResponse: required: - "cashbackAmount" - "totalBalance" type: "object" properties: totalBalance: type: "number" description: "Текущий баланс кэшбэка клиента" cashbackAmount: type: "number" description: "Кэшбэк, начисленный за чек" accruals: type: "array" description: "Список офферов, за которые начислен кэшбэк" items: $ref: "#/components/schemas/AccrualDto" offerIds: type: "array" description: "Список офферов, за которые начислен кэшбэк" items: type: "integer" format: "int64" delayedChargeOfferIds: type: "array" description: "Список офферов, за которые ожидается начисление кэшбэка" items: type: "integer" format: "int64" rejectedOffers: type: "array" description: "Причины отклонения начислений на офферы" items: $ref: "#/components/schemas/RejectDto" PaymentRegistrySubmitResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" OperationType: type: "string" description: "Тип операции." enum: - "Debit" - "Credit" - "Other" RkcBankDetailsResponse: required: - "accountNumber" - "bankDetailsId" - "bankName" - "beneficiaryId" - "bik" - "corrAccountNumber" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" isDefault: type: "boolean" description: "Являются ли реквизиты основными для бенефициара. По умолча\ нию для первых добавленных реквизитов — `true`, для следующих — `false`." bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя.\n\n\nС 1 января 2021 года при перечи\ слении налоговых платежей указываются новые значения БИК банков получа\ теля.\n\n\nПодробнее о полях платёжного поручения " kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП получателя. Укажите 0, чтобы не заполнять" inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН. Укажите 0, чтобы не заполнять." name: maxLength: 160 type: "string" description: "Наименование получателя." bankName: maxLength: 160 minLength: 1 type: "string" description: "Наименование банка получателя." accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта получателя." corrAccountNumber: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя." Document2: description: "Документ бенефициара:" oneOf: - $ref: "#/components/schemas/Contract" - $ref: "#/components/schemas/ContractGPD" - $ref: "#/components/schemas/DiplomaticPassport" - $ref: "#/components/schemas/ForeignPassport" - $ref: "#/components/schemas/ForeignPassportOfForeignCitizens" - $ref: "#/components/schemas/MigrationCard" - $ref: "#/components/schemas/OfficialPassport" - $ref: "#/components/schemas/Passport" - $ref: "#/components/schemas/Patent" - $ref: "#/components/schemas/ResidencePermit" - $ref: "#/components/schemas/TemporaryResidencePermit" - $ref: "#/components/schemas/Visa" PaymentResponse: oneOf: - $ref: "#/components/schemas/RegularPaymentResponse" - $ref: "#/components/schemas/TaxPaymentResponse" CreatePaymentRequest: required: - "amount" - "from" - "id" - "purpose" - "to" type: "object" properties: id: maxLength: 64 minLength: 1 type: "string" description: "Идентификатор платежа. Должен быть уникален в пределах инт\ еграции." from: $ref: "#/components/schemas/PayerRequisites" to: $ref: "#/components/schemas/ReceiverRequisites" uin: pattern: "0|[А-Яа-яA-Za-z0-9]{4}|[А-ЯA-Z0-9]{15}|[а-яА-Яa-zA-Z0-9№\\s!\"\ #$%;'()*+,-\\.\\/:;;=>?@\\]\\[\\\\\\^_`{|}~]{20}|[а-яА-Яa-zA-Z0-9№\\s!\"\ #$%;'()*+,-\\.\\/:;;=>?@\\]\\[\\\\\\^_`{|}~]{25}" type: "string" description: "Уникальный идентификатор платежа. Поле платёжки 22.\nОбяза\ тельное поле для налоговых платежей.\nПодробнее." tax: $ref: "#/components/schemas/TaxPaymentParameters" purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа.\n\n\nПри заполнении назначения платежа\ \ для налоговых платежей за третьих лиц следуйте шаблону:\nИНН того, к\ то перечисляет / КПП того, кто перечисляет / наименование лица, за кот\ орого происходит оплата / назначение платежа.\nПодробнее." documentNumber: minimum: 1 type: "integer" description: "Номер распоряжения, определяемый клиентом. Заполняется на\ \ усмотрение плательщика. Номер документа — не больше 6 цифр. " format: "int32" executionOrder: maximum: 5 minimum: 1 type: "integer" description: "Очерёдность платежа. По умолчанию — 5.\n\n\n\ 1 — алиментные удержания из заработной платы, компенсации\ \ вреда жизни и здоровью. Основания для уплаты — алиментный договор, з\ аверенный у нотариуса, судебный приказ, исполнительный лист от судебны\ х приставов.\n\n2 — погашение задолженностей по зарплата\ м сотрудникам, выплаты выходных пособий и авторских вознаграждений. Ос\ нование для уплаты — исполнительный лист, судебный приказ.\n\n3\ \ — выплаты зарплат сотрудникам по трудовым соглашениям, принудительна\ я уплата налогов и отчислений во внебюджетные фонды. Основание для упл\ аты — расчётная документация, платёжные требования и инкассовые поруче\ ния от ИФНС, ФСС, ПФР.\n\n4 — принудительные выплаты, кот\ орые не вошли в первую, вторую и третью очередь, например задолженност\ и по договорам, штрафы, неустойки, коммунальные платежи. Основание для\ \ уплаты — исполнительные документы, требования, постановления, приказ\ ы, судебные решения.\n\n5 — все остальные, не вошедшие в\ \ первую, вторую, третью и четвёртую категории — например, добровольна\ я уплата долгов, пеней, штрафов.\n\nПодробнее" format: "int32" amount: type: "number" description: "Сумма платежа в рублях." dueDate: type: "string" description: "Дата, до которой нужно провести платёж. При неуспешных поп\ ытках платежа он будет повторён вплоть до указанной даты. Если дату не\ \ передать, платёж не будет повторён в случае неуспешной попытки. Врем\ я на проведение платежа не может быть больше 30 дней." format: "date-time" revenueTypeCode: type: "string" description: "Код вида выплаты. Подробнее." enum: - "1" - "2" - "3" - "4" - "5" collectionAmount: type: "number" description: "Удержанная сумма из заработной платы и иных доходов работн\ ика в рублях. Подробнее\ ." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON. Сохраняются при\ \ создании платежа и возвращаются при получении статуса." PaymentRegistryResponse: required: - "paymentsCount" - "status" - "totalSum" type: "object" properties: status: $ref: "#/components/schemas/PaymentRegistryStatus" companyAccountNumber: type: "string" description: "\nНомер счёта компании, с которого будут списаны деньги дл\ я оплаты реестра — при наличии РКО в Тинькофф.
\nЕсли номер счёта\ \ не передан, средства спишутся с основного счёта компании.\n " loadDate: type: "string" description: "Дата отправки реестра." paymentsCount: type: "integer" description: "Количество платежей в реестре." format: "int32" totalSum: type: "number" description: "Общая сумма платежей в реестре." payments: type: "array" description: "Список платежей внутри реестра." items: $ref: "#/components/schemas/PaymentInfo" SendReceiptRequest: required: - "phoneNumber" - "qrCodeAsString" type: "object" properties: phoneNumber: type: "string" description: "Номер телефона клиента в формате E.164" qrCodeAsString: type: "string" description: "Содержимое qr кода чека" offerId: type: "integer" description: "id оффера, в рамках которого клиент предполагает получить\ \ кэшбэк" format: "int64" CreatePaymentDraftResponse: required: - "documentId" type: "object" properties: documentId: type: "string" description: "Идентификатор созданного черновика." format: "uuid" Empty: type: "object" CreateDraftResponse: required: - "applicationId" type: "object" properties: applicationId: type: "string" description: "ID созданной заявки на удалённую идентификацию." format: "uuid" OptionResponse: required: - "title" type: "object" properties: title: type: "string" description: "Название детализации." documents: maxItems: 100 type: "array" description: "Документы, приложенные к анкете." items: $ref: "#/components/schemas/DocumentResponse" BeneficiaryScoringInfo: oneOf: - $ref: "#/components/schemas/InProgress" - $ref: "#/components/schemas/Ready" AccrualsDayLimitExceeded: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Лимит начислений в день превышен" type: type: "string" description: "ACCRUALS_DAY_LIMIT_EXCEEDED" CreateAndSendInvoiceRequest: required: - "invoiceNumber" type: "object" properties: invoiceNumber: pattern: "^\\d{1,15}$" type: "string" description: "Номер счёта." dueDate: type: "string" description: "Срок оплаты. Должен быть не меньше даты выставления счёта." format: "date" invoiceDate: type: "string" description: "Дата выставления счёта. Если не указана, счёт выставляется\ \ текущей датой." format: "date" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Рублёвый расчётный счёт отправителя. Если счёт не указан,\ \ для выставления счёта будет использоваться главный счёт компании." payer: $ref: "#/components/schemas/InvoicePayerInfo" items: type: "array" description: "Позиции счёта." items: $ref: "#/components/schemas/InvoiceItemInfo" contacts: type: "array" description: "Контакты для получения счёта." items: $ref: "#/components/schemas/Email" contactPhone: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер мобильного телефона, на который придет СМС-сообщение\ \ со счётом." comment: maxLength: 1000 minLength: 1 type: "string" description: "Комментарий." BalanceListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество балансов для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество балансов для вывода." format: "int32" size: type: "integer" description: "Количество балансов в ответе." format: "int32" total: type: "integer" description: "Всего балансов, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список балансов." items: $ref: "#/components/schemas/BalanceListItem" TaxReport: type: "object" properties: finalCalcs: type: "array" items: $ref: "#/components/schemas/TaxReportCalculation" CardStatus: type: "string" description: "\nСтатус карты:\n" enum: - "NORM" - "CLOSED" - "BLOCKED" CreatePaymentInfo: required: - "accountNumber" - "employeeInfo" - "number" - "paymentPurpose" - "sum" type: "object" properties: number: type: "integer" description: "Идентификатор платежа на стороне клиента." format: "int32" accountNumber: type: "string" description: "Номер счёта сотрудника." paymentPurpose: type: "string" description: "Назначение платежа данному сотруднику в рамках зарплатного\ \ реестра." employeeInfo: required: - "firstName" - "lastName" type: "object" properties: firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." employeeId: type: "integer" description: "Идентификатор сотрудника. Возвращается для реестров в\ \ статусе DRAFT, ACCEPTED, PART_EXEC\ \ или EXECUTED." format: "int32" description: "Данные сотрудника, находящегося в статусах `ACTIVE` или `FIRED`." sum: type: "number" description: "Сумма платежа." periodStart: type: "string" description: "Начало периода платежа." format: "date" periodEnd: type: "string" description: "Окончание периода платежа." format: "date" revenueTypeCode: type: "string" description: "Код вида дохода." enum: - "1" - "2" - "3" - "4" - "5" collectionAmount: type: "number" description: "Удержанная сумма." CreateApplicationRequest: required: - "accountNumber" - "cardNetwork" - "employeeIdentificationApplicationId" type: "object" properties: employeeIdentificationApplicationId: type: "string" description: "ID заявки на удалённую идентификацию сотрудника." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер счёта, к которому выпускается карта." cardNetwork: $ref: "#/components/schemas/CardNetwork" EmployeeStatus: type: "string" description: "Статус сотрудника:
" enum: - "PROCESSING" - "DRAFT" - "PROCESSING_ERROR" - "ACTIVE" - "ERROR" - "REJECTED" - "FIRED" - "DELETED" - "MTNG_SCHD" - "MTNG_WAIT" - "MTNG_CANC" DeponentListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество депонентов для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество депонентов для вывода." format: "int32" size: type: "integer" description: "Количество депонентов в ответе." format: "int32" total: type: "integer" description: "Всего депонентов, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список депонентов этапа сделки." items: $ref: "#/components/schemas/DeponentResponse" AccountInfo3: required: - "accountNumber" - "accountType" - "balance" - "bankBik" - "createdOn" - "currency" - "mainFlag" - "name" - "status" - "tariffCode" - "tariffName" type: "object" properties: accountNumber: type: "string" description: "Расчетный счёт организации." name: type: "string" description: "Наименование счёта." status: type: "string" description: "Статус счёта. Возможные значения: " tariffName: type: "string" description: "Пользовательское наименование тарифа." tariffCode: type: "string" description: "Код тарифа." currency: type: "string" description: "Код валюты счёта по ОКВ (цифрами)." createdOn: type: "string" description: "Дата открытия счёта." format: "date" mainFlag: type: "string" description: "Флаг основного счёта: " bankBik: pattern: "\\d{9}" type: "string" description: "БИК банка." accountType: type: "string" description: "Тип счёта. Список вариантов значений может пополняться.\n\ * `Current` — расчетный счёт.\n* `Tax` — счёт Тинькофф Бухгалтерии.\n\ * `Tender` — специальный счёт для участия в госзакупках.\n* `Overnight`\ \ — счёт Overnight.\n* `Trust` — специальный счёт доверительного управ\ ляющего ПИФ.\n* `Broker` — специальный брокерский счёт.\n* `BankPaymentAgent`\ \ — специальный счёт банковского платёжного агента.\n* `PaymentAgent`\ \ — счёт платёжного агента.\n* `Nominal` — номинальный счёт.\n* `NominalIpo`\ \ — номинальный счёт оператора инвестиционной платформы.\n* `TrustManagementSmp`\ \ — специальный счёт доверительного управления.\n* `Cashbox` — бизнес\ -копилка.\n* `Invest` — инвестиционный счёт." activationDate: type: "string" description: "Дата активации." format: "date" balance: $ref: "#/components/schemas/Balance1" transitAccount: $ref: "#/components/schemas/TransitAccount" brokerCurrencyBalance: type: "array" description: "Информация о брокерских счетах. Актуально для инвестиционн\ ых счетов." items: $ref: "#/components/schemas/PositionInfo" CashbackHistoryRequest: required: - "page" - "phoneNumber" - "size" type: "object" properties: phoneNumber: type: "string" description: "Номер телефона клиента в формате E.164" page: type: "integer" description: "Номер страницы элементов" format: "int32" size: type: "integer" description: "Максимальное количество элементов на странице" format: "int32" PaymentRegistryStatus: type: "string" description: "Статус платёжного реестра:
" enum: - "DRAFT" - "ERROR" - "ACCEPTED" - "EXECUTED" - "PART_EXEC" - "REJECTED" - "CANCELLED" - "DELETED" AgreementNumberRequisites: required: - "agreementNumber" type: "object" properties: agreementNumber: type: "string" description: "Номер договора." description: "Номер договора получателя." CashbackBalanceRequest: required: - "phoneNumber" type: "object" properties: phoneNumber: type: "string" description: "Номер телефона клиента в формате E.164" PaymentRegistrySubmitRequest: required: - "correlationId" - "paymentRegistryId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" ReissuedVirtualCardInfo: required: - "cardBin" - "cardLastFourDigits" - "newUcid" - "oldUcid" type: "object" properties: oldUcid: type: "integer" description: "Уникальный идентификатор старой карты" format: "int64" newUcid: type: "integer" description: "Уникальный идентификатор новой карты" format: "int64" cardBin: maxLength: 6 minLength: 6 pattern: "\\d{6}" type: "string" description: "Первые 6 цифр номера новой карты (BIN карты)" cardLastFourDigits: maxLength: 4 minLength: 4 pattern: "\\d{4}" type: "string" description: "Последние 4 цифры номера новой карты" description: "Данные перевыпущенной карты. Присутствует в ответе, если status\ \ = READY" CreateEmployeesRequest: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" employees: type: "array" description: "Список сотрудников на создание." items: $ref: "#/components/schemas/EmployeeCreateData" DocumentType: type: "string" description: "Тип документа." enum: - "Паспорт" - "Иностранный паспорт" - "Загр. паспорт иностранного гр." - "Служебный/официальный паспорт" - "Дипломатический паспорт" - "Миграционная карта" - "Разр. на временное проживание" - "Виза" - "Вид на жительство" Attachment: required: - "id" - "type" type: "object" properties: id: type: "string" description: "Идентификатор документа." type: type: "string" description: "Тип документа." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON." CreateLegalEntityReceiptRequest: required: - "customerInn" - "customerOrganization" - "incomeType" type: "object" properties: incomeType: type: "string" description: "От кого самозанятый получил доход:\n* `FROM_INDIVIDUAL` —\ \ от физического лица;\n* `FROM_LEGAL_ENTITY` — от компании;\n* `FROM_FOREIGN_AGENCY`\ \ — от иностранной компании." enum: - "FROM_INDIVIDUAL" - "FROM_LEGAL_ENTITY" - "FROM_FOREIGN_AGENCY" incomeReceivedAt: type: "string" description: "Дата и время получения дохода в UTC. Ожидается в ISO-8601\ \ формате yyyy-MM-ddTHH:mm:ss<.fff>, где:\n* HH — ча\ сы в 24-часовой нотации. Допускаются значения от 00 до 23.\n* .fff — о\ пциональная часть, содержащая доли секунд. Допускается не больше трёх\ \ знаков.\n* TZDSuffix — опциональный суффикс. Допускается значение Z\ \ или +00:00." format: "date-time" services: type: "array" description: "Список услуг." items: $ref: "#/components/schemas/ReceiptService" customerInn: pattern: "^(\\d{10})$" type: "string" description: "ИНН покупателя-компании." customerOrganization: type: "string" description: "Название организации, которой самозанятый оказывал услуги." Application: required: - "changedAt" - "status" type: "object" properties: status: $ref: "#/components/schemas/ApplicationStatus" subStatus: $ref: "#/components/schemas/ApplicationSubStatus" changedAt: type: "string" description: "Дата и время последнего изменения данных по заявке в UTC.\ \ Возвращается в формате ISO-8601." format: "date-time" result: $ref: "#/components/schemas/ApplicationResult" reason: type: "string" description: "Причина, по которой рассмотрение заявки не завершилось усп\ ехом. Может быть у заявок в статусе DONE." reasonDescription: type: "string" description: "Более подробное описание причины неуспеха. Может быть у за\ явок в статусе DONE." description: "Объект с информацией о последней заявке на изменение самозанят\ ости в Тинькофф. Изначально имеет статус IN_PROGRESS и переходит в DONE пр\ и завершении процесса (как успешном, так и с ошибкой). Если от пользовател\ я требуется выдать права в ЛК ФНС, то будет иметь subStatus PERMISSION_REQUESTED.\ \ После создания новой заявки — предыдущая исчезает. Нельзя завести новую\ \ заявку, если текущая IN_PROGRESS." Recipient: required: - "inn" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН получателя." name: type: "string" description: "Наименование получателя." account: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Счёт получателя." description: "Информация о получателе." CreateRegularPaymentRequest: required: - "accountNumber" - "amount" - "beneficiaryId" - "purpose" - "type" type: "object" properties: type: type: "string" description: "Тип платежа:\n* `REGULAR` — обычный.\n* `TAX` — налоговый." enum: - "REGULAR" - "TAX" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" amount: type: "number" description: "Сумма платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." BankDetails: oneOf: - $ref: "#/components/schemas/CardBankDetails" - $ref: "#/components/schemas/RkcBankDetails" - $ref: "#/components/schemas/SbpBankDetails" TacqOperationResponse: type: "object" properties: lastTransactionDate: type: "string" description: "Последняя дата совершения транзакции для выборки в UTC. Фо\ рмат — `yyyy-MM-ddTHH:mm:ssZ`." format: "date-time" operations: type: "array" description: "Список операций по терминалу." items: $ref: "#/components/schemas/Operation" ActiveOffersResponse: type: "object" properties: data: type: "array" description: "Офферы текущей страницы" items: $ref: "#/components/schemas/ActiveOffer" SelfEmployedReceiptsRequestStatus: type: "string" description: "Статус запроса на получение чеков." enum: - "FINISHED" - "IN_PROGRESS" - "ERROR" AddressType: type: "string" description: "Тип адреса." enum: - "Жительства" - "Регистрации" - "Работы" ListOfArrest: required: - "sum" type: "object" properties: sum: type: "number" description: "Список блокировок." values: type: "array" items: $ref: "#/components/schemas/Arrest" description: "Данные о блокировках." JobInfo: type: "object" properties: position: type: "string" description: "Должность." description: "Информация о работе." PaymentInfoRegistryStatus: type: "string" description: "Статус платежа:
" enum: - "ACCEPTED" - "EXECUTED" - "REJECTED" - "CANCELLED" - "DELETED" - "WAITING" BeneficiaryScoringResult: required: - "isInBlacklist" - "isInnValid" - "isPassportValid" type: "object" properties: isInnValid: type: "boolean" description: "Индикатор валидности ИНН." isPassportValid: type: "boolean" description: "Индикатор валидности паспортных данных." isInBlacklist: type: "boolean" description: "Индикатор нахождения бенефициара в черном списке." MonthLimitError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Превышен месячный лимит" type: type: "string" description: "MONTH_LIMIT" PaymentInfoRegistryStatus1: type: "string" description: "Статус платежа:
" enum: - "ACCEPTED" - "EXECUTED" - "REJECTED" - "CANCELLED" - "DELETED" - "WAITING" ReceiptHistoryItem: required: - "date" - "qrCodeAsString" type: "object" properties: qrCodeAsString: type: "string" description: "Строковое представление информации из qr кода" date: type: "string" description: "Дата фиксации чека в системе" format: "date-time" description: "Детали чека" IisPaymentOrder: required: - "agreementDate" - "agreementNumber" - "date" - "debitDate" - "receiptDate" - "recipient" - "value" type: "object" properties: date: type: "string" format: "date" receiptDate: type: "string" format: "date" debitDate: type: "string" format: "date" value: type: "number" description: "Сумма" recipient: $ref: "#/components/schemas/Recipient1" agreementNumber: type: "string" agreementDate: type: "string" format: "date" MigrationCard: required: - "date" - "expireDate" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" BeneficiaryUlResidentRequest: required: - "inn" - "type" type: "object" properties: type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" name: type: "string" description: "Наименование организации." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона. phoneNumber или email обязателен к заполне\ нию." email: type: "string" description: "Электронная почта. phoneNumber или email обязателен к запо\ лнению." addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" registrationDate: type: "string" description: "Дата регистрации." format: "date" opf: type: "string" description: "Организационно-правовая форма." inn: pattern: "^(\\d{10})$" type: "string" description: "ИНН." ogrn: pattern: "^(\\d{13})$" type: "string" description: "Основной государственный регистрационный номер." CreateDraftRequest: required: - "actualAddress" - "birthDate" - "firstName" - "lastName" - "passport" - "phoneNumber" - "placeOfBirth" type: "object" properties: lastName: type: "string" description: "Фамилия сотрудника." firstName: type: "string" description: "Имя сотрудника." secondName: type: "string" description: "Отчество сотрудника." birthDate: type: "string" description: "Дата рождения в формате `yyyy-MM-dd`." format: "date" placeOfBirth: type: "string" description: "Место рождения." phoneNumber: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер телефона." passport: $ref: "#/components/schemas/Passport1" registrationAddress: $ref: "#/components/schemas/Address1" actualAddress: required: - "country" - "house" - "region" type: "object" properties: zipCode: type: "string" description: "Почтовый код." country: type: "string" description: "Страна." region: type: "string" description: "Регион." district: type: "string" description: "Район." city: type: "string" description: "Город." settlement: type: "string" description: "Населённый пункт." street: type: "string" description: "Улица." house: type: "string" description: "Дом." building: type: "string" description: "Строение." apartment: type: "string" description: "Квартира." description: "Фактический адрес." SelfEmployedListRequest: type: "object" properties: recipientIds: type: "array" description: "Список идентификаторов самозанятых." items: type: "integer" format: "int32" inn: type: "array" description: "ИНН самозанятых." items: type: "string" status: type: "array" description: "Статусы самозанятых." items: type: "string" selfEmployedStatus: type: "array" description: "Статусы самозанятости." items: type: "string" creationDate: $ref: "#/components/schemas/SelfEmployedCreationDate" offset: type: "integer" description: "Количество получателей, которых мы пропустим при выдаче с\ \ начала списка." format: "int32" limit: type: "integer" description: "Максимальное количество самозанятых, информацию по которым\ \ отдадим в ответе. Максимум и по умолчанию — 900." format: "int32" DepInfo: required: - "companyName" - "inn" - "kpp" - "oktmo" - "phone" type: "object" properties: oktmo: pattern: "\\d{8}|\\d{11}|0" type: "string" description: "Код по ОКТМО." phone: type: "string" description: "Телефон." inn: pattern: "^(\\d{10})$" type: "string" description: "ИНН." kpp: pattern: "^(\\d{9})$" type: "string" description: "КПП." companyName: type: "string" description: "Наименование." description: "Филиал (налоговый агент), за который подаются сведения." AddCardRequestRequest: required: - "terminalKey" type: "object" properties: terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." CashbackOffersError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Офферы, подходящие для начислений, не найдены" type: type: "string" description: "CASHBACK_OFFERS_ERROR" CashbackAlreadyProcessedError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Кэшбэк уже начислен" type: type: "string" description: "CASHBACK_ALREADY_PROCESSED" SelfEmployedCreatePaymentInfo: required: - "accountNumber" - "number" - "paymentPurpose" - "selfEmployedInfo" - "sum" type: "object" properties: number: type: "integer" description: "Идентификатор платежа на стороне клиента." format: "int32" accountNumber: type: "string" description: "Номер счёта самозанятого." paymentPurpose: type: "string" description: "Назначение платежа." selfEmployedInfo: required: - "firstName" - "lastName" type: "object" properties: firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." description: "Данные самозанятого." sum: type: "number" description: "Сумма платежа в рублях." revenueTypeCode: type: "string" description: "Код вида дохода." enum: - "1" - "2" - "3" - "4" - "5" collectionAmount: type: "number" ReceiptFailedOperation: required: - "createdAt" - "errorCode" - "status" - "type" type: "object" properties: status: $ref: "#/components/schemas/ReceiptOperationStatus" type: $ref: "#/components/schemas/ReceiptOperationType" createdAt: type: "string" description: "Дата и время создания операции в UTC. Возвращается в форма\ те ISO-8601." format: "date-time" errorCode: type: "string" description: "Код ошибки." errorMessage: type: "string" description: "Описание ошибки." ThirdPartyInfo: required: - "inn" - "kpp" - "name" type: "object" properties: inn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН третьего лица." kpp: pattern: "^(\\d{9}|0)$" type: "string" description: "КПП третьего лица." name: type: "string" description: "ФИО третьего лица." description: "Информация для совершения налоговых платежей за третьих лиц." ExpiryDate: required: - "month" - "year" type: "object" properties: year: type: "integer" description: "Год окончания срока действия карты." format: "int32" month: type: "integer" description: "Месяц окончания срока действия карты." format: "int32" description: "Объект с датой окончания срока действия карты." CreationRegisterStatus: type: "string" description: "Статус создания:
" enum: - "CREATED" - "ERROR" - "QUEUED" BankStatementOperation: required: - "amount" - "chargeDate" - "creatorStatus" - "date" - "drawDate" - "id" - "operationId" - "operationType" - "payerBank" - "payerBic" - "payerName" - "paymentPurpose" - "recipient" - "recipientAccount" - "recipientBank" - "recipientBic" type: "object" properties: operationId: type: "string" description: "Уникальный идентификатор операции." id: type: "string" description: "Номер документа." date: type: "string" description: "Дата документа." format: "date" amount: type: "number" description: "Сумма платежа." drawDate: type: "string" description: "Дата списания средств с р/с плательщика." format: "date" payerName: type: "string" description: "Имя плательщика." payerInn: type: "string" description: "ИНН плательщика." payerAccount: type: "string" description: "Номер счёта плательщика." payerCorrAccount: type: "string" description: "Корреспондентский счёт плательщика." payerBic: type: "string" description: "БИК плательщика." payerBank: type: "string" description: "Банк плательщика." chargeDate: type: "string" description: "Дата поступления средств на р/с получателя." format: "date" recipient: type: "string" description: "Получатель платежа." recipientInn: type: "string" description: "ИНН получателя платежа." recipientAccount: type: "string" description: "Номер счёта получателя платежа." recipientCorrAccount: type: "string" description: "Корреспондентский счёт получателя платежа." recipientBic: type: "string" description: "БИК получателя платежа." recipientBank: type: "string" description: "Банк получателя платежа." paymentType: type: "string" description: "Вид платежа." operationType: pattern: "\\d{2}" type: "string" description: "Условное обозначение (шифр) документа, проводимого по счёт\ у в кредитной организации. Перечень условных обозначений." uin: type: "string" description: "Уникальный идентификатор платежа. Подробнее." paymentPurpose: type: "string" description: "Назначение платежа." creatorStatus: type: "string" description: "Статус составителя расчётного документа." payerKpp: type: "string" description: "КПП плательщика." recipientKpp: type: "string" description: "КПП получателя." kbk: type: "string" description: "Код бюджетной классификации." oktmo: type: "string" description: "Код ОКТМО территории, на которой мобилизуются денежные сре\ дства от уплаты налога, сбора и иного платежа." taxEvidence: type: "string" description: "Основание налогового платежа." taxPeriod: type: "string" description: "Налоговый период / код таможенного органа." taxDocNumber: type: "string" description: "Номер налогового документа." taxDocDate: type: "string" description: "Дата налогового документа." taxType: type: "string" description: "Тип налогового платежа." executionOrder: type: "string" description: "Очерёдность платежа." InvalidRequestResponse: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." FormDataResponse: required: - "casVersion" - "createdAt" - "isResident" - "type" - "year" type: "object" properties: year: type: "integer" description: "Год, за который подаётся декларация." format: "int32" isResident: type: "boolean" description: "Был ли клиент налоговым резидентом в выбранный год." type: $ref: "#/components/schemas/DeclarationType" incomeSources: maxItems: 100 type: "array" description: "Группы источников дохода." items: $ref: "#/components/schemas/IncomeSourceResponse" taxReturnReasons: maxItems: 100 type: "array" description: "Группы налоговых вычетов." items: $ref: "#/components/schemas/TaxReturnReasonResponse" casVersion: type: "integer" description: "Версия анкеты." format: "int32" createdAt: type: "string" description: "Дата создания." format: "date-time" description: "Заполненная анкета клиента." BankInfo1: type: "object" properties: accountNumber: type: "string" description: "Номер счёта сотрудника." agreementNumber: type: "string" description: "Номер договора сотрудника." description: "Банковская информация сотрудника." CardNetwork: type: "string" description: "Международная платёжная система." enum: - "MASTERCARD" - "VISA" - "MIR" Ready1: required: - "result" - "status" type: "object" properties: result: $ref: "#/components/schemas/BeneficiariesResult" status: $ref: "#/components/schemas/BeneficiariesStatus" ReissueVirtualCardResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор заявки на перевыпуск виртуальной карты." format: "uuid" BeneficiariesStatus: type: "string" description: "Статус проверки бенефициара. READY — бенефициар у\ спешно проверен." enum: - "READY" - "IN_PROGRESS" CreateIndividualReceiptRequest: required: - "incomeType" type: "object" properties: incomeType: type: "string" description: "От кого самозанятый получил доход:\n* `FROM_INDIVIDUAL` —\ \ от физического лица;\n* `FROM_LEGAL_ENTITY` — от компании;\n* `FROM_FOREIGN_AGENCY`\ \ — от иностранной компании." enum: - "FROM_INDIVIDUAL" - "FROM_LEGAL_ENTITY" - "FROM_FOREIGN_AGENCY" incomeReceivedAt: type: "string" description: "Дата и время получения дохода в UTC. Ожидается в ISO-8601\ \ формате yyyy-MM-ddTHH:mm:ss<.fff>, где:\n* `HH` —\ \ часы в 24-часовой нотации. Допускаются значения от 00 до 23.\n* `.fff`\ \ — опциональная часть, содержащая доли секунд. Допускается не больше\ \ трёх знаков.\n* `TZDSuffix` — опциональный суффикс. Допускается знач\ ение Z или +00:00." format: "date-time" services: type: "array" description: "Список услуг." items: $ref: "#/components/schemas/ReceiptService" CreateAndSendInvoiceResponse: required: - "invoiceId" - "pdfUrl" type: "object" properties: pdfUrl: type: "string" description: "Ссылка на PDF выставленного счёта. Действительна в течение\ \ 10 дней." invoiceId: type: "string" description: "Идентификатор выставленного счёта." format: "uuid" ForeignIncomeStatement: type: "object" properties: incomes: type: "array" items: $ref: "#/components/schemas/ForeignIncomeStatementLine" UploadTaskFileResponse: required: - "id" type: "object" properties: id: type: "string" description: "Идентификатор документа." RecipientResponse: required: - "amount" - "beneficiaryId" - "dealId" - "recipientId" - "stepId" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа сделки." format: "uuid" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" recipientId: type: "string" description: "Идентификатор реципиента." format: "uuid" amount: type: "number" description: "Сумма реципиента." tax: type: "number" description: "Налог реципиента." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" keepOnVirtualAccount: type: "boolean" description: "Вывод на виртуальный счёт в рамках номинального счёта — true,\ \ на реальные реквизиты — false.\n\nПри создании реципиен\ та без банковских реквизитов, платеж в рамках сделки автоматически буд\ ет выполнен на виртуальный счет бенефициара." AuthStatus: type: "string" description: "Статус авторизации" enum: - "succeed" - "cancelled" CreateTaxPaymentRequest: required: - "accountNumber" - "amount" - "bankDetails" - "beneficiaryId" - "purpose" - "tax" - "type" - "uin" type: "object" properties: type: type: "string" description: "Тип платежа:\n* `REGULAR` — обычный.\n* `TAX` — налоговый." enum: - "REGULAR" - "TAX" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." bankDetails: $ref: "#/components/schemas/BankDetails" amount: type: "number" description: "Сумма платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." uin: pattern: "0|[А-Яа-яA-Za-z0-9]{4}|[А-ЯA-Z0-9]{15}|[а-яА-Яa-zA-Z0-9№\\s!\"\ #$%;'()*+,-\\.\\/:;;=>?@\\]\\[\\\\\\^_`{|}~]{20}|[а-яА-Яa-zA-Z0-9№\\s!\"\ #$%;'()*+,-\\.\\/:;;=>?@\\]\\[\\\\\\^_`{|}~]{25}" type: "string" description: "Уникальный идентификатор платежа." tax: $ref: "#/components/schemas/TaxPaymentParameters" BeneficiaryScoringInfoV2: oneOf: - $ref: "#/components/schemas/FAILED" - $ref: "#/components/schemas/IN_PROGRESS" - $ref: "#/components/schemas/SUCCEEDED" Address1: required: - "country" - "house" - "region" type: "object" properties: zipCode: type: "string" description: "Почтовый код." country: type: "string" description: "Страна." region: type: "string" description: "Регион." district: type: "string" description: "Район." city: type: "string" description: "Город." settlement: type: "string" description: "Населённый пункт." street: type: "string" description: "Улица." house: type: "string" description: "Дом." building: type: "string" description: "Строение." apartment: type: "string" description: "Квартира." description: "Адрес регистрации." BeneficiaryFlNonresidentResponse: required: - "beneficiaryId" - "birthDate" - "citizenship" - "firstName" - "isSelfEmployed" - "lastName" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" firstName: type: "string" description: "Имя." middleName: type: "string" description: "Отчество." lastName: type: "string" description: "Фамилия." isSelfEmployed: type: "boolean" birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: pattern: "^([A-Z]{2})$" type: "string" description: "Гражданство. Код страны в формате `ISO 3166-1 alpha-2`." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона." email: type: "string" description: "Электронная почта." documents: type: "array" description: "Документы." items: $ref: "#/components/schemas/Document2" addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." Arrest: required: - "amount" - "currency" - "date" - "id" - "status" - "unblockDate" type: "object" properties: id: type: "string" description: "Уникальный идентификатор." externalId: type: "string" description: "Внешний идентификатор требования. Обеспечивается связь нес\ кольких блокировок." amount: type: "number" description: "Сумма требования." currency: pattern: "^\\d{3}$" type: "string" description: "Код валюты по ОКВ." status: $ref: "#/components/schemas/EptArrestStatus" date: type: "string" description: "Дата регистрации требования." format: "date-time" unblockDate: type: "string" description: "Дата отмены блокировки." format: "date-time" circumstances: type: "string" description: "Обстоятельства." officeName: type: "string" description: "Наименование площадки." SelfEmployedReceipt: required: - "number" - "selfEmployedInfo" - "status" type: "object" properties: number: type: "integer" description: "Идентификатор платежа на стороне клиента." format: "int32" selfEmployedInfo: required: - "firstName" - "lastName" type: "object" properties: firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." recipientId: type: "integer" description: "Идентификатор самозанятого." format: "int32" description: "Данные самозанятого." link: type: "string" description: "Ссылка на чек." status: $ref: "#/components/schemas/SelfEmployedReceiptsStatus" error: required: - "errorCode" - "errorMessage" type: "object" properties: errorCode: type: "string" description: "Код ошибки." errorMessage: type: "string" description: "Описание ошибки." description: "Ошибка во время получения чека." RecipientListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество реципиентов для пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество реципиентов для вывода." format: "int32" size: type: "integer" description: "Количество реципиентов в ответе." format: "int32" total: type: "integer" description: "Всего реципиентов, подходящих под условия запроса." format: "int32" results: type: "array" description: "Список реципиентов этапа сделки." items: $ref: "#/components/schemas/RecipientResponse" CobrandResponse: required: - "programStatus" type: "object" properties: programStatus: type: "boolean" description: "`true/false` — признак наличия кобрэнда." accounts: type: "array" description: "Список аккаунтов." items: $ref: "#/components/schemas/CobrandAccount" OfferConditionsNotMetError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Не выполнены условия акции" type: type: "string" description: "OFFER_CONDITIONS_NOT_MET_ERROR" TotalIncomeTax: required: - "incomeTotalSum" - "prepaymentFixedSum" - "taxBase" - "taxSumCalc" - "taxSumNotWithheld" - "taxSumOverWithheld" - "taxSumTransfer" - "taxSumWithheld" type: "object" properties: incomeTotalSum: type: "number" description: "Общая сумма дохода." taxBase: type: "number" description: "Налоговая база." taxSumCalc: type: "number" description: "Сумма налога исчисленная." prepaymentFixedSum: type: "number" description: "Сумма фиксированных авансовых платежей." taxSumWithheld: type: "number" description: "Сумма налога удержанная." taxSumTransfer: type: "number" description: "Сумма налога перечисленная." taxSumOverWithheld: type: "number" description: "Сумма налога, излишне удержанная налоговым агентом." taxSumNotWithheld: type: "number" description: "Сумма налога, не удержанная агентом." description: "Общие суммы дохода и налога." InvoicePayerInfo: type: "object" properties: name: maxLength: 512 minLength: 1 type: "string" description: "Наименование плательщика." inn: pattern: "^(\\d{12}|\\d{10})$" type: "string" description: "ИНН плательщика." kpp: pattern: "^(\\d{9})$" type: "string" description: "КПП плательщика." description: "Информация о плательщике." PaymentInfo: required: - "employeeInfo" - "status" - "sum" type: "object" properties: number: type: "integer" description: "Идентификатор платежа на стороне клиента." format: "int32" status: $ref: "#/components/schemas/PaymentInfoRegistryStatus" employeeInfo: $ref: "#/components/schemas/EmployeeInfo" accountNumber: type: "string" description: "Номер счёта сотрудника." paymentPurpose: type: "string" description: "Назначение платежа." sum: type: "number" description: "Сумма платежа." periodStart: type: "string" description: "Начало периода платежа." format: "date" periodEnd: type: "string" description: "Окончание периода платежа." format: "date" BalanceListItem: required: - "accountNumber" - "amount" - "amountOnHold" - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." amount: type: "number" description: "Текущий баланс бенефициара." amountOnHold: type: "number" description: "Заблокированные средства бенефициара." UpdateRecipientBankDetailsRequest: required: - "bankDetailsId" type: "object" properties: bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" CreateTaskRequest: required: - "template" type: "object" properties: template: type: "string" description: "Шаблон, определяющий бизнес-логику задания." commentForAgent: type: "string" description: "Комментарий к заданию для представителя." parentTaskId: type: "string" description: "Идентификатор родительского задания." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON." contacts: type: "array" description: "Группа объектов с информацией о данных каждого участника з\ адания, подлежащего удостоверению на встрече." items: $ref: "#/components/schemas/Contact" StepRequest: required: - "description" type: "object" properties: description: maxLength: 4096 minLength: 3 type: "string" description: "Описание этапа сделки." DealResponse: required: - "accountNumber" - "dealId" - "status" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." status: type: "string" description: "Статус сделки. \n\n![payment-statuses](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/deal-statuses.svg)\n\ * `DRAFT` — сделка создана и доступна для редактирования.\n* `ACCEPTED`\ \ — параметры сделки подтверждены, средства зарезервированы.\n* `IN_PROGRESS`\ \ — сделка в процессе.\n* `CANCELLED` — сделка отменена.\n* `COMPLETED`\ \ — сделка успешно завершена." enum: - "DRAFT" - "ACCEPTED" - "IN_PROGRESS" - "CANCELLED" - "COMPLETED" Etp: required: - "amount" - "bank" - "currency" - "date" - "id" - "payedAmount" - "recipient" - "senderInn" - "status" type: "object" properties: id: type: "string" description: "Уникальный идентификатор." externalId: type: "string" description: "Внешний идентификатор требования. Обеспечивается связь нес\ кольких блокировок." amount: type: "number" description: "Сумма требования." currency: pattern: "^\\d{3}$" type: "string" description: "Код валюты по ОКВ." status: $ref: "#/components/schemas/EptArrestStatus" date: type: "string" description: "Дата регистрации требования." format: "date-time" payedAmount: type: "number" description: "Оплаченная сумма." paymentPurpose: type: "string" description: "Назначение платежа." senderInn: pattern: "^(\\d{12}|\\d{10}|0{1})$" type: "string" description: "ИНН плательщика." recipient: $ref: "#/components/schemas/Recipient" bank: $ref: "#/components/schemas/Bank" officeName: type: "string" description: "Наименование площадки." BeneficiaryUlNonresidentResponse: required: - "beneficiaryId" - "name" - "registrationDate" - "registrationNumber" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" name: type: "string" description: "Наименование организации." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона." email: type: "string" description: "Электронная почта." addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" nza: type: "string" description: "Номер записи об аккредитации." registrationDate: type: "string" description: "Дата регистрации." format: "date" registrationNumber: type: "string" description: "Номер регистрации." opf: type: "string" description: "Организационно-правовая форма." inn: pattern: "^(\\d{10})$" type: "string" description: "ИНН." kio: type: "string" description: "Код иностранной организации." BlockCardRequest: required: - "reason" type: "object" properties: reason: type: "string" description: "Причина блокировки:\n* `LOST` — карта утеряна;\n* `STOLEN`\ \ — карта украдена;\n* `BROKEN` — карта повреждена;\n* `FRAUD` — мошен\ ничество;\n* `CLIENTINITIATED` — другая причина." enum: - "LOST" - "STOLEN" - "BROKEN" - "FRAUD" - "CLIENTINITIATED" comment: type: "string" description: "Комментарий." ClientOffer: required: - "id" type: "object" properties: id: type: "integer" description: "Уникальный id оффера" format: "int64" cbAmount: type: "integer" description: "Фиксированный размер бонуса" format: "int64" cbPercent: type: "integer" description: "Процент начисления бонуса" format: "int64" countOfRealised: type: "integer" description: "Количество совершённых покупок по спецпредложению" format: "int32" viewDate: type: "string" description: "Дата просмотра оффера" format: "date-time" weight: type: "integer" description: "Вес партнера для клиента. Относительная величина для персо\ нального ранжирования списка офферов" format: "int32" merchantCategories: type: "array" description: "Список категорий партнера у клиента" items: $ref: "#/components/schemas/ClientMerchantCategory" web: type: "string" description: "Персонализированная ссылка для клиента" SnilsResponse: type: "object" properties: snils: pattern: "^(\\d{11})$" type: "string" description: "СНИЛС." Employee: required: - "bankInfo" - "firstName" - "id" - "lastName" - "status" type: "object" properties: id: type: "integer" description: "Идентификатор сотрудника." format: "int32" status: $ref: "#/components/schemas/EmployeeStatus" firstName: type: "string" description: "Имя." lastName: type: "string" description: "Фамилия." middleName: type: "string" description: "Отчество." birthDate: type: "string" description: "Дата рождения." format: "date" phones: type: "array" description: "Номера телефонов." items: $ref: "#/components/schemas/Phone" documents: type: "array" description: "Документы." items: $ref: "#/components/schemas/Document" jobInfo: $ref: "#/components/schemas/JobInfo" bankInfo: $ref: "#/components/schemas/BankInfo1" SignerStatusResponse: required: - "isSigner" type: "object" properties: isSigner: type: "boolean" description: "Является ли пользователь подписантом." BeneficiaryRequest: oneOf: - $ref: "#/components/schemas/BeneficiaryFlNonresidentRequest" - $ref: "#/components/schemas/BeneficiaryFlResidentRequest" - $ref: "#/components/schemas/BeneficiaryIpNonresidentRequest" - $ref: "#/components/schemas/BeneficiaryIpResidentRequest" - $ref: "#/components/schemas/BeneficiaryLiteContactRequest" - $ref: "#/components/schemas/BeneficiaryUlNonresidentRequest" - $ref: "#/components/schemas/BeneficiaryUlResidentRequest" CreateDocument1: required: - "date" - "organization" - "serial" - "type" type: "object" properties: type: $ref: "#/components/schemas/CreateDocumentType" serial: type: "string" description: "Серия." number: type: "string" description: "Номер документа." date: type: "string" description: "Дата." format: "date" organization: type: "string" description: "Кем выдан." division: type: "string" description: "Код подразделения." expireDate: type: "string" description: "Дата истечения." format: "date" SelfEmployedResponse: type: "object" properties: recipients: type: "array" description: "Список самозанятых." items: $ref: "#/components/schemas/SelfEmployed" InvoiceItemInfo: required: - "amount" - "name" - "price" - "unit" - "vat" type: "object" properties: name: type: "string" description: "Наименование." price: type: "number" description: "Цена за единицу в рублях." unit: type: "string" description: "Единицы измерения." vat: $ref: "#/components/schemas/Vat" amount: type: "number" description: "Количество единиц." DeliveryTask: required: - "id" - "status" - "template" type: "object" properties: id: type: "string" description: "Идентификатор задания." status: type: "string" description: "Статус задания." template: type: "string" description: "Шаблон задания." meetResult: type: "string" resolution: type: "string" description: "Результат задания." subResolution: type: "string" description: "Детальное описание результата задания." parentTaskId: type: "string" description: "Идентификатор родительского задания." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные метаданные в формате JSON." attachments: type: "array" description: "Группа объектов с информацией о документах, относящихся к\ \ заданию. Может быть пустым, если документы не нужны в качестве резул\ ьтатов задания." items: $ref: "#/components/schemas/Attachment" photos: type: "array" description: "Группа объектов с информацией о фото, относящихся к задани\ ю." items: $ref: "#/components/schemas/Photo" IdentificationDocumentType: type: "string" description: "Тип документа" enum: - "PASSPORT" CreateSelfEmployedRequest: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" recipients: type: "array" description: "Список самозанятых на создание." items: $ref: "#/components/schemas/CreateSelfEmployedData" AmountDistributionItem: required: - "amount" - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" amount: type: "number" description: "Сумма пополнения." CardInfoResponse: required: - "accountNumber" - "cardBin" - "cardLastFourDigits" - "embossedName" - "isActive" - "status" - "ucid" type: "object" properties: ucid: type: "integer" description: "Уникальный идентификатор карты." format: "int64" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер расчётного счёта, к которому привязана карта." cardBin: maxLength: 6 minLength: 6 pattern: "\\d{6}" type: "string" description: "Первые 6 цифр номера карты (BIN карты)." cardLastFourDigits: maxLength: 4 minLength: 4 pattern: "\\d{4}" type: "string" description: "Последние 4 цифры номера карты." isActive: type: "boolean" description: "Флаг активации карты." status: $ref: "#/components/schemas/CardStatus" embossedName: type: "string" description: "Имя держателя карты." DepsData: required: - "depInfo" type: "object" properties: depInfo: $ref: "#/components/schemas/DepInfo" rates: type: "array" description: "Деление всех доходов по ставкам в разрезе филиала." items: $ref: "#/components/schemas/Rate" EmployeeInfo: required: - "firstName" - "lastName" type: "object" properties: firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." employeeId: type: "integer" description: "Идентификатор сотрудника. Возвращается для реестров в стат\ усе DRAFT, ACCEPTED, PART_EXEC\ \ или EXECUTED." format: "int32" description: "Данные сотрудника." ContractGPD: required: - "date" - "number" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" expireDate: type: "string" description: "Дата истечения." format: "date" Income: required: - "incomeCode" - "incomeSum" - "month" type: "object" properties: month: type: "integer" description: "Месяц" format: "int32" incomeCode: type: "string" description: "Код дохода" incomeSum: type: "number" description: "Сумма дохода" recs: type: "array" description: "Вычеты, в рамках месяца и кода дохода" items: $ref: "#/components/schemas/IncomeRec" description: "Доходы" CreatePhone1: required: - "number" - "type" type: "object" properties: type: $ref: "#/components/schemas/CreatePhoneType" number: type: "string" description: "Номер телефона." AccountOperation: required: - "accountAmount" - "accountNumber" - "amount" - "authDateTime" - "card" - "currency" - "operationStatus" - "operationType" type: "object" properties: accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер счета" authDateTime: type: "string" description: "Дата авторизации" format: "date-time" trxnDateTime: type: "string" description: "Дата транзакции" format: "date-time" authId: type: "string" description: "Идентификатор авторизации" trxnId: type: "string" description: "Идентификатор транзакции" authStatus: $ref: "#/components/schemas/AuthStatus" operationType: $ref: "#/components/schemas/AccountOperationType" operationStatus: $ref: "#/components/schemas/AccountOperationStatus" amount: type: "number" description: "Сумма операции в валюте операции" currency: type: "string" description: "Валюта операции" accountAmount: type: "number" description: "Сумма операции в валюте счета" description: type: "string" description: "Назначение платежа" card: $ref: "#/components/schemas/Card" merch: $ref: "#/components/schemas/Merch" rrn: type: "string" description: "RRN" acquirerId: type: "string" description: "acquirerId" CardIssueApplicationStatus: type: "string" description: "\nСтатус заявки:\n" enum: - "NEW" - "IDENTIFICATION" - "ISSUING" - "FAILED_FATAL" - "FAILED_NON_FATAL" - "CARD_ISSUED" FAILED: required: - "beneficiaryId" - "status" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" status: type: "string" description: "Статус проверки в финансовом мониторинге." enum: - "IN_PROGRESS" - "SUCCEEDED" - "FAILED" warnings: type: "array" items: $ref: "#/components/schemas/BeneficiaryScoringError" errors: type: "array" items: $ref: "#/components/schemas/BeneficiaryScoringError" DebitAccount: required: - "accountNumber" - "bank" - "name" type: "object" properties: name: type: "string" description: "Получатель (ФИО)." accountNumber: type: "string" description: "Счёт получателя платежа." bank: $ref: "#/components/schemas/BankInfo" CreateMeetingRequest: required: - "appointmentId" - "intervalEndTime" - "intervalStartTime" type: "object" properties: appointmentId: type: "string" description: "Идентификатор назначения встречи." intervalStartTime: type: "string" description: "Время начала интервала." intervalEndTime: type: "string" description: "Время окончания интервала." commentForAgent: type: "string" description: "Комментарий к встрече для представителя." HoldListItem: required: - "accountNumber" - "amount" - "beneficiaryId" - "holdId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." holdId: type: "string" description: "ID холда." format: "uuid" dealId: type: "string" description: "ID сделки, под которую сделан холд." format: "uuid" stepId: type: "string" description: "ID этапа сделки, под который сделан холд." format: "uuid" recipientId: type: "string" description: "ID реципиента этапа сделки, под которого сделан холд." format: "uuid" paymentId: type: "string" description: "ID выплаты, под которую сделан холд." format: "uuid" amount: type: "number" description: "Сумма холда." BusinessErrorResponse: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." errorCode: maxLength: 50 type: "string" description: "Код ошибки." errorDetails: type: "object" description: "Дополнительные данные об ошибке." DocumentType2: type: "string" enum: - "PASSPORT" - "SELFIE_WITH_PASSPORT" CreateAddressType: type: "string" description: "Тип адреса." enum: - "Жительства" - "Регистрации" InternalServerErrorResponse: required: - "errorCode" - "errorId" - "errorMessage" type: "object" properties: errorId: maxLength: 50 type: "string" description: "Уникальный идентификатор ошибки." errorMessage: maxLength: 400 type: "string" description: "Текст ошибки." errorCode: maxLength: 50 type: "string" description: "Код ошибки." SelfEmployedPayPaymentRegistryRequest: required: - "correlationId" - "paymentRegistryId" type: "object" properties: paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" AccountOperationStatus: type: "string" enum: - "authorization" - "transaction" BindTaxpayerRequest: required: - "firstName" - "lastName" - "phoneNumber" type: "object" properties: firstName: type: "string" description: "Имя самозанятого." lastName: type: "string" description: "Фамилия самозанятого." middleName: type: "string" description: "Отчество самозанятого." phoneNumber: pattern: "^((\\+7)([0-9]){10})$" type: "string" description: "Номер телефона самозанятого." SpendLimit: required: - "limitPeriod" - "limitRemain" - "limitValue" type: "object" properties: limitValue: type: "number" description: "Лимит на покупки и снятия наличных в валюте счёта, к котор\ ому привязана карта" limitRemain: type: "number" description: "Доступный остаток расходного лимита в валюте счёта, к кото\ рому привязана карта" limitPeriod: type: "string" description: "\nПериод обновления доступного остатка расходного лимита:\n\ " enum: - "DAY" - "MONTH" - "IRREGULAR" - "CUSTOM" description: "Объект с информацией о расходном лимите." Bank: type: "object" properties: bik: pattern: "\\d{9}" type: "string" description: "БИК банка получателя.\n\n\nС 1 января 2021 года при перечи\ слении налоговых платежей указываются новые значения БИК банков получа\ теля.\n\n\nПодробнее о полях платёжного поручения " corAccount: pattern: "\\d{20}" type: "string" description: "Корреспондентский счёт банка получателя.\n\n\nС 1 января 2021\ \ года при уплате налогов указывается номер счёта банка получателя, вх\ одящий в состав единого казначейского счёта (ЕКС). Раньше это поле зап\ олнялось нулями. " name: maxLength: 255 minLength: 1 type: "string" description: "Наименование банка получателя.\n\n\nС 1 января 2021 года п\ ри заполнении платежей на перечисление налогов после названия банка ук\ азывается название счёта казначейства через знак //. " description: "Информация о банке получателя." PaymentStatusResponse: required: - "status" type: "object" properties: status: $ref: "#/components/schemas/PaymentStatus" errorMessage: type: "string" description: "Описание ошибки." meta: type: "object" additionalProperties: type: "string" description: "Дополнительные данные, переданные в поле meta запро\ са платежа." ApiForeignAgentResponse: required: - "isForeignAgent" type: "object" properties: isForeignAgent: type: "boolean" description: "Является ли пользователь иностранным агентом." RegularPaymentResponse: required: - "accountNumber" - "amount" - "bankDetails" - "beneficiaryId" - "paymentId" - "purpose" - "status" - "type" type: "object" properties: type: type: "string" description: "Тип платежа:\n* `REGULAR` — обычный.\n* `TAX` — налоговый." enum: - "REGULAR" - "TAX" paymentId: type: "string" description: "Идентификатор платежа." format: "uuid" beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" accountNumber: pattern: "^(\\d{20}|\\d{22})$" type: "string" description: "Номер номинального счёта." bankDetails: $ref: "#/components/schemas/BankDetails" dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа сделки." format: "uuid" recipientId: type: "string" description: "Идентификатор реципиента." format: "uuid" amount: type: "number" description: "Сумма платежа." status: type: "string" description: "Статус платежа \n\n![payment-statuses](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/payment-statuses.svg)\n\ * `PENDING` — Ожидает обработки.\n* `IN_PROGRESS` — В процессе.\n* `FAILED`\ \ — Неуспешен.\n* `CANCELLED` — Отменен.\n* `SUCCEEDED` — Успешно заве\ ршен." enum: - "PENDING" - "IN_PROGRESS" - "FAILED" - "CANCELLED" - "SUCCEEDED" errorMessage: type: "string" description: "Описание ошибки в случае неуспешности платежа." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." operationId: type: "string" description: "Уникальный ID операции." format: "uuid" EmployeeRegistryCreateTypeRequest: type: "string" description: "\nМожет принимать одно из двух значений:\n\n" enum: - "IGNORE_ERRORS" - "FAIL_ERRORS" StepResponse: required: - "dealId" - "description" - "status" - "stepId" - "stepNumber" type: "object" properties: dealId: type: "string" description: "Идентификатор сделки." format: "uuid" stepId: type: "string" description: "Идентификатор этапа сделки." format: "uuid" stepNumber: type: "integer" description: "Порядковый номер этапа сделки." format: "int32" description: maxLength: 4096 minLength: 3 type: "string" description: "Описание этапа сделки." status: type: "string" description: "Статус этапа сделки. \n\n![payment-statuses](https://business.cdn-tinkoff.ru/static/images/opensme/nominal-accounts/step-statuses.svg)\n\ * `NEW` — создан.\n* `PAYMENT_IN_PROGRESS` — одна или несколько выплат\ \ этапа сделки в процессе.\n* `PAYMENT_FAILED` — одна или несколько вы\ плат этапа сделки неуспешны.\n* `CANCELLED` — отменён.\n* `COMPLETED`\ \ — успешно завершён." enum: - "NEW" - "PAYMENT_IN_PROGRESS" - "PAYMENT_FAILED" - "CANCELLED" - "COMPLETED" SelfEmployedReceiptsRequest: required: - "correlationId" - "paymentRegistryId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" paymentRegistryId: type: "integer" description: "Номер платёжного реестра. Необходимо, чтобы ранее по реест\ ру была проведена регистрация дохода." format: "int32" ReceiptSuccessOperation: required: - "createdAt" - "status" - "type" type: "object" properties: status: $ref: "#/components/schemas/ReceiptOperationStatus" type: $ref: "#/components/schemas/ReceiptOperationType" createdAt: type: "string" description: "Дата и время создания операции в UTC. Возвращается в форма\ те ISO-8601." format: "date-time" BankInfo2: type: "object" properties: accountNumber: type: "string" description: "Номер счёта самозанятого." agreementNumber: type: "string" description: "Номер договора самозанятого." bankBic: type: "string" description: "БИК банка самозанятого." description: "Банковская информация самозанятого." CreateCardPaymentRequest: required: - "amount" - "from" - "id" - "purpose" - "to" type: "object" properties: id: maxLength: 64 minLength: 1 type: "string" description: "Идентификатор платежа. Должен быть уникален в пределах инт\ еграции платежей по банковским реквизитам." from: $ref: "#/components/schemas/CardPayerRequisites" to: $ref: "#/components/schemas/AgreementNumberRequisites" purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." documentNumber: minimum: 1 type: "integer" description: "Номер распоряжения, определяемый клиентом. Заполняется на\ \ усмотрение плательщика. Номер документа — не больше 6 цифр. " format: "int32" amount: type: "number" description: "Сумма платежа в рублях" executionOrder: maximum: 5 minimum: 1 type: "integer" description: "Очерёдность платежа." format: "int32" deprecated: true dueDate: type: "string" description: "Дата, до которой нужно провести платёж. При неуспешных поп\ ытках платежа он будет повторён вплоть до указанной даты. Если дату не\ \ передать, платёж не будет повторён в случае неуспешной попытки. Врем\ я на проведение платежа не может быть больше 30 дней." format: "date-time" ReceiptInProgressOperation: required: - "createdAt" - "status" - "type" type: "object" properties: status: $ref: "#/components/schemas/ReceiptOperationStatus" type: $ref: "#/components/schemas/ReceiptOperationType" createdAt: type: "string" description: "Дата и время создания операции в UTC. Возвращается в форма\ те ISO-8601." format: "date-time" IncomingTransactionListResponse: required: - "limit" - "offset" - "size" - "total" type: "object" properties: offset: type: "integer" description: "Запрошенное количество неидентифицированных пополнений для\ \ пропуска." format: "int32" limit: type: "integer" description: "Запрошенное количество неидентифицированных пополнений для\ \ вывода." format: "int32" size: type: "integer" description: "Количество неидентифицированных пополнений в ответе." format: "int32" total: type: "integer" description: "Всего неидентифицированных пополнений." format: "int32" results: type: "array" description: "Список неидентифицированных пополнений." items: $ref: "#/components/schemas/IncomingTransactionListItem" IdentificationStatusResponse: required: - "isIdentified" type: "object" properties: isIdentified: type: "boolean" description: "Идентифицирован ли пользователь." ForeignPassportOfForeignCitizens: required: - "date" - "number" - "organization" - "type" type: "object" properties: type: type: "string" description: "Тип документа." enum: - "PASSPORT" - "FOREIGN_PASSPORT" - "FOREIGN_PASSPORT_OF_FOREIGN_CITIZENS" - "OFFICIAL_PASSPORT" - "DIPLOMATIC_PASSPORT" - "MIGRATION_CARD" - "TEMPORARY_RESIDENCE_PERMIT" - "VISA" - "RESIDENCE_PERMIT" - "CONTRACT" - "CONTRACT_GPD" - "PATENT" number: type: "string" description: "Номер документа." date: type: "string" description: "Дата выдачи." format: "date" organization: type: "string" description: "Кем выдан." CashbackInfoHistoryItem: required: - "amount" - "date" - "offerId" type: "object" properties: amount: type: "number" description: "Сумма кэшбэка" date: type: "string" description: "Дата начисления кэшбэка" format: "date-time" offerId: type: "integer" description: "В рамках какого оффера было начисление" format: "int64" EptArrestStatus: type: "string" description: "Статус требования." enum: - "PAYED" - "ACTIVE" - "PAUSE" - "CANCELED" CreateReceiptRequest: oneOf: - $ref: "#/components/schemas/CreateForeignAgencyReceiptRequest" - $ref: "#/components/schemas/CreateIndividualReceiptRequest" - $ref: "#/components/schemas/CreateLegalEntityReceiptRequest" PaymentError1: required: - "number" type: "object" properties: number: type: "integer" description: "Идентификатор платежа, переданный клиентом при создании." format: "int32" accountNumber: type: "string" description: "Номер счёта самозанятого." errors: type: "array" description: "Ошибки валидации." items: $ref: "#/components/schemas/FieldValidationError" DocumentData: description: "Машиночитаемые данные документа." oneOf: - $ref: "#/components/schemas/ForeignIncomeStatement" - $ref: "#/components/schemas/IisOpen" - $ref: "#/components/schemas/IisPaymentOrder" - $ref: "#/components/schemas/Ndfl2" - $ref: "#/components/schemas/TaxReport" CashbackHistoryResponse: required: - "total" type: "object" properties: data: type: "array" description: "История начисления кэшбэка по чекам" items: $ref: "#/components/schemas/CashbackHistoryItem" total: type: "integer" description: "Общее количество элементов" format: "int64" ReceiptStatus: type: "string" description: "Статус чека." enum: - "IN_PROGRESS" - "REGISTERED" - "DECLINED" - "REGISTERED_OFFLINE" - "CANCELLED" OutputLimitPeriod: type: "string" description: "\nПериод обновления доступного остатка лимита на снятия наличн\ ых:\n" enum: - "DAY" - "MONTH" - "IRREGULAR" - "CUSTOM" SelfEmployedPayPaymentRegistryResultResponse: required: - "count" - "paymentRegistryId" - "status" type: "object" properties: paymentRegistryId: type: "integer" description: "Идентификатор платёжного реестра." format: "int32" status: $ref: "#/components/schemas/OrderPayStatus" count: type: "integer" description: "Количество платежей в реестре." format: "int32" error: required: - "errorCode" - "errorDescription" type: "object" properties: errorCode: type: "string" description: "Код ошибки." errorDescription: type: "string" description: "Описание ошибки." description: "Общая ошибка, произошедшая при создании реестра." paymentResults: type: "array" description: "Результаты оплаты." items: $ref: "#/components/schemas/PaymentPayResult" AccountInfo2: required: - "accountNumber" - "accountType" - "balance" - "bankBik" - "currency" - "name" type: "object" properties: accountNumber: type: "string" description: "Расчётный счёт организации." name: type: "string" description: "Наименование счёта." currency: type: "string" description: "Код валюты счёта по ОКВ (цифрами)." bankBik: pattern: "\\d{9}" type: "string" description: "БИК банка." accountType: type: "string" description: "Тип счёта. Список вариантов значений может пополняться.\n\ * `Current` — расчётный счёт.\n* `Tax` — счёт Тинькофф Бухгалтерии.\n\ * `Tender` — специальный счёт для участия в госзакупках.\n* `Overnight`\ \ — счёт Overnight.\n* `Trust` — специальный счёт доверительного управ\ ляющего ПИФ.\n* `Broker` — специальный брокерский счёт.\n* `BankPaymentAgent`\ \ — специальный счёт банковского платёжного агента.\n* `PaymentAgent`\ \ — счёт платёжного агента.\n* `Nominal` — номинальный счёт.\n* `NominalIpo`\ \ — номинальный счёт оператора инвестиционной платформы.\n* `TrustManagementSmp`\ \ — специальный счёт доверительного управления.\n* `Cashbox` — бизнес\ -копилка." activationDate: type: "string" description: "Дата активации." format: "date" balance: $ref: "#/components/schemas/Balance" transitAccount: $ref: "#/components/schemas/TransitAccount" SelfEmployedPaymentRegistrySubmitResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" DocumentDataResponse: required: - "documentData" - "documentType" type: "object" properties: documentType: $ref: "#/components/schemas/DocumentType3" documentData: $ref: "#/components/schemas/DocumentData" RecipientRequest: required: - "amount" - "beneficiaryId" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" amount: type: "number" description: "Сумма реципиента." tax: type: "number" description: "Налог реципиента." purpose: maxLength: 210 minLength: 1 type: "string" description: "Назначение платежа." bankDetailsId: type: "string" description: "Идентификатор банковских реквизитов." format: "uuid" keepOnVirtualAccount: type: "boolean" description: "Вывод на виртуальный счёт в рамках номинального счёта — true,\ \ на реальные реквизиты — false.\n\nПри создании реципиен\ та без банковских реквизитов, платеж в рамках сделки автоматически буд\ ет выполнен на виртуальный счет бенефициара." PhoneType: type: "string" description: "Тип телефона." enum: - "Мобильный" - "По месту жительства" - "Рабочий" VirtualCardRequisitesResponse: required: - "cvc" - "embossedName" - "expiryDate" - "number" type: "object" properties: number: pattern: "^\\d{16,19}$" type: "string" description: "Немаскированный номер карты." embossedName: type: "string" description: "Имя держателя карты." cvc: pattern: "^\\d{3,4}$" type: "string" description: "CVC карты." expiryDate: $ref: "#/components/schemas/ExpiryDate" CreatePaymentRequest1: oneOf: - $ref: "#/components/schemas/CreateRegularPaymentRequest" - $ref: "#/components/schemas/CreateTaxPaymentRequest" InternalError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Внутренняя ошибка сервера" type: type: "string" description: "INTERNAL_ERROR" InputLimitPeriod: type: "string" description: "\nПериод обновления доступного остатка:\n" enum: - "DAY" - "MONTH" - "IRREGULAR" InnResponse: type: "object" properties: inn: pattern: "^(\\d{12})$" type: "string" description: "ИНН." AccountInfo: required: - "accountNumber" - "balance" - "currency" type: "object" properties: accountNumber: type: "string" description: "Расчётный счёт организации." currency: type: "string" description: "Код валюты счёта по ОКВ (цифрами)." balance: $ref: "#/components/schemas/Balance" CreateEmployeeResultResponse: type: "object" properties: employeeResults: type: "array" description: "Список результатов создания сотрудников." items: $ref: "#/components/schemas/EmployeesResponse" CreationRegistryStatus: type: "string" description: "Статус создания:
" enum: - "CREATED" - "ERROR" - "QUEUED" OrderPayStatus: type: "string" description: "Статус создания платёжного реестра." enum: - "SEND_IN_PROGRESS" - "SENT" - "REJECTED" - "EXECUTED" - "PART_EXEC" - "ERROR" IncomeSourceResponse: required: - "title" type: "object" properties: title: type: "string" description: "Название группы" options: maxItems: 100 type: "array" description: "Детализация источников дохода в рамках группы" items: $ref: "#/components/schemas/OptionResponse" EmployeeCreateData: required: - "birthDate" - "birthPlace" - "citizenship" - "firstName" - "jobInfo" - "lastName" - "number" type: "object" properties: number: type: "integer" description: "Идентификатор сотрудника на стороне клиента." format: "int32" firstName: type: "string" description: "Имя (кириллица)." lastName: type: "string" description: "Фамилия (кириллица)." middleName: type: "string" description: "Отчество (кириллица)." birthDate: type: "string" description: "Дата рождения." format: "date" birthPlace: type: "string" description: "Место рождения." citizenship: type: "string" description: "Гражданство." email: type: "string" description: "Электронная почта." latinFirstName: type: "string" description: "Имя (латиница)." latinLastName: type: "string" description: "Фамилия (латиница)." phones: type: "array" description: "Телефон — обязательно укажите мобильный телефон." items: $ref: "#/components/schemas/CreatePhone" addresses: type: "array" description: "Адреса — обязательно укажите адреса жительства, регистраци\ и и работы." items: $ref: "#/components/schemas/CreateAddress" documents: type: "array" description: "Для граждан РФ укажите данные паспорта.\n\nДля иностранных\ \ граждан укажите:\n\n" items: $ref: "#/components/schemas/CreateDocument" jobInfo: $ref: "#/components/schemas/CreateJobInfo" SelfEmployedCreatePaymentRegistryResponse: required: - "correlationId" type: "object" properties: correlationId: type: "string" description: "Идентификатор, связывающий запрос создания с запросом полу\ чения ответа." format: "uuid" Document: required: - "type" type: "object" properties: type: $ref: "#/components/schemas/DocumentType" serial: type: "string" description: "Серия." number: type: "string" description: "Номер документа." date: type: "string" description: "Дата." format: "date" organization: type: "string" description: "Кем выдан." division: type: "string" description: "Код подразделения." expireDate: type: "string" description: "Дата истечения." format: "date" NotInTimeError: required: - "message" - "type" type: "object" properties: message: type: "string" description: "Чек не попадает в период действия акции" type: type: "string" description: "NOT_IN_TIME" GetIntervalsRequest: required: - "address" type: "object" properties: taskIds: type: "array" description: "Cписок идентификаторов заданий, по которым нужно получить\ \ доступные интервалы для назначения встреч." items: type: "string" address: $ref: "#/components/schemas/Address2" BeneficiaryUlResidentResponse: required: - "beneficiaryId" - "inn" - "type" type: "object" properties: beneficiaryId: type: "string" description: "Идентификатор бенефициара." format: "uuid" type: type: "string" description: "Тип бенефициара:\n* `FL_RESIDENT` — физическое лицо, резид\ ент.\n* `FL_NONRESIDENT` — физическое лицо, нерезидент.\n* `UL_RESIDENT`\ \ — юридическое лицо, резидент.\n* `UL_NONRESIDENT` — юридическое лицо\ , нерезидент.\n* `IP_RESIDENT` — ИП, резидент.\n* `IP_NONRESIDENT` — И\ П, нерезидент.\n* `LITE_CONTACT` — лёгкий контакт." enum: - "FL_RESIDENT" - "FL_NONRESIDENT" - "UL_RESIDENT" - "UL_NONRESIDENT" - "IP_RESIDENT" - "IP_NONRESIDENT" - "LITE_CONTACT" name: type: "string" description: "Наименование организации." phoneNumber: pattern: "^((\\+[0-9])([0-9]){6,14})$" type: "string" description: "Номер телефона." email: type: "string" description: "Электронная почта." addresses: type: "array" description: "Адреса." items: $ref: "#/components/schemas/Address" registrationDate: type: "string" description: "Дата регистрации." format: "date" opf: type: "string" description: "Организационно-правовая форма." inn: pattern: "^(\\d{10})$" type: "string" description: "ИНН." ogrn: pattern: "^(\\d{13})$" type: "string" description: "Основной государственный регистрационный номер." PermissionTypeEnum: type: "string" enum: - "PAYMENT_INFORMATION" - "TAXPAYER_UPDATE" - "CANCEL_ANY_INCOME" - "CANCEL_INCOME" - "INCOME_SUMMARY" - "INCOME_REGISTRATION" - "INCOME_LIST" - "PERMISSIONS_MGMT" - "TAX_PAYMENT" CardBankDetailsRequest: required: - "cardData" - "terminalKey" - "type" type: "object" properties: type: type: "string" description: "Тип банковских реквизитов:\n* `PAYMENT_DETAILS` — По рекви\ зитам счёта.\n* `CARD` — На карту.\n* `SBP` — Через СБП." enum: - "PAYMENT_DETAILS" - "CARD" - "SBP" isDefault: type: "boolean" description: "Являются ли реквизиты основными для бенефициара. По умолча\ нию для первых добавленных реквизитов — `true`, для следующих — `false`." terminalKey: maxLength: 256 minLength: 1 type: "string" description: "Ключ терминала." cardData: maxLength: 512 minLength: 1 type: "string" description: "\nЗашифрованные данные карты.\nОбъект `CardData` собираетс\ я в виде списка «ключ=значение» (разделитель «;») и зашифровывается от\ крытым ключом (X509 RSA 2048). Получившееся бинарное значение кодирует\ ся в Base64.\nСписок значений:\n\n* `PAN` — обязательный параметр, ном\ ер карты. Число.\n* `ExpDate` — необязательный параметр, месяц и год с\ рока действия карты в формате MMYY. Число.\n* `CardHolder` — необязате\ льный параметр, имя и фамилия держателя карты — как на карте. Строка.\n\ * `CVV` — необязательный параметр, код защиты с обратной стороны карты\ . Строка.\n\nПример: `PAN=4300000000000777;ExpDate=0523;CardHolder=IVAN\ \ PETROV;CVV=111`\n\nОткрытый ключ генерируется банком. Чтобы получить\ \ открытый ключ для шифрования `CardData`, напишите на acq_help@tinkoff.ru\ \ или обратитесь к сотруднику, который помогал вам с процессом выпуска\ \ терминала.\n" securitySchemes: httpAuth: type: "http" scheme: "bearer" x-tagGroups: name: "Методы:" tags: - "Tinkoff Business ID. Информация о компании" - "Tinkoff ID. Информация о пользователе" - "Tinkoff ID. Делегированная идентификация" - "Счета и выписки" - "Платежи" - "Зарплатный проект" - "Выплаты самозанятым" - "Самозанятые" - "Выставление счетов" - "Номинальные счета" - "Безакцептные списания" - "Специальные счета" - "Безопасная сделка" - "Торговый эквайринг" - "Проверка контрагентов" - "Бизнес-карты" - "Удалённая идентификация сотрудников" - "Партнерские методы для работы с заявкой на покупку в кредит (PROD)" - "Партнерские методы для работы с заявкой на покупку в кредит (TEST)" - "Рейтинги продуктов" - "Тинькофф Корзина. Работа с заказом" - "Кредитные продукты" - "Интернет-эквайринг. Диспуты" - "Партнёрская доставка" - "Cпецпредложения и кэшбэк" - "Декларации 3-НДФЛ" - "Tinkoff ID" - "Бенефициары и реквизиты" - "Биллинг" - "Депоненты и реципиенты" - "Партнёрские методы для работы с заявкой на выдачу кредита наличными" - "Платёжные требования" - "Правила" - "Соглашения" - "Управление сделками" - "Управление этапами сделок"