ym88659208ym87991671
Создание команды | Документация для разработчиков

Создание команды

Обновлено 18 августа 2026

Описание: создание новой команды.

Важно: перед созданием команды необходимо получить список доступных типов команд через POST /api/team/type/list и выбрать подходящий typeCode для передачи в запросе на создание.

Последовательность шагов

  1. Получить список типов команд — отправить POST /api/team/type/list с заголовком Authorization (apiKey партнера).

  2. Обработать ответ на type/list:

    • list — массив доступных типов команд, каждый тип содержит:
      • code — код типа (например: "team.type.bar")
      • title — название типа (например: "Bar")
    • Выбрать нужный code для передачи в запросе на создание команды.
  3. Подготовить запрос на создание команды — сформировать тело запроса для POST /api/team/add с обязательными параметрами:

    • title — название команды (обязательный параметр, от 1 до 40 символов)
    • typeCode — код типа команды (обязательный параметр, полученный на шаге 2, например: "team.type.restaurant")

    Необязательные параметры:

    • qrCodeName — имя QR-кода команды (от 1 до 40 символов)
    • address — адрес команды (от 1 до 200 символов, например: "City, Street name, build number")
    • legalEntity — юридическое лицо (например: "LLC Tips")
    • legalAddress — юридический адрес
    • inn — ИНН юридического лица (паттерн: ^(\d{10}|\d{12})$)
    • presetAmount — предустановленные суммы чаевых
  4. Отправить запрос через POST /api/team/add с заголовком Authorization (apiKey партнера).

  5. Обработать успешный ответ:

    • team.uuid — уникальный идентификатор созданной команды
    • team.qrCode.uuid — UUID QR-кода, привязанного к команде
    • team.title — название команды
    • team.typeCode — код типа команды
    • team.address — адрес команды
    • team.legalEntity — юридическое лицо
    • team.legalAddress — юридический адрес
    • team.status — статус команды
    • team.createdAt — дата создания
    • team.limits — агрегированные лимиты сумм переводов (minAmount, maxAmount)
    • team.presetAmount — предустановленные суммы чаевых

Альтернативные сценарии ошибок

Код ошибкиОписание
field.invalid.format.errorНекорректный формат переданных параметров
teamType.notFound.errorТип команды для переданного параметра typeCode не найден
client.notFound.errorКлиент не найден
client.blocked.errorКлиент заблокирован
legal.fields.errorНе все обязательные поля для юридических лиц заполнены
header.invalid.errorЗаголовок Authorization не передан
no.session.errorКлиент не аутентифицирован
Заметили ошибку?
Выделите текст и нажмите
Ctrl
+
Enter
, чтобы сообщить нам об ошибке