Skip to content

Запрос на пополнение

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


URL

POST https://rest.lksup.ru/v1/replenishment

Описание

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

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

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


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

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

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

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

POST https://rest.lksup.ru/v1/replenishment


Тело запроса

{
  "cards": [
            {
              "idCard": "e2afe7f0-ccb4-467f-8b10-3de68e7f63b1",
              "amountReplenishment": 100
            },
            {
              "idCard": "61f6aa18-da5f-4351-a64d-1ee8d0a57a93",
              "amountReplenishment": 100
            }]
}

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

Параметр Тип Описание Обязательный Шифрование
cards list Список карт для пополнения Да Да
idCard uuid Уникальный идентификатор карты в сервисе СУП Да Да
amountReplenishment integer Сумма пополнения карты в копейках Да Да

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

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

{
  "message": "Запрос ожидает исполнения",
  "replenishmentId": "09f64c3a-c14e-414f-baec-0c4ba6adedd4"
}

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

Параметр Тип Описание
replenishmentId uuid Идентификатор запроса на пополнение карт

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

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

```

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

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

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

Статус Описание
401 Не авторизован. Токен не прошел валидацию
404 Карта idCard не найдена
409 Карты idCard присутствуют в обрабатываемом запросе replenishmentId. Дождитесь его проведения и повторите операцию
409 Карты [idCard,...] не являются основными. Измените их статус и повторите запрос
409 У [idCard,...] истек срок действия карты
422 Передано некорректное значение