ЮKassa: GET /payouts — Список выплат

Используйте этот запрос, чтобы получить список выплат. Доступны выплаты, созданные за последние 3 года. Список можно отфильтровать по заданным критериям. Способ аутентификации запроса зависит от решения, которое вы используете: обычные выплаты или выплаты в рамках Безопасной сделки.

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

Параметр	Где	Тип	Обяз.	Описание
`created_at.gte`	query	string	нет	Фильтр по времени создания: время должно быть больше указанного значения или равно ему («от такого-то момента включительно»). Указывается в формате ISO 8601. Пример: created_at.gte=2018-07-18T10:51:18.139Z
`created_at.gt`	query	string	нет	Фильтр по времени создания: время должно быть больше указанного значения («от такого-то момента не включительно»). Указывается в формате ISO 8601. Пример: created_at.gt=2018-07-18T10:51:18.139Z
`created_at.lte`	query	string	нет	Фильтр по времени создания: время должно быть меньше указанного значения или равно ему («до такого-то момента включительно»). Указывается в формате ISO 8601. Пример: created_at.lte=2018-07-18T10:51:18.139Z
`created_at.lt`	query	string	нет	Фильтр по времени создания: время должно быть меньше указанного значения («до такого-то момента не включительно»). Указывается в формате ISO 8601. Пример: created_at.lt=2018-07-18T10:51:18.139Z
`succeeded_at.gte`	query	string	нет	Фильтр по времени успешной обработки выплаты: время должно быть больше указанного значения или равно ему («от такого-то момента включительно»). Указывается в формате ISO 8601. Пример: succeeded_at.gte=2018-07-18T10:51:18.139Z
`succeeded_at.gt`	query	string	нет	Фильтр по времени успешной обработки выплаты: время должно быть больше указанного значения («от такого-то момента не включительно»). Указывается в формате ISO 8601. Пример: succeeded_at.gt=2018-07-18T10:51:18.139Z
`succeeded_at.lte`	query	string	нет	Фильтр по времени успешного проведения выплаты: время должно быть меньше указанного значения или равно ему («до момента времени включительно»). Указывается в формате ISO 8601. Пример: succeeded_at.lte=2018-07-18T10:51:18.139Z
`succeeded_at.lt`	query	string	нет	Фильтр по времени успешного проведения выплаты: время должно быть меньше указанного значения («до момента времени исключительно»). Указывается в формате ISO 8601. Пример: succeeded_at.lt=2018-07-18T10:51:18.139Z
`payout_destination.type`	query	string (yoo_money, bank_card, sbp)	нет	Фильтр по способу получения выплаты. Пример: payout_destination.type=bank_card
`status`	query	string (pending, succeeded, canceled)	нет	Фильтр по статусу выплаты. Пример: status=succeeded
`limit`	query	integer	нет	Размер выдачи результатов запроса — количество объектов, передаваемых в ответе. Возможные значения: от 1 до 100. Пример: limit=50. Значение по умолчанию: 10.
`cursor`	query	string	нет	Указатель на следующий фрагмент списка. Пример: cursor=37a5c87d-3984-51e8-a7f3-8de646d39ec15. В качестве cursor необходимо использовать параметр next_cursor, полученный в ответе на предыдущий запрос. Используется, если размер списка больше размера выдачи (limit) и конец выдачи не достигнут.

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

{
  "type": "list",
  "items": [
    {
      "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

Основной: https://api.yookassa.ru/v3

Авторизация

Тип: Basic Auth

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

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

Нюансы

capture по умолчанию false: без capture: true платеж останется в статусе waiting_for_capture и в момент expires_at отменится автоматически, деньги вернутся покупателю.
Для POST и DELETE обязателен заголовок Idempotence-Key — до 64 символов, рекомендуется UUID. Повтор с тем же ключом в течение 24 часов вернет результат первого запроса; для новой операции нужен новый ключ.
HTTP 500 не значит, что операция не прошла: результат неизвестен. Повтори запрос с теми же данными и тем же ключом идемпотентности или запроси объект через GET.
Возврат покупателя на return_url не означает успешную оплату — статус проверяй на сервере или по HTTP-уведомлению.
Сумма — строка с точкой и двумя знаками: "1000.00", вместе с кодом валюты.
Методы /webhooks работают только с OAuth-токеном в партнерской программе. Обычный магазин настраивает уведомления в личном кабинете.
Вернуть платеж можно в течение трех лет с момента создания. Комиссия ЮKassa за платеж не возвращается.
Для Чеков от ЮKassa частичная предоплата, аванс и кредит не поддерживаются.

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