Skip to main content

Объект возврата

Объект возврата (Refund) содержит всю информацию о возврате. Он приходит в ответ на любой запрос, связанный с возвратами.

ПАРАМЕТР
ОПИСАНИЕ
idstring, required

Идентификатор возврата.

payment_idstring, required

Идентификатор платежа.

statusstring, required

Статус возврата платежа. Возможные значения:

  • NEW — возврат создан, но пока ещё не обрабатывается
  • CONFIRMED — возврат успешно завершен, указанная в запросе сумма переведена на платежное средство пользователя (финальный и неизменяемый статус);
  • CANCELED — возврат отменен(финальный и неизменяемый статус)
  • PROCESS — возврат в процессе обработки.

amountobject, required

Сумма, которую нужно вернуть пользователю.

created_atstring, required

Дата и время создания возврата в формате ISO 8601.

metadataobject, optional

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от API. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

descriptionstring, optional

Комментарий к возврату. Например, основание для возврата денег пользователю.

Пример объекта
{
  "id": "d69468b3-c434-4a8f-bbfa-356cbb8afa71",
  "payment_id": "79bacb54-ee40-4d33-85c9-8191c55727d7",
  "status": "NEW",
  "amount": {
    "currency": "RUB",
    "value": 1000
  },
  "metadata": {},
  "description": "Клиент передумал покупать товар",
  "created_at": "2024-01-01T12:00:00Z"
}