Перейти к содержанию

Получение данных по операции. Метод OperationInfo.

Параметры запроса.

Название Тип Обязательность Значение Пример
ap_request String Да Константа OperationInfo OperationInfo
ap_storeid String(1..30) Да Идентификатор точки обслуживания. 43434
ap_order_num Int64 Да Номер заказа. 123
ap_client_dt Int64 |DateTime Нет Дата и время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. 1466602065
ap_proto_ver String(5..10) Да Версия протокола. 1.3.0
ap_lang String(2..2) Нет Язык пользовательского интерфейса. Принимает значения ISO 639-1. Если выбранный язык не поддерживается, то используется русский. ru|by|en|pl
ap_test Boolean Нет Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза. При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). 1|0
ap_service_id UID Да Уникальный идентификатор операции 7a29-724a-f26e-9a78-4b4c-f7a7-9da5-7b72
ap_signature String (32…512) Да Хеш-Подпись. ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579

Поля ответа.

Название Тип Обязательность Значение Пример
ap_storeid String(1..30) Да Идентификатор точки обслуживания. 43434
ap_order_num Int64 Да Номер заказа. Для ответа регистрации операции, в случае нулевого значения данного параметра система генерирует номер заказа для точки обслуживания, во всех других случаях значение номера заказа берется из запроса. 123
ap_server_dt Int32 | DateTime Да Дата и время: UNIX-время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. 1466602065
ap_status Enum Да Статус выполнения операции. Принимает значения:
  • Success – выполнено успешно;
  • Warning –выполнено с замечаниями;
  • Error – ошибка выполнения операции;
  • Malfunction – ошибка выполнения операции, сбой системы (информирует, что система перегружена и следует повторить операцию позже).
 Success | Warning | Error | Malfunction
ap_result_code Int32 Нет Целочисленный код выполнения операции. Значения:
«0» - выполнено успешно;
«1..99» - выполнено с замечаниями;
иначе – ошибка операции.		 0
ap_result_text String Нет Описание результата выполнения операции. Выполнено успешно
ap_operation Enum Да Тип операции Sale
ap_oper_detail_state Enum Да Детальное состояние обработки операции на сервере. Принимает значения:
  • Preparation – в процессе подготовки, запрос на хост еще не отправлен;
  • InProgress – в процессе выполнения (exec получен, проходит обмен с хостом);
  • Successful – выполнено успешно (exec);
  • Canceled – отменено (can)
  • CancelProcessing – отмена в процессе выполнения (can незавершен);
  • Timeouted – истекло время сессии;
  • Failed – сбой при проведении операции.
 Successful
ap_test Boolean Нет Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза. При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). 1|0
ap_service_id UID Нет Уникальный идентификатор операции. 7a29-724a-f26e-9a78-4b4c-f7a7-9da5-7b72
ap_signature String (32…512) Да Хеш-Подпись. ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579

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

{
    "ap_request":"OperationInfo",
    "ap_order_num":"566833",
    "ap_storeid":"600023",
    "ap_client_dt":"2025-01-31T12:48:12+00:00",
    "ap_service_id":"a233-c47b-222d-8629-e04b-c82e-a714-7ea6",
    "ap_test":1,
    "ap_signature":"886204db9788a6ea85b2176cbbb150e96c0aad318a19821e535ba5bce1b5389e9edfb6d0a5f0b0b4954cc487ffc8e9339ba4b2b4a8b24e28257aca3a63509102"
}

Пример ответа.

{
    "ap_storeid":"600023",
    "ap_order_num":566833,
    "ap_operation":"Sale",
    "ap_oper_detail_state":"Preparation",
    "ap_status":"Success",
    "ap_result_code":0,
    "ap_result_text":"Выполнено успешно",
    "ap_server_dt":"2025-01-31T15:50:31+03:00",
    "ap_test":1,
    "ap_service_id":"a233-c47b-222d-8629-e04b-c82e-a714-7ea6",
    "ap_signature":"25b02cc90020fd67994625599f875d8c9ed469029d4be9c465ccc86c4ab7514a8c31a6ec3649b5f683c1e71b1830b0d989db39266e12a8a7e3560abd381e85d9"
}