maib MIA QR API
RU
RU
  • Overview
    • Общие технические характеристики
    • Типы QR MIA
  • Эндпоинты
    • Аутентификация
      • Получение токена аутентификации
    • Инициация платежа
      • Создание QR-кода (статический, динамический)
      • Создание гибридного QR-кода
        • Создание расширения для QR-кода по ID
    • Отмена платежа
      • Отмена активного QR-кода (Статический/Динамический)
      • Отмена активного расширения для гибридного QR-кода
    • Возврат платежа
      • Возврат выполненного платежа
    • Получение информации (GET)
      • Отображение списка QR-кодов с параметрами фильтрации
      • Получение данных по QR по ID
      • Получение списка платежей с возможностью фильтрации
      • Получение информации о платеже по ID
  • Симуляция платежа (Sandbox)
  • Уведомления по Callback URL
  • Ошибки (Errors)
    • Ошибки API
    • Коды состояния HTTP
  • Терминология
  • maib e-commerce API
Powered by GitBook
On this page
  1. Эндпоинты
  2. Инициация платежа

Создание QR-кода (статический, динамический)

POST /v2/mia/qr

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

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

Поле
Тип
Обязательно
Описание

type

string(enum)

Да

Тип QR-кода. Возможные значения: Static, Dynamic.

  • Static: QR-код, который можно использовать многократно (например, стикер).

  • Dynamic: QR-код, предназначенный для одноразового использования (например, POS-терминал).

expiresAt

string(datetime)

Да, только для Dynamic

Дата истечения срока действия для QR-кода типа Dynamic.

  • Минимальное значение: 1 минута

  • Максимальное значение: 60 дней

  • Формат: ISO 8601-1:2019 (например, "2029-10-22T10:32:28+03:00")

Не используется для QR-кодов типа Static.

amountType

string(enum)

Да

Тип суммы. Возможные значения:

  • Fixed – фиксированная сумма (используется amount)

  • Controlled – переменная сумма с лимитами (amountMin и amountMax)

  • Free – доступно только для QR-кодов типа Static, сумма не задана (клиент вводит сумму в банковском приложении)

amount

number(decimal)

Да, для Fixed и Controlled

Сумма оплаты. Должна соответствовать условию: amountMin ≤ amount ≤ amountMax.

  • Минимум: > 0

  • Максимум: 100000

Не указывается для типа суммы Free.

amountMin

number(decimal)

Да, для Controlled

Минимально допустимая сумма.

  • Минимум: > 0

  • Максимум: меньше amountMax

Не указывается для типов суммы Free или Fixed.

amountMax

number(decimal)

Да, для Controlled

Максимально допустимая сумма.

  • Минимум: больше amountMin

  • Максимум: 100000

Не указывается для типов суммы Free или Fixed.

currency

string(enum)

Да

Валюта, в которой производится оплата. Допустимое значение: MDL (в соответствии с ISO 4217).

description

string(500)

Да

Описание заказа.

orderId

string(100)

Нет

Идентификатор заказа на стороне продавца.

callbackUrl

string(1000)

Нет

URL-адрес, на который продавцу будут отправлены данные после успешной оплаты. Формат: HTTPS URL.

redirectUrl

string(1000)

Нет

URL-адрес, на который будет перенаправлен клиент после успешной оплаты. Формат: HTTPS URL.

terminalId

string(100)

Нет

Идентификатор терминала, предоставленный банком.

Request example

{
    "type": "Dynamic",
    "expiresAt": "2029-10-22T10:32:28+03:00",
    "amountType": "Fixed",
    "amount": 50.00,
    "currency": "MDL",
    "description": "Order description",
    "orderId": "123",
    "callbackUrl": "https://example.com/callback",
    "redirectUrl": "https://example.com/success",
    "terminalId": "P011111"
}

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

Поле
Тип
Описание

result.qrId

string(guid)

Уникальный идентификатор QR-кода

result.extensionId

string(guid)

Идентификатор расширения QR

result.orderId

string(100)

Идентификатор заказа от продавца

result.type

string(enum)

Тип возвращаемого QR. Возможные значения: Static, Dynamic, Hybrid.

result.url

string(1000)

Сгенерированная QR-ссылка. Формат: HTTPS URL

result.expiresAt

string(datetime)

Дата истечения срока действия QR-кода (для Dynamic или Hybrid). Формат: ISO 8601-1:2019

ok

boolean

Статус запроса. true – без ошибок, false – с ошибками.

errors

array

Список ошибок (если ok = false).

errors.errorCode

string

Код ошибки

errors.errorMessage

string

Сообщение об ошибке

Response example

{
    "result": {
        "qrId": "123e4567-e89b-12d3-a456-426614174000",
        "extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
        "orderId": "123",
        "type": "Dynamic",
        "url": "https://example.com/qr/123e4567-e89b-12d3-a456-426614174000",
        "expiresAt": "2029-10-22T10:32:28+03:00"
    },
    "ok": true
}
PreviousИнициация платежаNextСоздание гибридного QR-кода

Last updated 2 days ago