Возврат выполненного платежа

POST /v2/payments/{payId}/refund

Создает запрос на возврат для существующего платежа. Возврат может быть полным или частичным (в зависимости от параметра amount).

---

Параметры запроса

Path-параметр

Имя	Тип	Обязательный	Описание
payId	string (GUID)	да	Уникальный идентификатор платежа, зарегистрированного в системе.

Параметры body

Имя	Тип	Обязательный	Описание
amount	number (decimal)	нет	Сумма возврата. Если указана — инициируется частичный возврат на указанную сумму. Если не указана — инициируется полный возврат.
reason	string	да	Причина возврата (рекомендуется до 500 символов).
callbackUrl	string (URL)	нет	HTTPS URL, на который система отправит callback, когда возврат будет принят/обработан.

Пример запроса

{
  "amount": 50.61,
  "reason": "Reason for payment refund.",
  "callbackUrl": "https://www.example.com"
}

---

Параметры ответа

Объект result

Имя	Тип	Описание
refundId	string (GUID)	Уникальный идентификатор созданного возврата в системе.
status	string (enum)	Статус запроса на возврат. Возможное значение: Created.

Прочие поля

Имя	Тип	Описание
ok	boolean	Признак успешной обработки запроса.
errors	array / null	Детали ошибок (если есть); иначе null.

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

{
  "result": {
    "refundId": "8ce09e40-2948-4225-a9c4-f277dbd587ea",
    "status": "Created"
  },
  "ok": true,
  "errors": null
}

---