Список запросов на пополнение карт
Метод для получения списка запросов на пополнение карт.
URL
GET https://rest.lksup.ru/v1/replenishments
Описание
Метод возвращает список всех пополнений.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о странице — Данные для получения определенного списка пополнений.
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о пагинации. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Пример запроса:
Формат запроса:
GET https://rest.lksup.ru/v1/replenishments
Тело запроса:
{
"page": integer,
"per_page": integer
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
page |
integer | Номер получаемой страницы (значение по умолчанию = 1) | Нет | Да |
per_page |
integer | Количество записей на странице (значение по умолчанию = 15) | Нет | Да |
Структура ответа
Пример успешного ответа - код 200
{
"data": [
{"replenishmentId": 0bb866fd-d323-4219-871b-5a16480bcfee,
"status": "NEW"}
]
"meta": {
"current_page": 1,
"from": 1,
"to": 65,
"total": 65,
"per_page":100,
"last_page": 1,
"path": "https://rest.lksup.ru/v1/replenishments",
}
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
replenishmentId |
uuid | |
| Идентификатор запроса пополнения карт | ||
status |
string | Cтатус запроса на пополнение карт |
Статусы карт:
| Параметр | Описание |
|---|---|
| NEW | Запрос создан и ожидает обработку |
| IN_PROCESS | Запрос принят в обработку |
| SUCCESS | Запрос полностью успешно обработан |
| PART_SUCCESS | Запрос обработан частично (есть измененные и не изменённые карты) |
| DECLINE | Запрос отклонен. Ни у одной карты не изменены настройки |
| REJECTED | Запрос отменен партнёром |
| --- |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов. Пример ответа для кода состояния 422
{
"data":[
{"field": "string",
"message": "string"}
]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"success": false;
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 422 | Передано некорректное значение |