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

Типы данных

Базовые поля запроса

Параметр Тип Обязательность Описание
ap_request String Да Тип запроса.
ap_storeid String(1..30) Да Уникальный идентификатор предприятия (точки обслуживания) в системе «Artpay». Может содержать цифры и буквы латинского алфавита.
ap_order_num Int64 Да Номер заказа в точке обслуживания. Для запроса регистрации операции может принимать значение «0», в этом случае номер будет генерироваться системой «Artpay» автоматически. Для всех остальных запросов должен принимать значение отличное от «0».
ap_client_dt DateTime Да Дата и время на клиентском приложении. Сервер должен проверять, что дата и время на клиентском приложении отличается максимум на 12 часов от даты и времени на сервере.
ap_client_type Enum Нет Тип используемого клиентcкого приложения:
  • «srv» – взаимодействие осуществляется между сервером точки обслуживания\агрегатора и сервером «Artpay»;
  • «brw» – интернет-браузер;
  • «apk» – мобильное приложение для Android;
  • «ipa» – мобильное приложение iOS;
  • «pos» – терминал.
ap_client_inf String(1..512) Нет Краткая информация о клиентском приложении. Например, название программы интернет-браузера, для мобильного приложения – название приложения и используемой библиотеки. Также по возможности рекомендуется включить в содержимое данного поля информацию о клиентском устройстве: производитель и модель устройства (для мобильного приложения), наименование и версию операционной системы клиентского приложения. Например:
  • Chrome 49.0.2623.112 (Mac OS X 10.7.2);
  • anyapp/libArtpay (Lenovo P1 Vibe/Android 5.1.1).
ap_client_ver String(1..16) Нет Версия на клиенте (версия мобильного приложения/версия приложения на терминале).
ap_proto_ver String(5..10) Да Версия протокола.
ap_test Boolean Нет В запросе: Уведомляет сервер об использовании тестового режима на клиенте. В случае, если значение параметра установлено в «1», клиент находится в тестовом режиме.
В ответе: Уведомляет клиента об использовании тестового режима сервера. В случае, если значение параметра установлено в «1», сервер находится в тестовом режиме.
В обоих случаях при отсутствии, по умолчанию, параметр принимает значение «0» (боевой режим).
ap_lang String(2) Нет Язык пользовательского интерфейса. Принимает значения (ISO 639-1):
  • «ru» – русский;
  • «be» – белорусский;
  • «en» – английский;
  • «uk» – украинский;
  • «pl» – польский;
  • «de» – немецкий.
По умолчанию используется «ru».
ap_service_id UID Нет Уникальный идентификатор операции. При получении данного поля в ответе, должен отправляться клиентом в следующем запросе операции. Значение поле не изменяется в процессе операции, значение поля отправляется сервером при регистрации операции. Поле является обязательным для всех запросов, кроме запроса регистрации операции.
ap_signature String(32…512) Да Хеш-сумма сообщения