Выплаты

Выплата — заявка на перечисление партнёру заработанного вознаграждения. Через внешний API заявку можно посмотреть, создать и провести по статусам — например, если решение о выплате принимает ваша бухгалтерская система, а не администратор в интерфейсе.

Все пути ниже даны относительно базового адреса /api/external, каждый запрос требует заголовок x-api-key — см. Внешний API.

Какие бывают статусы выплаты

Статус	Что означает
`Requested`	заявка создана, ждёт решения
`Approved`	подтверждена, ждёт перечисления
`Paid`	деньги перечислены партнёру
`Rejected`	отклонена
`Canceled`	партнёр отменил заявку сам, в личном кабинете

Заявка создаётся сразу в статусе Requested. Перевести её в Approved, Paid или Rejected можно и через внешний API, и из админки — этим методом или соответствующей кнопкой в карточке заявки. Статус Canceled доступен только партнёру: ни администратор, ни внешний API отменить чужую заявку не могут.

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

GET /api/external/payout
x-api-key: ваш-ключ

Метод возвращает все заявки контура одним списком — без пагинации и без фильтра по статусу, в отличие от списка в админке. Заявки отсортированы по дате создания, от новых к старым.

[
  {
    "id": "7c1f…",
    "partner": { "id": "3d21…", "firstName": "Иван", "lastName": "Иванов", "middleName": null, "email": "partner@example.com" },
    "amount": 15000,
    "status": "Paid",
    "requisites": "Карта 2200 **** **** 1234",
    "partnerComment": null,
    "adminComment": "Ежемесячная выплата",
    "processedBy": { "id": "a001…", "email": "admin@example.com", "firstName": "Пётр", "lastName": "Петров", "middleName": null },
    "createdAt": "2026-08-01T10:00:00.000Z",
    "updatedAt": "2026-08-03T09:00:00.000Z",
    "processedAt": "2026-08-03T09:00:00.000Z"
  }
]

Поле	Что означает
`partner`	партнёр, которому предназначена выплата
`amount`	сумма выплаты
`requisites`	реквизиты для перечисления, свободный текст
`partnerComment`	комментарий партнёра — заполняется, когда он сам создаёт или отменяет заявку в личном кабинете
`adminComment`	комментарий администратора либо ваш комментарий при создании или смене статуса через API
`processedBy`	администратор, который перевёл заявку в `Paid` из админки; `null`, если заявка ещё не выплачена или выплачена через API
`processedAt`	дата перевода в `Paid`; `null`, пока заявка не выплачена

Как создать заявку на выплату

POST /api/external/payout
x-api-key: ваш-ключ
Content-Type: application/json

{
  "partnerId": "3d21…",
  "amount": 15000,
  "requisites": "Карта 2200 **** **** 1234",
  "adminComment": "Ежемесячная выплата"
}

Поле	Обязательное	Описание
`partnerId`	да	id партнёра из списка партнёров
`amount`	да	сумма выплаты
`requisites`	нет	реквизиты для перечисления
`adminComment`	нет	комментарий к заявке

Перед созданием заявки метод проверяет: партнёр существует и не заблокирован, у него нет другой активной заявки (в статусе Requested или Approved), сумма не меньше минимальной, заданной в настройках контура, и не превышает баланс, доступный партнёру к выводу, а ИНН партнёра заполнен и проходит проверку по контрольным цифрам.

Проверку ИНН можно отключить для всего контура переключателем Требовать ИНН для выплат в общих настройках — он включён по умолчанию. Пока он включён, ИНН партнёра сохраняется в заявку: значение фиксируется на момент создания и не меняется, даже если позже ИНН в профиле исправят.

В ответ приходит созданная заявка со статусом Requested и историей статусов из одной записи:

{
  "id": "7c1f…",
  "partner": { "id": "3d21…", "firstName": "Иван", "lastName": "Иванов", "middleName": null, "email": "partner@example.com" },
  "amount": 15000,
  "status": "Requested",
  "requisites": "Карта 2200 **** **** 1234",
  "partnerComment": null,
  "adminComment": "Ежемесячная выплата",
  "processedBy": null,
  "createdAt": "2026-09-08T10:00:00.000Z",
  "updatedAt": "2026-09-08T10:00:00.000Z",
  "processedAt": null,
  "history": [
    {
      "id": "e001…",
      "status": "Requested",
      "comment": "Ежемесячная выплата",
      "createdAt": "2026-09-08T10:00:00.000Z",
      "changedByAdmin": null,
      "changedByApiKey": { "id": "k001…", "title": "CRM", "admin": { "id": "a001…", "email": "admin@example.com", "firstName": "Пётр", "lastName": "Петров", "middleName": null } }
    }
  ]
}

Как изменить статус выплаты

PUT /api/external/payout/{id}/status
x-api-key: ваш-ключ
Content-Type: application/json

{ "status": "Approved", "comment": "Проверено" }

Поле	Обязательное	Описание
`status`	да	`Approved`, `Paid` или `Rejected`
`comment`	нет	комментарий к смене статуса

Допустимый переход зависит от текущего статуса заявки:

Новый статус	Из какого статуса
`Approved`	только из `Requested`
`Paid`	только из `Approved`
`Rejected`	из `Requested` или `Approved`

В ответ приходит заявка целиком, в том же формате, что и при создании. По history видно, кто и когда менял статус: changedByAdmin заполнен, если статус сменили из админки, changedByApiKey — если через внешний API; второе поле пары при этом равно null.

Какие ошибки возвращают методы выплат

Ответ	Сообщение	Что делать
`400`	Партнер обязателен	передайте `partnerId`
`400`	Сумма выплаты обязательна	передайте `amount`
`400`	Партнер заблокирован	у заблокированного партнёра заявку не создать
`400`	Уже есть активная заявка на выплату	дождитесь решения по прежней заявке или её отмены партнёром
`400`	Некорректная сумма вывода	сумма должна быть положительным числом
`400`	Минимальная сумма вывода: …	увеличьте сумму до указанной в сообщении
`400`	Доступно для вывода: …	сумма превышает баланс, доступный партнёру к выводу
`400`	Для вывода средств заполните ИНН в профиле	у партнёра не заполнен ИНН — внесите его в карточке партнёра или через интерфейс администратора
`400`	ИНН в профиле указан некорректно…	ИНН не проходит проверку по контрольным цифрам: 12 знаков у физлица, самозанятого и ИП, 10 у юридического лица
`400`	Допустимые статусы: Approved, Paid, Rejected	передайте один из этих трёх статусов
`404`	Партнер не найден	проверьте `partnerId`
`409`	Недопустимый переход статуса	заявки с таким `id` нет, либо её текущий статус не допускает такой переход — см. таблицу переходов выше

Читать также

Внешний API — базовый адрес, ключи и остальные методы
Партнёры — список партнёров, которым можно создать выплату
Выплаты — тот же список и карточка заявки в интерфейсе администратора