Cтатус запроса пополнения карты
Метод служит для уточнения статуса запроса на пополнение карт.
URL
GET https://rest.lksup.ru/v1/replenishment/status/?idReplenishment="uuid"
Описание
Метод возвращает результат получения запроса на пополнения карт.
Для выполнения запроса необходимо предоставить:
- Авторизационные данные — JWT access токен.
- Данные о запросе на пополнение карт — идентификатор запроса на пополнение карт.
- X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно. Подробнее ознакомиться с информацией о шифровании можно по ссылке
Структура запроса
Пример запроса
Формат запроса:
GET https://rest.lksup.ru/v1/replenishment/status/?idReplenishment=uuid
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
replenishmentId |
uuid | Уникальный идентификатор запроса на пополнение | Да | Да |
Структура ответа
Пример успешного ответа - код 200
{
"message": "string",
"replenishmentId": "uuid"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
message |
string | Описание статуса запроса на пополнение |
Возможные значения параметра message
| Значение | Описание |
|---|---|
| NEW | Заявка создана и ожидает обработку |
| IN_PROCESS | Заявка в обработке |
| SUCCESS | Запрос полностью успешно обработан |
| PART_SUCCESS | Запрос обработан частично (есть измененные и не изменённые карты) |
| DECLINE | Запрос отклонен. Ни у одной карты не изменены настройки |
| REJECTED | Запрос отменен партнёром |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"success": false,
"data": [{
"field":"string",
"message":"string"
},
{
"field":"string",
"message":"string"
}]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"message": "string"
}
Параметры ответа с ошибкой
| Параметр | Тип | Описание |
|---|---|---|
field |
string | Наименование поля, в котором была допущена ошибка |
message |
string | Текстовое описание ошибки |
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Токен не прошел валидацию |
| 404 | Запрос на пополнение с таким replenishmentId не найден. |
| 422 | Передано некорректное значение |