Отмена заказа карт
Метод для отмены заказа карт.
URL
POST https://rest.lksup.ru/v1/order/cancel
Описание
Метод отменяет запрос на заказ карт.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Параметры заказа карт - информация о заказе карт(идентификатор).
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о запросе на заказ карт — идентификатор запроса на заказ карт. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Пример запроса:
Формат запроса:
POST https://rest.lksup.ru/v1/order/cancel
Тело запроса:
{
"orderId": "uuid"
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
orderId |
uuid | Идентификатор заказа карт. | Да | Да |
Статусы при которых возможна отмена
| Название статусов |
|---|
| CREATED - для виртуальных карт |
| CREATED - для пластиковых карт IN_PROCESS DOCUMENTS_SENT |
Структура ответа
Пример успешного ответа - код 200
{
"message": "string"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
message |
string | Запрос успешно выполнен |
| --- |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"data":[
{"field": "string",
"message": "string"
}
]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 404 | Заказ не найден |
| 409 | Заказ невозможно отменить |
| 422 | Передано некорректное значение |