Отображение списка QR-кодов с параметрами фильтрации

GET/v2/mia/qr

Этот endpoint позволяет получить список QR-кодов, созданных на платформе MIA, с возможностью применения различных параметров фильтрации, сортировки и пагинации.

---

Параметры запроса (query)

Название	Тип	Обязательно	Описание
count	integer	Да	Количество возвращаемых результатов.
offset	integer	Да	Начальный индекс для набора результатов.
sortBy	string (enum)	Нет	Поле для сортировки. Возможные значения: orderId, type, amountType, status, createdAt, expiresAt. По умолчанию: createdAt.
order	string (enum)	Нет	Порядок сортировки. Возможные значения: asc, desc. По умолчанию: asc.
qrId	string (GUID)	Нет	Фильтрация по идентификатору QR.
extensionId	string (GUID)	Нет	Фильтрация по идентификатору расширения QR.
orderId	string (max. 100)	Нет	Фильтрация по идентификатору заказа со стороны продавца.
type	string (enum)	Нет	Тип QR-кода. Возможные значения: Static, Dynamic, Hybrid.
amountType	string (enum)	Нет	Тип суммы. Возможные значения: Fixed, Controlled, Free.
amountFrom	number (decimal)	Нет	Минимальное значение суммы.
amountTo	number (decimal)	Нет	Максимальное значение суммы.
description	string (max. 500)	Нет	Фильтрация по описанию.
status	string (enum)	Нет	Статус QR-кода. Возможные значения: Active, Inactive, Expired, Paid, Cancelled.
createdAtFrom	string (datetime)	Нет	Дата создания — от. Формат ISO 8601.
createdAtTo	string (datetime)	Нет	Дата создания — до. Формат ISO 8601.
expiresAtFrom	string (datetime)	Нет	Дата истечения срока действия — от. Формат ISO 8601.
expiresAtTo	string (datetime)	Нет	Дата истечения срока действия — до. Формат ISO 8601.
terminalId	string (max. 100)	Нет	Идентификатор терминала, предоставленный банком.

---

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

curl -G "https://api.example.com/v2/mia/qr" \
  -H "Authorization: Bearer {{access_token}}" \
  --data-urlencode "count=10" \
  --data-urlencode "offset=0" \
  --data-urlencode "amountFrom=10.00" \
  --data-urlencode "amountTo=100.00" \
  --data-urlencode "sortBy=createdAt" \
  --data-urlencode "order=desc"

---

Параметры ответа

Объект result

Поле	Тип	Описание
totalCount	integer	Общее количество QR-кодов, найденных по заданным фильтрам.
items	array	Список объектов QR.

Объекты в items

Поле	Тип	Описание
qrId	string (GUID)	Уникальный идентификатор QR-кода.
extensionId	string (GUID)	ID расширения QR.
orderId	string (max. 100)	ID заказа от торговца.
type	string (enum)	Тип QR-кода: Static, Dynamic, Hybrid.
url	string (max. 1000)	URL QR-кода. Формат: HTTPS.
amountType	string (enum)	Тип суммы: Fixed, Controlled, Free.
amount	number (decimal)	Фиксированная сумма (если применимо).
amountMin	number (decimal)	Минимальная сумма (для контролируемых сумм).
amountMax	number (decimal)	Максимальная сумма (для контролируемых сумм).
currency	string (enum)	Валюта. Формат ISO 4217.
description	string (max. 500)	Описание QR-кода.
callbackUrl	string (max. 1000)	URL для callback.
redirectUrl	string (max. 1000)	URL для redirect.
status	string (enum)	Статус QR-кода: Active, Inactive, Expired, Paid, Cancelled.
createdAt	string (datetime)	Дата создания QR-кода. Формат ISO 8601.
updatedAt	string (datetime)	Последнее обновление. Формат ISO 8601.
expiresAt	string (datetime)	Дата истечения срока действия QR-кода. Формат ISO 8601.
terminalId	string (max. 100)	ID банковского терминала.

Другие поля

Поле	Тип	Описание
ok	boolean	true если запрос был успешно обработан.
errors	object	Детали ошибки, если есть.
errors.errorCode	string	Код ошибки.
errors.errorMessage	string	Описание ошибки.

---

Exemplu răspuns

{
  "result": {
    "totalCount": 42,
    "items": [
      {
        "qrId": "123e4567-e89b-12d3-a456-426614174000",
        "extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
        "type": "Dynamic",
        "url": "https://example.com/qr/123e4567-e89b-12d3-a456-426614174000",
        "amountType": "Fixed",
        "amount": 50.00,
        "currency": "MDL",
        "description": "Description",
        "status": "Paid",
        "createdAt": "2024-08-05T10:32:28+03:00",
        "updatedAt": "2024-08-05T10:33:50+03:00",
        "expiresAt": "2024-08-05T10:34:28+03:00",
        "terminalId": "P011111"
      }
    ]
  },
  "ok": true
}