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
  • Request Body Parameters
  • Request Body Example
  • Response Parameters
  • Response Example
  1. Эндпоинты
  2. Инициация платежа

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

POST /v2/mia/qr/hybrid Гибридный QR-код, который может быть оплачен несколько раз, с возможностью последующего изменения суммы и даты истечения срока действия (через endpoint POST /v2/mia/qr/{qrId}/extension). Может размещаться на статических носителях, таких как стикеры.


Request Body Parameters

Параметр
Тип
Обязательный
Описание

amountType

string (enum)

Да

Тип суммы в QR-коде. Возможные значения: Fixed, Controlled, Free.

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

Controlled: изменяемая сумма в пределах amountMin и amountMax.

Free: только для статических QR-кодов, без заранее заданной суммы (клиент указывает сумму в банковском приложении).

currency

string (enum)

Да

Валюта платежа. Допустимые значения: MDL. Формат: ISO 4217.

terminalId

string (max 100)

Нет

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

extension

object

Нет

Объект, содержащий расширения для QR-кода.


extension Object Parameters

Параметр
Тип
Обязательно при определённых условияхt
Описание

expiresAt

string (datetime)

Да

Дата окончания действия гибридного QR-кода (минимум 1 минута, максимум 60 дней). Код истекает, если платеж не был произведён в течение последних 30 дней. Формат: ISO 8601. Пример: "2029-10-22T10:32:28+03:00".

amount

number (decimal)

Да, для Fixed и Controlled

Сумма QR-кода. Для типов Fixed и Controlled должно выполняться условие: amountMin ≤ amount ≤ amountMax. Значения от 0 до 100000. Не используется для типа Free.

amountMin

number (decimal)

Да, для Controlled

Минимально допустимая сумма (для Controlled). Должна быть > 0 и меньше amountMax. Не используется для типов Free и Fixed.

amountMax

number (decimal)

Да, для Controlled

Максимально допустимая сумма (для Controlled). Должна быть > amountMin и ≤ 100000. Не используется для типов Free и Fixed.

description

string (max 500)

Да

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

orderId

string (max 100)

Нет

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

callbackUrl

string (max 1000)

Нет

HTTPS URL, по которому торговец получает данные о успешной оплате в банковском приложении.

redirectUrl

string (max 1000)

Нет

HTTPS URL, на который клиент будет перенаправлен после успешной оплаты (полезно для интеграции с сайтом).

Request Body Example

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

Response Parameters

Параметр
Тип
Описание

result

object

Объект, содержащий результат запроса.

result.qrId

string (guid)

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

result.extensionId

string (guid)

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

result.url

string (max 1000)

Ссылка на QR-код. Формат HTTPS.

ok

boolean

Статус обработки запроса: true – без ошибок, false – ошибка (подробности в errors).

errors

array

Список ошибок обработки (если имеются).


errors Object (если ok = false)

Параметр
Тип
Описание

errorCode

string

Код ошибки.

errorMessage

string

Описание ошибки.


Response Example

{
  "result": {
    "qrId": "123e4567-e89b-12d3-a456-426614174000",
    "extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
    "url": "https://example.com/qr/123e4567-e89b-12d3-a456-426614174000"
  },
  "ok": true
}
PreviousСоздание QR-кода (статический, динамический)NextСоздание расширения для QR-кода по ID

Last updated 2 days ago