Получение списка выпущенных карт по заказу
Метод для получения списка выпущенных карт по заказу.
URL
GET https://rest.lksup.ru/v1/order/result/{order_id}
Описание
Метод возвращает результат выпущенных карт по заказу.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о запросе заказа карт - идентификатор запроса заказа карт.
Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API. Подробнее ознакомиться с информацией о шифровании можно по ссылке
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о запросе на заказ карт — идентификатор запроса на заказ карт. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Пример запроса
Формат запроса:
GET https://rest.lksup.ru/v1/order/result/{order_id}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
order_id |
uuid | Идентификатор созданного заказа | Да | Да |
Структура ответа
Пример успешного ответа - код 200
Для пластиковых карт:
{
"typeCard": "string",
"data":[
{"customIdCard": "string"}
]
}
Для виртуальных карт:
{
"typeCard": "string",
"data":[
{"customIdCard": "string",
"activationCode": "string",
"amount": integer,
"validityPeriod": "string"}
]
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
typeCard |
string | Тип карты.MP4 - пластиковая карта СУП МИР. MLZ - Виртуальная карта СУП МИР. |
customIdCard |
string | Идентификатор карты в банковской системе. 13 цифр - обозначение для пластиковой карты (EAN). 10 цифр - обозначение для виртуальной карты. |
activationCode |
string | Код для активации виртуальной карты. |
validityPeriod |
string | Дата, до которой действителен код. Формат "ДД.ММ.ГГГГ". |
amount |
integer | Сумма первого пополнения карт в копейках Должна быть в диапазоне от 5000 до 1500000 копеек |
| --- |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"data":[
{"field": "string",
"message": "string"}
]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 404 | Запрос orderId не найден |
| 404 | Запрос orderId отменен |
| 404 | Запрос orderId ещё не обработан |
| 422 | Передано некорректное значение |