Menu — Документация

Операции

Получение операции по идентификатору и список операций мерчанта

GET /operation/operation/platform/{idPlatform}

Получение операции по идентификатору, выданному платформой при создании.

Параметры пути

ПараметрТипОписание
idPlatformUUIDзначение поля data.id из ответа на создание операции

Запрос

curl https://api.menu.casino/operation/operation/platform/d7b8e0f4-1b3a-4a3f-8d29-9c7c0a4d0a01 \
  -H "Authorization: Bearer $MENU_API_TOKEN"

Ответ

Финальный статус success

{
  "status": "Success",
  "data": {
    "id": "d7b8e0f4-1b3a-4a3f-8d29-9c7c0a4d0a01",
    "dateAdded": "2026-05-16T12:00:01.123Z",
    "dateUpdated": "2026-05-16T12:00:42.567Z",
    "typeOperation": "payIn",
    "status": "success",
    "idTransactionMerchant": "order-42",
    "amountInitial": 1500,
    "amountRandomized": 1500.13,
    "amount": 1500.13,
    "amountComission": 30,
    "currency": "RUB",
    "amountInCurrencyBalance": 14.95,
    "amountComissionInCurrencyBalance": 0.30,
    "exchangeRate": 100.30,
    "paymentDetailsData": {
      "paymentMethod": "sbp",
      "bankName": "Банк-эквайер",
      "nameMediator": "И. И.",
      "number": "+79991234567",
      "numberAdditional": null,
      "qRcode": null
    }
  },
  "traceID": "8b3e1f6e-7d28-46c0-9c8a-2f6b4d1d4f02"
}

Финальный статус failed

{
  "status": "Success",
  "data": {
    "id": "0a4f7e91-6c12-4f30-9b88-1cd2e4f5a012",
    "dateAdded": "2026-05-16T12:00:01.123Z",
    "dateUpdated": "2026-05-16T12:08:14.901Z",
    "typeOperation": "payIn",
    "status": "failed",
    "idTransactionMerchant": "order-43",
    "amountInitial": 1500,
    "amountRandomized": 1500,
    "amount": 1500,
    "amountComission": 0,
    "currency": "RUB",
    "amountInCurrencyBalance": 0,
    "amountComissionInCurrencyBalance": 0,
    "exchangeRate": 0,
    "paymentDetailsData": {
      "paymentMethod": "sbp",
      "bankName": "Банк-эквайер",
      "nameMediator": "И. И.",
      "number": "+79991234567",
      "numberAdditional": null,
      "qRcode": null
    }
  },
  "traceID": "44ec3a87-1d92-49c8-9a31-7f6e3c0a8b2d"
}

Операция не найдена

{
  "status": "Warning",
  "data": null,
  "codeError": "invalidRequestParameters",
  "message": "Not found operation by idPlatform=d7b8e0f4-1b3a-4a3f-8d29-9c7c0a4d0a01",
  "traceID": "f0a1b2c3-4d5e-6789-abcd-ef0123456789"
}

При отсутствии операции с указанным идентификатором в пределах мерчанта возвращается код ошибки Not found operation. Операции, принадлежащие другим мерчантам, возвращают тот же ответ.

GET /operation/operation/merhcant/{idTransactionMerchant}

Получение операций по идентификатору операции в системе мерчанта.

Эндпойнт помечен DEPRECATED. Возвращает массив операций (значение idTransactionMerchant не гарантирует уникальности на уровне платформы — допускаются повторные регистрации с одним значением). Удаление эндпойнта запланировано в одном из следующих релизов. Применение в новых интеграциях не рекомендуется.

POST /operation/operation/list

Получение списка операций мерчанта с поддержкой пагинации.

Запрос

curl -X POST https://api.menu.casino/operation/operation/list \
  -H "Authorization: Bearer $MENU_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "skip": 0, "take": 50 }'

Параметры

ПолеТипОписание
skipintegerколичество записей, пропускаемых от начала выборки
takeintegerколичество возвращаемых записей

Операции возвращаются в порядке убывания значения dateAdded. Верхняя граница take определяется конфигурацией платформы.

Ответ

{
  "status": "Success",
  "data": [
    {
      "id": "d7b8e0f4-1b3a-4a3f-8d29-9c7c0a4d0a01",
      "dateAdded": "2026-05-16T12:00:01.123Z",
      "dateUpdated": "2026-05-16T12:00:42.567Z",
      "typeOperation": "payIn",
      "status": "success",
      "idTransactionMerchant": "order-42",
      "amountInitial": 1500,
      "amountRandomized": 1500.13,
      "amount": 1500.13,
      "amountComission": 30,
      "currency": "RUB",
      "amountInCurrencyBalance": 14.95,
      "amountComissionInCurrencyBalance": 0.30,
      "exchangeRate": 100.30,
      "paymentDetailsData": {
        "paymentMethod": "sbp",
        "bankName": "Банк-эквайер",
        "nameMediator": "И. И.",
        "number": "+79991234567",
        "numberAdditional": null,
        "qRcode": null
      }
    },
    {
      "id": "8e1f0d24-3a2b-4c8f-9f1c-d3e8a5b9c021",
      "dateAdded": "2026-05-16T11:58:42.220Z",
      "dateUpdated": "2026-05-16T11:59:30.711Z",
      "typeOperation": "payOut",
      "status": "success",
      "idTransactionMerchant": "withdraw-100",
      "amountInitial": 5000,
      "amountRandomized": 5000,
      "amount": 5000,
      "amountComission": 50,
      "currency": "RUB",
      "amountInCurrencyBalance": 49.85,
      "amountComissionInCurrencyBalance": 0.50,
      "exchangeRate": 100.30,
      "paymentDetailsData": null
    }
  ],
  "totalNumberRecords": 12483,
  "traceID": "0c4a1b8e-3f7d-44e2-9b6c-1d5f8a2e7c11"
}

Постраничный обход

# Первая страница
curl -X POST https://api.menu.casino/operation/operation/list \
  -H "Authorization: Bearer $MENU_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "skip": 0, "take": 100 }'
 
# Следующая страница
curl -X POST https://api.menu.casino/operation/operation/list \
  -H "Authorization: Bearer $MENU_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "skip": 100, "take": 100 }'

Условие завершения обхода: skip + len(data) >= totalNumberRecords.

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

Описание полей операции

ПолеТипОписание
idUUIDидентификатор операции на платформе
idTransactionMerchantstringидентификатор операции в системе мерчанта
typeOperationenumтип операции, см. Статусы
statusenumтекущий статус операции
dateAddedISO‑8601момент создания операции
dateUpdatedISO‑8601момент последнего изменения статуса
currencyenumвалюта операции
amountInitialdecimalсумма, полученная в запросе на создание
amountRandomizeddecimalсумма с учётом рандомизации, если она активирована для мерчанта; при отсутствии рандомизации равна amountInitial
amountdecimalитоговая сумма операции в валюте операции
amountComissiondecimalкомиссия платформы в валюте операции
amountInCurrencyBalancedecimalсумма операции в валюте баланса мерчанта
amountComissionInCurrencyBalancedecimalкомиссия в валюте баланса мерчанта
exchangeRatedecimalкурс пересчёта между валютой операции и валютой баланса
paymentDetailsDataobjectреквизиты платежа; присутствует только для операций типа payIn

Соотношение полей amount, amountInCurrencyBalance и exchangeRate для различных валютных пар описано в разделе Валюты.

Поле traceID

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