Используйте этот запрос, чтобы найти выплаты по заданным критериям. Доступен только для выплат, созданных за последние 3 месяца; сейчас поддерживается поиск только по параметру metadata, а также можно указать дату и время создания выплаты (параметр created_at). Данные для аутентификации запросов зависят от платежного решения — обычные выплаты или выплаты в рамках Безопасной сделки.
Документация: https://yookassa.ru/developers/api#get_payouts_search
| Параметр | Где | Тип | Обяз. | Описание |
|---|---|---|---|---|
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 |
metadata |
query | object | нет | Фильтр по объекту metadata: строгий поиск по паре «ключ-значение» (возвращаются объекты с точным совпадением ключа и значения). Ограничения: не больше одной пары «ключ-значение», имя ключа — не больше 32 символов, значение ключа — не больше 512 символов, тип данных — строка в формате UTF-8 в URL-кодированном виде. Шаблон: metadata[key]=value. Пример: metadata%5Boperation_id%5D=e2ab2e1c-776d-4376-aba8-d2099243d1f6 |
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
}
]
}
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 <Идентификатор магазина>:<Секретный ключ>
Если этого недостаточно — официальная документация: https://yookassa.ru/developers/api#get_payouts_search Вся интеграция одним документом: https://mcp-everything.ru/integrations/yookassa.md