Получение списка платежей с возможностью фильтрации

GET /v2/mia/payments

Этот endpoint позволяет получить список платежей с использованием фильтров и параметров сортировки для сужения результатов. Возвращаемая информация включает детали по каждому платежу, такие как сумма, комиссия, статус платежа, информация о плательщике и т.д.

---

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

Название	Тип	Обязательный	Описание
count	integer	Да	Количество элементов в результате
offset	integer	Да	Начальная позиция в наборе результатов
sortBy	string (enum)	Нет	Поле для сортировки: orderId, amount, status, executedAt. По умолчанию: executedAt
order	string (enum)	Нет	Порядок сортировки: asc, desc. По умолчанию: asc
payId	string (guid)	Нет	Фильтрация по идентификатору платежа
referenceId	string (15)	Нет	RRN-код мгновенного платежа
qrId	string (guid)	Нет	Фильтрация по ID QR-кода
extensionId	string (guid)	Нет	Фильтрация по ID расширения QR-кода
orderId	string (100)	Нет	Фильтрация по ID заказа от продавца
amountFrom	number (decimal)	Нет	Фильтрация по минимальной сумме (включительно)
amountTo	number (decimal)	Нет	Фильтрация по максимальной сумме (включительно)
description	string (500)	Нет	Фильтрация по описанию
payerName	string (200)	Нет	Фильтрация по имени плательщика
payerIban	string (200)	Нет	Фильтрация по IBAN плательщика
status	string (enum)	Нет	Фильтрация по статусу платежа: Executed, Refunded
executedAtFrom	string (datetime)	Нет	Фильтрация по дате исполнения — от (формат ISO 8601-1:2019)
executedAtTo	string (datetime)	Нет	Фильтрация по дате исполнения — до (формат ISO 8601-1:2019)
terminalId	string (100)	Нет	Фильтрация по ID терминала (выданному банком)

---

Пример запроса

curl -G "https://api.example.com/v2/mia/payments" \
  -H "Authorization: Bearer {{access_token}}" \
  --data-urlencode "count=10" \
  --data-urlencode "offset=0" \
  --data-urlencode "qrId=789e0123-f456-7890-a123-456789012345" \
  --data-urlencode "sortBy=executedAt" \
  --data-urlencode "order=asc"

---

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

Название	Тип	Описание
result.totalCount	integer	Общее количество платежей, соответствующих фильтрам
result.items[]	array	Список объектов платежей
result.items[].payId	string (guid)	Уникальный идентификатор платежа
result.items[].referenceId	string (15)	RRN-код для сервиса мгновенных платежей
result.items[].qrId	string (guid)	Идентификатор QR-кода
result.items[].extensionId	string (guid)	Идентификатор расширения QR-кода
result.items[].orderId	string (100)	Идентификатор заказа от продавца
result.items[].amount	number (decimal)	Сумма платежа
result.items[].commission	number (decimal)	Применённая комиссия
result.items[].currency	string (enum)	Валюта платежа (например, MDL, формат ISO 4217)
result.items[].description	string (500)	Описание заказа/платежа
result.items[].payerName	string (200)	Сокращенное имя плательщика
result.items[].payerIban	string (200)	IBAN плательщика
result.items[].status	string (enum)	Статус платежа: Executed, Refunded
result.items[].executedAt	string (datetime)	Дата и время исполнения (формат ISO 8601-1:2019)
result.items[].refundedAt	string (datetime)	Дата и время возврата (если есть, формат ISO 8601-1:2019)
result.items[].terminalId	string (100)	Идентификатор терминала, выданный банком
ok	boolean	true , если запрос обработан без ошибок
errors[]	array	Список ошибок (если ok = false)
errors[].errorCode	string	Код ошибки
errors[].errorMessage	string	Описание ошибки

---

Example response

{
  "result": {
    "totalCount": 42,
    "items": [
      {
        "payId": "123e4567-e89b-12d3-a456-426614174000",
        "referenceId": "QR000123456789",
        "qrId": "789e0123-f456-7890-a123-456789012345",
        "extensionId": "40e6ba44-7dff-48cc-91ec-386a38318c68",
        "amount": 50.00,
        "commission": 0.50,
        "currency": "MDL",
        "description": "Payment for order #123",
        "payerName": "John D.",
        "payerIban": "MD24AG00225100013104168",
        "status": "Executed",
        "executedAt": "2024-08-05T10:32:28+03:00",
        "terminalId": "P011111"
      },
      {
        "payId": "456e7890-a12b-34cd-5678-9e01f23g4567",
        "referenceId": "QR000123456780",
        "qrId": "789e0123-f456-7890-a123-456789012345",
        "extensionId": "37efb479-c41b-4a39-bd27-ea1aef05134f",
        "amount": 100.00,
        "commission": 1.00,
        "currency": "MDL",
        "description": "Payment for order #1234",
        "payerName": "Jane S.",
        "payerIban": "MD24AG000225100014156789",
        "status": "Refunded",
        "executedAt": "2024-08-04T09:15:00+03:00",
        "refundedAt": "2024-08-05T09:17:05+03:00",
        "terminalId": "P011111"
      }
    ]
  },
  "ok": true
}