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

Создание платежа. Метод Register.

Параметры инициализации платежа.

Название Тип Обязательность Значение Пример
ap_request String(1..30) Да Константа Register Register
ap_storeid String(1..30) Да Идентификатор точки обслуживания. 43434
ap_operation String(1..30) Да Тип операции. Принимает следующие значения:
  • «Sale» – оплата товаров/услуг;
  • «Preauth» – преавторизация суммы, резервирование определенной суммы средств на счете клиента, окончательное списание средств со счета производится по факту предоставления товара или услуг клиенту;
  • «Reversal» – отмена операции оплата (только в текущем дне) или преавторизации (в любом дне), данная операция доступна только из личного кабинета данной точки обслуживания;
  • «Refund» – возврат средств на счет клиента, если дата выполнения операции «Sale» или «Completeauth» отличается от текущей, данная операция доступна только из личного кабинета данной точки обслуживания.
Для типов операций «Reversal» и «Refund» в поле «ap_order_num» помещается номер отменяемой операции оплата или авторизация		 Sale
ap_order_num Int64 Да Номер заказа. 123
ap_client_dt Int32 | DateTime Нет Дата и время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. 1466602065
ap_amount Double Да Сумма платежа. 12.10
ap_currency String(3..3) Да Цифровой трехсимвольный код валюты либо его буквенное обозначение согласно ISO4271. BYN|USD|EUR|RUB
ap_invoice_desc String (max 2500) Да Краткое описание приобретаемых товаров или оказываемых услуг. Холодильник
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
up_... String (1..1024) Нет Набор пользовательских параметров. Разрешается добавлять до 16 пользовательских параметров с любыми именами, начинающимися с префикса "up_" (например, "up_any_param"). Данные параметры не обрабатываются и не учитываются в платежной системе при оплате, но передаются предприятию (точке обслуживания) после успешного выполнения операции в уведомлении. Пользовательские параметры учитываются при расчете хеш-подписи. up_any_param=success
ap_signature String (32…512) Да Хеш-Подпись. ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579

Поля ответа.

Название Тип Обязательность Значение Пример
ap_storeid String(1..30) Да Идентификатор точки обслуживания. 43434
ap_order_num Int64 Да Номер заказа. Для ответа регистрации операции, в случае нулевого значения данного параметра система генерирует номер заказа для точки обслуживания, во всех других случаях значение номера заказа берется из запроса. 123
ap_server_dt Int32 | DateTime Да Дата и время. 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_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":"Register",
    "ap_storeid":"600023",
    "ap_operation":"Sale",
    "ap_order_num":"566833",
    "ap_client_dt":"2025-01-31T12:47:40+00:00",
    "ap_amount":"10.01",
    "ap_currency":"BYN",
    "ap_invoice_desc":"Тестовый платеж",
    "ap_proto_ver":"1.3.0",
    "ap_lang":"ru",
    "ap_test":1,
    "ap_signature":"99a38fba8cdda3b651a6b05af86ae3b528f75745bd0d4f11884e3c5bf0b5ba4d59181fd7229d4dea41bf84694a55e6092edebb3bf583a4cc12254c9acf7a0987"
}

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

{
    "ap_storeid":"600023",
    "ap_store_desc":"Shop test",
    "ap_order_num":566833,
    "ap_status":"Success",
    "ap_result_code":0,
    "ap_result_text":"Выполнено успешно",
    "ap_server_dt":"2025-01-31T15:48:13+03:00",
    "ap_test":1,
    "ap_service_id":"a233-c47b-222d-8629-e04b-c82e-a714-7ea6",
    "ap_signature":"f634cff44f6c8cc83538917c1fc09eff3d62d12be14aced625a3d43d9975f3a05b6b01e2c69f454b1c19d2e2d0aa5d616bd69d201e2553671db199a26d356795"
}