Возврат по инвойсу
JSON API v3
POST /api/v3/projects/{projectId}/invoices/{invoiceId}/refund
Инициирует возврат средств по оплаченному инвойсу. Фактический возврат выполняется асинхронно, результат доставляется вебхуком.
В песочнице требование «по оплаченному» проверяется: возврат по неоплаченному,
отменённому или ещё не тарифицированному инвойсу отвергается
422 INVOICE_NOT_PAID, и его payment_status не меняется.
Payload подписи v4: {invoice_id}{client_ip}
Параметры запроса
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
projectId | integer (int32) | да | |
invoiceId | string (uuid) | да |
Тело запроса
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
client_ip | string | — | |
additional_parameters | object | — | Дополнительные параметры счёта — произвольные пары «имя — значение» (JSON-эквивалент блока <AdditionalParameters> из XML API). Через них передаются служебные флаги обработки, например NeedSendNotification, и собственные метки продавца. Имена нечувствительны к регистру и должны быть уникальны: Flag и flag в одном объекте — ошибка запроса (400 BAD_REQUEST), а не два параметра. Блок принимают создание счёта (внутри order), а также авторизация, отмена и возврат (на верхнем уровне тела): переданные значения дописываются к уже сохранённым у счёта, совпадающие по имени — перезаписываются. |
Пример запроса
{}Коды ответов
| Код | Описание |
|---|---|
202 | Возврат принят в обработку |
400 | Ошибка валидации или бизнес-ошибка запроса |
401 | Ошибка аутентификации (отсутствует/неверна подпись или временная метка) |
403 | Доступ к проекту запрещён или IP не в белом списке |
404 | Инвойс не найден |
422 | Ошибка бизнес-валидации |
500 | Непредвиденная ошибка платформы |
503 | Сервис временно недоступен |