Полный возврат средств

Метод позволяет совершить полный возврат средств по счету.

к сведению

Зачисление средств на счет покупателя займет до 10 рабочих дней.

подсказка

Если не знаете с чего начать, прочтите инструкцию в сценариях использования.

Параметры взаимодействия

Для реальных платежей:

PATCH

https://public-api.rustore.ru/public/applications/{appId}/invoices/{invoiceId}

предупреждение

Для тестовых платежей используйте отдельный метод:

PATCH

https://public-api.rustore.ru/public/sandbox/applications/{appId}/invoices/{invoiceId}

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
appId	number	Идентификатор приложения из RuStore консоли, в котором совершается возврат. 1.Перейдите на вкладку Приложения и выберите нужное приложение. 2.Скопируйте идентификатор из URL-адреса страницы приложения — это набор цифр между apps/ и /versions. Например, для URL-адреса https://console.rustore.ru/apps/123456/versions ID приложения — 123456.	Да	path	1234
invoiceId	number	Как получить invoiceId, см. документацию по SDK платежей.	Да	path	4567

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

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
code	string	Код ответа.	Да	body	• ОК; •ERROR; •BAD_REQUEST; • NOT_FOUND.
message	string	Расшифровка кода ответа.	Нет	body	Invoice has already been refunded
body	object	Тело ответа.	Нет	body	N/A
timestamp	string	Время ответа.	Да	body	2025-02-25T07:25:01.273Z

Пример успешного ответа

{
"code": "OK",
  "message": null,
  "body": {},
  "timestamp": "2025-02-25T07:25:01.273Z"
}

Пример ответа с ошибкой

{
  "code": "ERROR",
  "message": "Jwe token is expired"",
  "body": null,
  "timestamp": "2025-02-25T07:25:01.277Z"
}

Список ошибок

Message	Расшифровка
Something went wrong.	Что-то пошло не так.
Invoice has already been refunded.	Платеж уже возвращен.
Cannot refund now. Try again later.	Невозможно совершить возврат. Попробуйте позже.
Refund amount cannot exceed payment amount.	Сумма возврата не может превышать сумму оплаты.
Invoice cannot be refunded.	Невозможно совершить возврат.
Invoice status must be CONFIRMED.	Статус счета должен быть ПОДТВЕРЖДЕН.
Forbidden	Доступ запрещен