Skip to content

Получение информации о карте

Метод служит для получения информации о карте.

URL

GET https://rest.lksup.ru/v1/card/{idCard}

Описание

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

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

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

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

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

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

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

GET https://rest.lksup.ru/v1/card/{idCard}

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

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

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

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

{
  "data": {
    "idCard": "1e8b7b10-ab55-45fe-8f5e-131781ea54e8",
    "customCardId": 1234567890123,
    "type": "string",
    "statusCard": "string",
    "dateUntil": "string",
    "balanceAccount": {
      "updateAt": "21.01.2025 06:01",
      "value": 100
    },
    "balance": 0,
    "canToUp": 1500000,
    "limit": {
      "unlimited": true,
      "amount": null,
      "period": null,
      "days": [1, 2, 3, 4, 5],
      "times": [
        {"from": "string",
          "to": "string"          
        }
      ]
    },
    "activated": true,
    "activatedAt": "string",
    "idEmployee": "c8ceb486-bd6d-4de3-9c1c-8627d2aacd97"
  }
}

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

Параметр Тип Описание
idCard uuid Идентификатор карты в сервисе СУП.
idEmployee uuid Идентификатор сотрудника в сервисе СУП, к которому привязана карта.
customCardId integer EAN карты.
type string Тип карты.
statusCard string Статус карты.
dateUntil string Дата до которой действительна карта. Формат: "ДД.ММ.ГГГГ"
balanceAccount dict Информация о счете и её обновлении.
updatedAt string Дата обновления баланса. Формат: "ДД.ММ.ГГГГ ЧЧ:ММ". Данные обновляются один раз в сутки.
value integer Баланс счета в копейках.
balance integer Баланс карты в копейках.
canToUp integer Сумма в копейках, на которую можно пополнить.
limit dict Информация о лимитах, установленных на карту
unlimited boolean true - безлимитная, на карте не установлены лимиты. Можно пользоваться в любое время и любой день, сумма ограничена только балансом карты. Установить true и ввести другие настройки невозможно, возникнет конфликт. false - на карте установлены лимиты, имеет ограничения.
amount integer Сумма в копейках, которая доступна для трат сотруднику, в установленный период.
period string Идентификатор карты в сервисе СУП.
days list Список, содержащий цифровые обозначения дней недели, в которые сотрудник может расплачиваться картой. Если в параметр ничего не передано, то сотрудник может пользоваться картой в любой день.
times list Список временных промежутков, в которые сотрудник может расплачиваться картой.
from string Начало временного промежутка, в который сотрудник может расплачиваться картой.
to string Окончание временного промежутка, в который сотрудник может расплачиваться картой.
activated boolean Признак активации карты. True - активирована, false - не активирована.
activatedAt string Дата активации карты. Формат "ДД.ММ.ГГГГ".
success boolean Статус запроса

Возможные значения параметра type

Наименование Описание
MLZ Виртуальная карта МИР
MP4 Пластиковая карта МИР
P04 Пластиковая карта Visa.
CP4 Пластиковая карта Mastercard.

Возможные значения параметра statusCard

Наименование Описание
MAIN Основная карта
ADDITIONAL Дополнительная
TEMPORARILY_BLOCKED Временно заблокированная.

Возможные значения параметра period

Наименование Описание
CDAY День
CWEEK Неделя
CMONTH Месяц
CQUARTET Квартал

Возможные значения параметра days

Наименование Описание
1 Понедельник
2 Вторник
3 Среда
4 Четверг
5 Пятница
6 Суббота
7 Воскресенье

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

{
  "message": "string"
}

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

{

data[

{"field": "string",

"message": "string"}

]

}

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

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

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

Статус Описание
401 Не авторизован. Токен не прошел валидацию
404 Карта idCard не найдена
422 Переданно некорректное значение