ЮKassa: POST /payouts — Создание выплаты

Используйте этот запрос, чтобы создать в ЮKassa объект выплаты. В запросе нужно передать сумму выплаты, данные о способе получения выплаты (например, номер кошелька ЮMoney), описание выплаты и при необходимости дополнительные параметры. Параметры и данные для аутентификации зависят от платежного решения — обычные выплаты или выплаты в рамках Безопасной сделки.

Документация: https://yookassa.ru/developers/api#create_payout

Параметр Где Тип Обяз. Описание
Idempotence-Key header string да Ключ идемпотентности. Рекомендуется использовать строку вида UUID v7
amount body object да Сумма выплаты. Есть ограничения на минимальный и максимальный размер выплаты и сумму выплат за месяц. Подробнее о лимитах обычных выплат и выплат в рамках Безопасной сделки
amount.value body string да Сумма в выбранной валюте, всегда в дробном виде. Разделитель дробной части — точка, разделителя тысяч нет. Количество знаков после точки зависит от выбранной валюты. Пример: 1000.00.
amount.currency body string (RUB, EUR, USD, KZT, BYN, UAH, UZS, TRY) да Трехбуквенный код валюты в формате ISO-4217. Пример: RUB.
payout_destination_data body object нет
payout_destination_data.type body string (yoo_money, bank_card, sbp) нет Способ получения выплаты: * yoo_money — выплаты на кошелек ЮMoney; * bank_card — выплаты на банковскую карту; * sbp — выплаты через СБП на счет в банке или платежном сервисе.
payout_destination_data.account_number body string нет Номер кошелька ЮMoney, например 41001614575714. Длина от 11 до 33 цифр. Статус кошелька для обычных выплат — любой, для выплат в рамках Безопасной сделки — именной или идентифицированный.
payout_destination_data.card body object нет Данные банковской карты для выплаты.
payout_destination_data.phone body string нет Телефон, к которому привязан счет получателя выплаты в системе участника СБП. Указывается в формате ITU-T E.164, например 79000000000.
payout_destination_data.bank_id body string нет Идентификатор участника СБП — банка или платежного сервиса, подключенного к сервису. Максимум 12 символов.
payout_token body string нет Токенизированные данные для выплаты. Например, синоним банковской карты. Обязательный параметр, если не передан payout_destination_data или payment_method_id.
payment_method_id body string нет Идентификатор сохраненного способа оплаты, данные которого нужно использовать для проведения выплаты. Подробнее о выплатах с использованием идентификатора сохраненного способа оплаты Обязательный параметр, если не передан payout_destination_data или payout_token.
description body string нет Описание транзакции (не более 128 символов). Например: «Выплата по договору 37».
deal body object нет Сделка, в рамках которой нужно провести выплату. Необходимо передавать, если вы проводите Безопасную сделку
deal.id body string нет Идентификатор сделки.
personal_data body object[] нет Персональные данные получателя выплаты. Только для обычных выплат. Необходимо передавать в этих сценариях: * выплаты с проверкой получателя (только для выплат через СБП); * выплаты с передачей данных получателя для выписок из реестра. В массиве можно одновременно передать несколько идентификаторов, но только для разных типов данных.
metadata body object нет Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: не больше 16 ключей, имя ключа — не больше 32 символов, значение ключа — не больше 512 символов, тип данных — строка в формате UTF-8.

Пример запроса:

{
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  }
}

Пример ответа:

{
  "id": "po-27ced252-0025-5000-9000-0a682a8bab8f",
  "amount": {
    "value": "1000.00",
    "currency": "RUB"
  },
  "status": "pending",
  "payout_destination": {
    "type": "bank_card"
  },
  "created_at": "2020-07-03T11:52:31.827Z",
  "test": false
}

Базовые URL

Авторизация

Тип: Basic Auth

HTTP Basic Auth: имя пользователя — идентификатор магазина (shopId, раздел Настройки — Магазин) или шлюза для выплат (agentId, раздел Настройки выплат), пароль — секретный ключ (раздел Интеграция — Ключи API). Для тестового магазина ключ выпускается автоматически. Участники партнерской программы используют OAuth 2.0 и передают Bearer-токен. Секретный ключ и OAuth-токен нельзя публиковать.

curl https://api.yookassa.ru/v3/payments/{payment_id} \
  -u <Идентификатор магазина>:<Секретный ключ>

Нюансы


Если этого недостаточно — официальная документация: https://yookassa.ru/developers/api#create_payout Вся интеграция одним документом: https://mcp-everything.ru/integrations/yookassa.md