Эндпоинты

Этот раздел предоставляет общее описание функциональностей, доступных через API QR MIA, представляя полный список доступных эндпоинтов. Каждый эндпоинт определяется HTTP-методом, URL-путём и своей основной задачей в процессе создания и управления QR-кодами и связанными платежами. Эндпоинты охватывают операции, такие как аутентификация, генерация QR-кодов (статических, динамических, гибридных), продление или отмена кодов, получение подробностей, список транзакций и моделирование платежей.

API QR MIA предоставляет следующие эндпоинты:

  • Аутентификация

    • Получение токена аутентификации

  • Создание и управление QR-кодами

    • Создание QR-кода

    • Создание гибридного QR-кода

    • Получение деталей QR по ID

    • Отмена активного QR-кода по ID

    • Создание расширения для QR-кода

    • Отмена активного расширения QR-кода

    • Получение списка QR-кодов (с фильтрами)

    • Получение списка расширений QR-кодов (с фильтрами)

  • Управление платежами

    • Получение деталей платежа по ID

    • Получение списка платежей (с фильтрами)

    • Возврат платежа по ID

  • Тестирование

    • Симуляция платежа (тест)

В таблице ниже представлены все доступные эндпоинты:

Метод HTTP
URL
Oписание

POST

/v2/auth/token

Получение токена аутентификации

POST

/v2/mia/qr

Создание QR-кода

POST

/v2/mia/qr/hybrid

Создание гибридного QR-кода

GET

/v2/mia/qr/{qrId}

Получение деталей QR по ID

POST

/v2/mia/qr/{qrId}/cancel

Отмена активного QR-кода по ID

POST

/v2/mia/qr/{qrId}/extension

Создание расширения для QR-кода

POST

/v2/mia/qr/{qrId}/extension/cancel

Отмена активного расширения QR-кода

GET

/v2/mia/qr

Получение списка QR-кодов (с фильтром)

GET

/v2/mia/payments/{payId}

Получение деталей оплаты по ID

GET

/v2/mia/payments

Получение списка платежей (с фильтром)

POST

/v2/mia/payments/{payId}/refund

Возврат платежа по ID

GET

/v2/mia/qr/extension

Получение списка расширений QR

POST

/v2/mia/test-pay

Симуляция платежа в тестовой среде

Last updated