Отмена запроса на пополнение

Метод служит для отмены запроса на пополнение карт.

URL

DELETE https://rest.lksup.ru/v1/replenishment/{replenishmentId}

Описание

Метод возвращает результат отмены запроса на пополнения карт.

Для выполнения запроса необходимо предоставить:
- Авторизационные данные — JWT access токен (передается в заголовке) - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке) - Данные о запросе на пополнение карт — идентификатор запроса на пополнение карт.

Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно. Подробнее ознакомиться с информацией о шифровании можно по ссылке

Структура запроса

В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. replenishmentId - передается в path параметр запроса.

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

Формат запроса:

DELETE https://rest.lksup.ru/v1/replenishment/{replenishmentId}

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

Параметр	Тип	Описание	Обязательный	Шифрование
`replenishmentId`	uuid	Уникальный идентификатор запроса на пополнение	Да	Да

Структура ответа

Пример успешного ответа - код 200

{
  "message": "string"
}

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

Параметр	Тип	Описание
`message`	string	Информация о статусе запроса

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

Ответы с ошибкой могут быть двух видов.

Пример ответа для кода состояния 422

{
  "data": [{
            "field":"string",
            "message":"string"
            },
            {
            "field":"string",
            "message":"string"
            }]
}

Пример ответа для кодов состояния 4хх, за исключением 422

{
  "message": "string"
}

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

Параметр	Тип	Описание
`field`	string	Наименование поля, в котором была допущена ошибка
`message`	string	Текстовое описание ошибки

Возможные ошибки

Статус	Описание
401	Не авторизован. Токен не прошел валидацию
404	Запрос на пополнение с таким replenishmentId не найден.
409	Запрос невозможно отменить
422	Переданные значения не прошли валидацию