Получение баланса карты и счета

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

URL

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

Описание

Метод возвращает информацию о балансе карты и счета.

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

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

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

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

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

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

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

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

{
  "idCard": "cb8adc13-75b5-4cf0-84da-c6f1ecf239ea",
  "balanceAccount": {
      "updateAt": "21.01.2025 06:01",
      "value": 100
  },
  "balance": 0,
  "canToUp": 1500000
}

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

Параметр	Тип	Описание
`idCard`	uuid	Идентификатор карты в сервисе СУП.
`balanceAccount`	dict	Информация о счете и её обновлении.
`updatedAt`	string	Дата обновления баланса. Формат: "ДД.ММ.ГГГГ ЧЧ:ММ". Данные обновляются один раз в сутки.
`value`	integer	Баланс счета в копейках.
`balance`	integer	Баланс карты в копейках.
`canToUp`	integer	Сумма в копейках, на которую можно пополнить.

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

{
  "success": false,
  "message": "string"
}

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

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

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

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

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

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