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

Регистрация счета для оплаты ЕРИП. Метод AddEripInvoice.

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

Название Тип Обязательность Значение Пример
ap_request String Да Константа AddEripInvoice AddEripInvoice
ap_client_dt DateTime Да Дата и время на клиенте. 2025-01-29T13:12:45.841Z
ap_client_type Enum Нет Тип используемого клиентского приложения. brw
ap_client_inf String(1..512) Нет Краткая информация о клиентском приложении. Chrome 49.0.2623.112 (Mac OS X 10.7.2)
ap_client_ver String(1..16) Нет Версия на клиенте. 1.28.3
ap_proto_ver String(3..10) Да Версия протокола. 3.8
ap_test Boolean Нет Индикатор тестового режима клиента. 1
ap_lang String(2..2) Нет Язык пользовательского интерфейса. be
ap_store_id String(1..30) Да Идентификатор точки обслуживания. 43434
ap_erip_service_no String-Number(1..8) Нет Номер услуги в системе ЕРИП. Является обязательным, если у продавца зарегистрировано более 1 услуги в ЕРИП. При отсутствии будет использован номер услуги, указанный в системе по умолчанию. 123
ap_amount String-Decimal(12,2) Да Сумма операции. 12.10
ap_currency String- Number(3) Да Валюта операции. BYN|USD|EUR|RUB
ap_sub_amounts subAmount array Нет Комплексный тип данных, содержащий список (массив) дополнительных сумм.
ap_invoice_expire DateTime Нет Срок действия счета. Счет нельзя будет оплатить позже указанной даты и времени. При отсутствии данного поля, счет актуален 3 суток. Срок действия счета не может быть меньше 1 часа и больше 30 дней. 2025-02-29T13:12:45.841Z
ap_cust_name stName Нет Структура ФИО плательщика.
ap_cust_address stAddress Нет Структура адреса плательщика.
ap_invoice_desc String Нет Краткое описание приобретаемых товаров или оказываемых услуг.
  • «Телевизор марки Горизонт 32”»;
  • «Мобильная гарнитура 1 ед.; сетевое зарядное для смартфона 2 ед.; автомобильное зарядное для смартфона 1 ед.;»;
  • «Оплата за услуги монтажа подвесного оборудования».
Кодовая страница – «utf8». Максимальный размер – 10KB
ap_epos_url_required Boolean Нет Генерировать ссылку для оплаты(только для E-POS) 1
ap_erip_cust_account String(1,30) Нет номер лицевого счета плательщика ЕРИП у сервис провайдера в разрезе услуги 970
up_... String (1..1024) Нет Набор пользовательских параметров. Разрешается добавлять до 16 пользовательских параметров с любыми именами, начинающимися с префикса "up_" (например, "up_any_param"). Данные параметры не обрабатываются и не учитываются в платежной системе при оплате, но передаются предприятию (точке обслуживания) после успешного выполнения операции в уведомлении. up_any_param=success

Поля ответа.

Название Тип Обязательность Значение Пример
ap_status Enum Да Статус выполнения операции. Success
ap_result_code Int32 Нет Целочисленный код выполнения операции. 0
ap_result_text String Нет Описание результата выполнения операции. Выполнено успешно
ap_server_dt DateTime Да Дата и время на сервере. 2025-01-29T16:12:48+03:00
ap_test Boolean Нет Индикатор тестового режима сервера. 1
ap_erip_service_no String-Number(1,8) Да Номер услуги в АИС ЕРИП. 123
ap_erip_invoice_id String(1,30) Да Уникальный номер счета в разрезе «ap_erip_service_no» для оплаты в системе АИС ЕРИП. Система "ArtPay" генерирует номер счета методом последовательного инкремента в разрезе указанного "ap_erip_service_no". 123
ap_epos_url URL Нет Url для E-POS заказа, обязателен, если в запросе «ap_epos_url_required:1» https://pay.raschet.by/...
ap_epos_qr String Нет QR с ссылкой для оплаты base64 png, обязателен, если в запросе «ap_epos_url_required:1»
ap_store_desc String Нет Наименование точки обслуживания.
ap_service_id UID Нет Уникальный идентификатор операции.

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

ap-content-signature: "1.c90851e727d4ca199cb66a7843187aec535b93c665a6267858175e67edbac10c"

{
    "ap_request":"AddEripInvoice",
    "ap_amount":"2.22",
    "ap_currency":933,
    "ap_invoice_desc":"Оплата 2.22",
    "ap_invoice_expire":"2025-01-30T13:12:45.841Z",
    "ap_epos_url_required":1,
    "up_terminal_id":"N5111112",
    "ap_erip_cust_account":"375291111111",
    "ap_erip_service_no":"70",
    "ap_order_num":123,
    "ap_client_dt":"2025-01-29T13:12:45.841Z",
    "ap_client_inf":"GTPOS",
    "ap_client_ver":"5.1.6",
    "ap_proto_ver":"3.5",
    "ap_lang":"ru",
    "ap_store_id":"600060",
    "ap_test":1
}

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

ap-content-signature: "1.52554f36f06504124de4a2287b1fbc6930723ffd2b5963fe1b183be554e28820"

{
    "ap_erip_service_no": "70",
    "ap_erip_invoice_id": "10275-8-379",
    "ap_epos_url": "https://pay.raschet.by/?...",
    "ap_epos_qr": "iVBORw0KGgo....CC",
    "ap_status": "Success",
    "ap_result_code": 0,
    "ap_result_text": "Выполнено успешно",
    "ap_server_dt": "2025-01-29T16:12:48+03:00",
    "ap_test": 1
}