Получение данных по QR по ID
Endpoint:
GET /v2/mia/qr/{qrId}
Данный метод позволяет получить информацию о ранее сгенерированном QR-коде, используя его уникальный идентификатор qrId
.
Такой же тип информации может быть получен автоматически через механизм callback.
Параметр запроса (path)
qrId
string (guid)
Уникальный идентификатор QR-кода.
Параметры ответа
result
object
Объект с данными ответа.
result.qrId
string (guid)
Уникальный идентификатор QR-кода.
result.extensionId
string (guid)
Идентификатор расширения QR.
result.orderId
string (100)
Идентификатор заказа со стороны мерчанта.
result.status
string (enum)
Статус QR-кода. Возможные значения: Active
, Inactive
, Expired
, Paid
, Cancelled
.
- Active
– активен.
- Inactive
– статический/гибридный QR без платежей за 30 дней.
- Expired
– срок действия истёк, без оплаты.
- Paid
– оплачен.
- Cancelled
– отменён.
result.type
string (enum)
Тип QR-кода: Static
, Dynamic
, Hybrid
.
result.url
string (1000)
URL QR-кода. Формат: HTTPS URL.
result.amountType
string (enum)
Тип суммы: Fixed
, Controlled
, Free
.
result.amount
number (decimal)
Фиксированная сумма (если указано).
result.amountMin
number (decimal)
Минимальная сумма (для контролируемого типа).
result.amountMax
number (decimal)
Максимальная сумма (для контролируемого типа).
result.currency
string (enum)
Валюта оплаты. Значение: MDL
(ISO 4217).
result.description
string (500)
Описание заказа.
result.callbackUrl
string (1000)
URL обратного вызова для получения уведомления об оплате.
result.redirectUrl
string (1000)
URL для переадресации после оплаты (для веб-интеграции).
result.createdAt
string (datetime)
Время создания QR-кода (ISO 8601-1:2019).
result.updatedAt
string (datetime)
Время последнего обновления статуса.
result.expiresAt
string (datetime)
Срок действия QR (для динамического/гибридного).
result.terminalId
string (100)
Идентификатор терминала, предоставленный банком.
ok
boolean
Статус обработки запроса: true
– успешно, false
– ошибка.
errors
array
Список ошибок, если есть.
errors.errorCode
string
Код ошибки.
errors.errorMessage
string
Описание ошибки.
Пример запроса
curl -G "https://api.example.com/v2/mia/qr/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer {{access_token}}"
Параметры ответа
{
"result": {
"qrId": "123e4567-e89b-12d3-a456-426614174000",
"extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
"status": "Paid",
"type": "Dynamic",
"url": "https://example.com/qr/123e4567-e89b-12d3-a456-426614174000",
"amountType": "Fixed",
"amount": 50.00,
"currency": "MDL",
"description": "Order description",
"callbackUrl": "https://example.com/callback",
"redirectUrl": "https://example.com/success",
"createdAt": "2029-10-22T10:32:28+03:00",
"updatedAt": "2029-10-22T10:32:58+03:00",
"expiresAt": "2029-10-22T10:33:28+03:00",
"terminalId": "P011111"
},
"ok": true
}
Last updated