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

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

POST/v2/mia/test-pay

Симуляция платежа разрешена исключительно в среде sandbox (тестирование). Этот endpoint позволяет тестировать процесс оплаты, отправляя payload с деталями платежа.


Запрос (Request)

Метод: POST

URL: /v2/mia/test-pay


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

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

qrId

string (guid)

Да

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

amount

number (decimal)

Да

Сумма платежа

iban

string(100)

Да

IBAN плательщика

currency

string (enum)

Да

Валюта платежа (возможные значения: MDL)

payerName

string(200)

Да

Сокращённое имя плательщика

Request example

{
  "qrId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 10,
  "iban": "MD88AG000000011621810140",
  "currency": "MDL",
  "payerName": "John D."
}

Параметры ответа (Response parameters)

result

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


Поля объекта result

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

qrId

string(guid)

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

qrStatus

string(enum)

Статус QR-кода. Возможные значения: Active, Inactive, Expired, Paid, Cancelled.

Active – Статус активного QR-кода.

Inactive – Статус Статического или Гибридного QR, если в течение последних 30 дней не было оплаты.

Expired – Статус Динамического или Гибридного QR, если срок действия истек и не было оплаты.

Paid – Статус Динамического или Гибридного QR после успешной оплаты.

Cancelled – Статус после запроса на отмену (POST /v2/mia/qr/{qrId}/cancel).

orderId

string(100)

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

payId

string(guid)

Уникальный идентификатор платежа.

amount

number(decimal)

Сумма платежа.

commission

number(decimal)

Комиссия, взимаемая за платёж.

currency

string(enum)

Валюта, в которой был совершен платёж. Возможные значения MDL. Формат: ISO 4217.

payerName

string(200)

Сокращённое имя плательщика.

payerIban

string(100)

IBAN плательщика (Международный номер банковского счёта).

executedAt

string(datetime)

Дата и время выполнения платежа. Формат: ISO 8601-1:2019.

signature

string

Подпись для валидации уведомления.


Другие поля ответа

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

ok

boolean

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

errors

array

Список ошибок, возникших при обработке запроса.

Объекты в errors

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

errorCode

string

Код ошибки – уникальный код возникшей ошибки.

errorMessage

string

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

Response example

{
  "result": {
    "qrId": "123e4567-e89b-12d3-a456-426614174000",
    "qrStatus": "Active",
    "orderId": "123",
    "payId": "6d24e4a5-c6bf-4d3e-bf7a-8d2123faf4e9",
    "amount": 10,
    "commission": 2.50,
    "currency": "MDL",
    "payerName": "John D.",
    "payerIban": "MD88AG000000011621810140",
    "executedAt": "2024-11-29T10:56:52.1380956+00:00",
    "signature": "592b6999-fdd0-4fd3-9708-5cb9df590dee"
  },
  "ok": true
}

Примечания

  • Этот endpoint доступен только в среде sandbox для тестирования.

  • Если ok имеет значение false, поле errors будет содержать подробности об ошибках.

  • Значение qrStatus отражает текущее состояние QR-кода после симуляции платежа.

  • Проверку подписи из поля result.signature необходимо выполнять в соответствии с алгоритмом, описанным в документации по уведомлениям (callback).

PreviousПолучение информации о платеже по IDNextУведомления по Callback URL

Last updated 2 days ago