Получение информации об ордерах#

Получение ордера по ID#

Запрос#

URL: GET https://<host>/api/v3/merchant/orders/{id}

{id} - UUID ордера

Заголовки:

Content-Type: application/json
Authorization: Bearer <YOUR-API-KEY>. См. страницу "Авторизация запросов"

Пример cURL#

curl -X 'GET' 'https://<host>/api/v3/merchant/orders/46d9ff65-505d-4148-8172-6b8c0a09ded8' \
-H 'Authorization: Bearer <YOUR-API-KEY>'

Ответ#

HTTP Status Code: 200

Тело ответа - модель ордера OrderOut (см. "Общая информация"):

{
  "id": "46d9ff65-505d-4148-8172-6b8c0a09ded8",
  "createdAt": "2026-08-31T06:37:45.776331Z",
  "updatedAt": "2026-08-31T06:38:23.596007Z",
  "type": "PayOut",
  "direction": "PayOut",
  "status": "payment_in_progress",
  "merchantOrderID": null,
  "clientID": null,
  "methodID": 5,
  "currencyCode": "KRW",
  "amount": 10,
  "merchantCommission": 1,
  "amountUSDT": 5.617978,
  "merchantCommissionUSDT": 0.561798,
  "exchangeRate": 1600.1636,
  "trafficType": "mixed"
}

Ордер не найден - 404.

Получение списка ордеров#

Запрос#

URL: GET https://<host>/api/v3/merchant/orders

Заголовки:

Content-Type: application/json
Authorization: Bearer <YOUR-API-KEY>. См. страницу "Авторизация запросов"

Query-параметры (все необязательные):

Параметр	Тип	Описание
`status`	string	Статусы ордеров. Можно передать несколько раз
`type`	string	Типы ордеров. Можно передать несколько раз
`direction`	string	Направления ордеров. Можно передать несколько раз
`currencyCode`	string	ISO 4217 валюты ордера
`amountFrom`	float64	Нижняя граница суммы, включительно
`amountTo`	float64	Верхняя граница суммы, включительно
`methodID`	integer	Метод ордера
`orderID`	string	UUID ордера
`merchantOrderID`	string	Идентификатор ордера мерчанта
`clientID`	string	Идентификатор клиента
`createdAtFrom`	string	Начало периода создания, граница включается, RFC 3339
`createdAtTo`	string	Конец периода создания, граница включается, RFC 3339
`limit`	integer	Количество элементов; потолок 10000
`offset`	integer	Смещение выборки

Порядок выдачи - createdAt по убыванию; параметры сортировки не предусмотрены.

Правила фильтрации:

Массивные фильтры (status, type, direction) передаются повтором параметра; объединение значений одного фильтра - ИЛИ, разные фильтры объединяются по И
Границы периодов и сумм включаются

Пример cURL#

curl -X 'GET' \
  'https://<host>/api/v3/merchant/orders?status=succeeded&status=expired&type=PayIn&limit=10&offset=0' \
-H 'Authorization: Bearer <YOUR-API-KEY>'

Ответ#

HTTP Status Code: 200

Список ордеров по фильтрам; total - количество ордеров по фильтрам без учёта пагинации. Элементы items - модель OrderOut (см. "Общая информация"):

{
  "items": [
    {
      "id": "46d9ff65-505d-4148-8172-6b8c0a09ded8",
      "createdAt": "2026-08-31T06:37:45.776331Z",
      "updatedAt": "2026-08-31T06:38:23.596007Z",
      "type": "PayIn",
      "direction": "PayIn",
      "status": "succeeded",
      "merchantOrderID": "TX-1",
      "clientID": "C1",
      "methodID": 9,
      "currencyCode": "KRW",
      "amount": 10,
      "merchantCommission": 1,
      "amountUSDT": 5.617978,
      "merchantCommissionUSDT": 0.561798,
      "exchangeRate": 1600.1636,
      "trafficType": "mixed"
    }
  ],
  "total": 1
}