Операции
Получение операции по идентификатору и список операций мерчанта
GET /operation/operation/platform/{idPlatform}
Получение операции по идентификатору, выданному платформой при создании.
Параметры пути
| Параметр | Тип | Описание |
|---|---|---|
idPlatform | UUID | значение поля data.id из ответа на создание операции |
Запрос
Ответ
Финальный статус success
Финальный статус failed
Операция не найдена
При отсутствии операции с указанным идентификатором в пределах мерчанта возвращается код ошибки Not found operation. Операции, принадлежащие другим мерчантам, возвращают тот же ответ.
GET /operation/operation/merhcant/{idTransactionMerchant}
Получение операций по идентификатору операции в системе мерчанта.
Эндпойнт помечен DEPRECATED. Возвращает массив операций (значение idTransactionMerchant не гарантирует уникальности на уровне платформы — допускаются повторные регистрации с одним значением). Удаление эндпойнта запланировано в одном из следующих релизов. Применение в новых интеграциях не рекомендуется.
POST /operation/operation/list
Получение списка операций мерчанта с поддержкой пагинации.
Запрос
Параметры
| Поле | Тип | Описание |
|---|---|---|
skip | integer | количество записей, пропускаемых от начала выборки |
take | integer | количество возвращаемых записей |
Операции возвращаются в порядке убывания значения dateAdded. Верхняя граница take определяется конфигурацией платформы.
Ответ
Постраничный обход
Условие завершения обхода: skip + len(data) >= totalNumberRecords.
Поле totalNumberRecords содержит общее количество операций мерчанта, удовлетворяющих фильтру. Применяется в качестве условия выхода из пагинации.
Описание полей операции
| Поле | Тип | Описание |
|---|---|---|
id | UUID | идентификатор операции на платформе |
idTransactionMerchant | string | идентификатор операции в системе мерчанта |
typeOperation | enum | тип операции, см. Статусы |
status | enum | текущий статус операции |
dateAdded | ISO‑8601 | момент создания операции |
dateUpdated | ISO‑8601 | момент последнего изменения статуса |
currency | enum | валюта операции |
amountInitial | decimal | сумма, полученная в запросе на создание |
amountRandomized | decimal | сумма с учётом рандомизации, если она активирована для мерчанта; при отсутствии рандомизации равна amountInitial |
amount | decimal | итоговая сумма операции в валюте операции |
amountComission | decimal | комиссия платформы в валюте операции |
amountInCurrencyBalance | decimal | сумма операции в валюте баланса мерчанта |
amountComissionInCurrencyBalance | decimal | комиссия в валюте баланса мерчанта |
exchangeRate | decimal | курс пересчёта между валютой операции и валютой баланса |
paymentDetailsData | object | реквизиты платежа; присутствует только для операций типа payIn |
Соотношение полей amount, amountInCurrencyBalance и exchangeRate для различных валютных пар описано в разделе Валюты.
Поле traceID
Поле traceID в ответе содержит уникальный идентификатор запроса. Применяется при обращении в службу поддержки для корреляции записей в журналах сервисов платформы.