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

POST /v2/mia/payments/{payId}/refund

Этот эндпоинт позволяет инициировать возврат средств по успешно завершённому платежу, идентифицированному по payId.

---

Request parameters (path)

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

Request parameters (body)

Наименование	Тип	Обязательно	Описание
reason	string (max. 500 caractere)	Да	Причина инициирования возврата средств.

Request example

{
    "reason": "Client returned the product"
}

---

Response parameters

Object result

Наименование	Тип	Описание
payId	string (GUID)	Уникальный идентификатор платежа, по которому был осуществлен возврат.
status	string (enum)	Итоговый статус платежа. Возможное значение: Refunded.

Other fields

Наименование	Тип	Описание
ok	boolean	Указывает, была ли заявка обработана успешно.
errors	array	Содержит детали о возникших ошибках при обработке.
errors.errorCode	string	Код ошибки.
errors.errorMessage	string	Описание ошибки.

---

Response example

{
    "result": {
        "payId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "Refunded"
    },
    "ok": true
}