Запрос позволяет получить список платежей. Можно запросить платежи, созданные за последние 3 года. Список можно отфильтровать по заданным критериям.
Документация: https://yookassa.ru/developers/api#get_payments_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 |
captured_at.gte |
query | string | нет | Фильтр по времени подтверждения платежа: время должно быть больше или равно указанного значения («от указанного момента, включительно»). Указывается в формате ISO 8601. Пример: captured_at.gte=2018-07-18T10:51:18.139Z |
captured_at.gt |
query | string | нет | Фильтр по времени подтверждения платежа: время должно быть больше указанного значения («от указанного момента, не включая»). Указывается в формате ISO 8601. Пример: captured_at.gt=2018-07-18T10:51:18.139Z |
captured_at.lte |
query | string | нет | Фильтр по времени подтверждения платежа: время должно быть меньше или равно указанного значения («до указанного момента, включительно»). Указывается в формате ISO 8601. Пример: captured_at.lte=2018-07-18T10:51:18.139Z |
captured_at.lt |
query | string | нет | Фильтр по времени подтверждения платежа: время должно быть меньше указанного значения («до указанного момента, не включая»). Указывается в формате ISO 8601. Пример: captured_at.lt=2018-07-18T10:51:18.139Z |
payment_method |
query | string (bank_card, cash, alfabank, webmoney, wechat, apple_pay, google_pay, qiwi) | нет | Фильтр по коду способа оплаты. Пример: payment_method=bank_card |
status |
query | string (pending, waiting_for_capture, 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": "1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
"status": "succeeded",
"amount": {
"value": "1000.00",
"currency": "RUB"
},
"created_at": "2017-11-03T11:52:31.827Z",
"paid": true,
"test": false,
"refundable": true,
"recipient": {
"account_id": "123",
"gateway_id": "456"
}
}
]
}
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_payments_list Вся интеграция одним документом: https://mcp-everything.ru/integrations/yookassa.md