Skip to content

Получение списка транзакций по карте

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

URL

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

Описание

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

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

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

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

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

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

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

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

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

Тело запроса

{
  "page": integer,
  "per_page": integer
}

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

Параметр Тип Описание Обязательный Шифрование
page integer Номер получаемой страницы (по умолчанию = 1) Да Да
per_page integer Количество записей на странице (по умолчанию = 100) Да Да
idCard uuid Идентификатор карты в сервисе СУП Да Да

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

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

{
  "data": [
    {
      "id": 1,
      "dateExecutionAt": "20.04.2023",
      "timeExecutionAt": "16:00",
      "type": "Траты",
      "amount": 200,
      "place": "MY COFFEE",
      "mcc": "1234",
      "merchantId": "MERCHANT"
    }
  ],
  "meta": {
    "current_page": 0,
    "from": 0,
    "to": 0,
    "total": 0,
    "last_page": 0,
    "per_page": 15,
    "path": "string"
  }
}

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

Параметр Тип Описание
data list Список транзакций по карте
id integer Идентификатор транзакции
dateExecutionAt string Дата транзакции. Формат «ДД.ММ.ГГГГ».
timeExecutionAt string Время транзакции. Формат «ЧЧ:ММ».
type string Тип транзакции
amount integer Сумма транзакции в копейках
place string Для трат: место или торговая точка. Наименование мерчанта.
mcc string МСС код.
merchantId string Идентификатор мерчанта.
meta dict Словарь, содержащий метаданные страницы
current_page integer Номер текущей страницы
from integer Номер записи, с которой начинается список
to integer Номер записи, на которой заканчивается список
per_page integer Количество записей на странице
last_page integer Номер последней страница
path string Путь

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

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

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

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

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

{
  "message": "string"
}

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

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

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

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