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
  • Статусы QR
  • Важные параметры
  • Коды состояния HTTP
  • Структура ответа

Терминология

QR MIA – система maib для генерации, управления и обработки платежей по QR-кодам (статическим, динамическим, гибридным), предназначенная для продавцов, желающих быстро принимать платежи без перенаправлений.

QR-код – код, сгенерированный через API QR MIA, содержащий всю необходимую информацию для инициации платежа. Может быть Статическим, Динамическим или Гибридным в зависимости от контекста и цели.

Статический QR – QR-код, содержащий только фиксированные данные, без суммы или персонализированных деталей. Используется для повторяющихся платежей без фиксированной стоимости (например, пожертвования).

Динамический QR – QR-код, созданный для конкретной цели, однократного использования, содержит детальную информацию о транзакции (сумма, клиент и т.д.).

Гибридный QR – комбинация статического и динамического. Подходит как для одноразовых, так и для повторяющихся платежей.

qrId – уникальный идентификатор сгенерированного QR-кода, тип UUID. Используется как ссылка во всех вызовах API.

PayId – уникальный идентификатор платежа, совершенного через QR. Возвращается в ответе на платёж и используется для отслеживания транзакции.

Sandbox – защищённая среда тестирования, в которой можно симулировать платежи без использования реальных средств. Предназначена для тестирования интеграции приложений продавца.

Продакшн (Production) – рабочая среда, в которой проходят реальные транзакции с использованием настоящих средств, для активных продавцов.

Выполнено (executedAt) – момент завершения платежа. Возвращается в формате ISO 8601.


Статусы QR

  • Active (Активен) – QR активен и доступен для оплаты.

  • Inactive (Неактивен) – Статический или гибридный QR, не использовавшийся в течение 30 дней.

  • Expired (Истёк срок) – Динамический или гибридный QR, срок действия которого истёк без использования.

  • Paid (Оплачен) – Платёж по данному QR успешно выполнен.

  • Cancelled (Отменён) – QR был отменён через специальный endpoint /cancel.


Важные параметры

  • iban – IBAN счёт плательщика, используется для его идентификации в рамках транзакции.

  • payerName – Сокращённое имя плательщика, необходимо для идентификации и отслеживания.

  • currency – Валюта, в которой совершается платёж. В настоящее время поддерживается только MDL.

  • amount – Сумма транзакции. Указывается как десятичное число.


Код
Значение
Описание

200

OK

Запрос был успешно обработан.

400

Bad Request

Параметры, переданные в запросе, недействительны или отсутствуют. Проверьте формат и обязательные поля.

401

Unauthorized

Токен аутентификации отсутствует, просрочен или неверен.

403

Forbidden

Доступ к ресурсу запрещён. Возможны ограничения по IP или правам доступа.

404

Not Found

Запрашиваемый ресурс не найден (например, несуществующий qrId).

500

Internal Server Error

Произошла внутренняя ошибка сервера. Повторите попытку позже или свяжитесь с командой поддержки.


Структура ответа

  • ok – указывает, была ли операция успешно обработана (true) или произошла ошибка (false).

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

    • errors.errorCode – уникальный код ошибки (например, ERR_QR_NOT_FOUND).

    • errors.errorMessage – подробное описание возникшей проблемы.

PreviousКоды состояния HTTP

Last updated 2 days ago

Коды состояния HTTP