Skip to content

Результат запроса пополнения карт

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

URL

GET  https://rest.lksup.ru/v1/replenishment/result/?idReplenishment="uuid"

Описание

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

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

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

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

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

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

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

GET https://rest.lksup.ru/v1/replenishment/status/?idReplenishment=uuid

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

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

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

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

{ 
  "data":[
    {
      "idCard": "3f530615-e013-44b3-a4ed-7726285782a2", 
      "resultReplenishment": true, 
      "amountReplenishment": 1000, 
      "errorReplenishment": "string"
    }]

}

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

Параметр Тип Описание
idCard uuid Идентификатор карты в сервисе СУП
amountReplenishment integer Сумма пополнения в копейках
errorReplenishment string Причина отказа в пополнении. Описание ошибки
resultReplenishment boolean Результат пополнения.
true - карта пополнена.
false - карта не пополнено.

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

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

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

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

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

{
  "message": "string"
}

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

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

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

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