Список возвратов
Шаги для получения списка всех возвратов по платежам
В этом разделе мы рассмотрим, как получить список всех возвратов. Этот функционал полезен для отображения истории возвратов.
Вызов метода для получения списка возвратов
Метод getRefunds позволяет получать список всех возвратов. Вы можете использовать его для фильтрации возвратов по датам, а также задавать ограничение на количество отображаемых возвратов на странице (пагинация).
Функция имеет следующие параметры:
limit (число) — максимальное количество возвратов, которое будет возвращено на одну страницу.
from (строка) — начальная дата в формате YYYY-MM-DD для фильтрации возвратов по дате.
to (строка) — конечная дата в формате YYYY-MM-DD для фильтрации возвратов по дате.
import { YookassaService } from 'nestjs-yookassa';
@Injectable()
export class RefundService {
constructor(private readonly yookassaService: YookassaService) {}
async getRefundsList() {
const limit = 2; // Ограничение на количество возвратов
const from = '2025-01-01'; // Начальная дата фильтра
const to = '2025-01-31'; // Конечная дата фильтра
const refunds = await this.yookassaService.getRefunds(limit, from, to);
return refunds
}
}Обработка ответа от API
Ответ от API содержит массив объектов RefundDetails, где каждый объект представляет собой информацию о возврате. Пример ответа может быть следующим:
{
"type": "list", // Тип ответа, в данном случае список
"next_cursor": "2f1d20e1-0016-5000-8000-12fc2af7f19b", // Указатель на следующую страницу (для пагинации)
"items": [
{
"id": "2f1d29e9-0015-5000-a000-1e7e28fedd75",
"payment_id": "2f1d28e4-000f-5000-a000-15f2d944be24",
"status": "succeeded",
"created_at": "2025-01-18T02:47:05.077Z",
"amount": {
"value": "529.00",
"currency": "RUB"
},
"description": "Возврат на заказ с ID 2f1d28e4-000f-5000-a000-15f2d944be24"
},
{
"id": "2f1d2280-0015-5000-b000-1c02972ec0ef",
"payment_id": "2f1d224b-000f-5000-b000-12fc94fd0013",
"status": "succeeded",
"created_at": "2025-01-18T02:15:28.461Z",
"amount": {
"value": "529.00",
"currency": "RUB"
},
"description": "Возврат на заказ с ID 2f1d224b-000f-5000-b000-12fc94fd0013"
}
]
}