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

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

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

Название Тип Обязательность Значение Пример
ap_request String(1..30) Да Константа EripAddInvoice EripAddInvoice
ap_storeid String(1..30) Да Идентификатор точки обслуживания. 43434
ap_client_dt Int32 | 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_erip_service_no Int32 Нет Номер услуги в системе ЕРИП. Является обязательным, если у продавца зарегистрировано более 1 услуги в ЕРИП. При отсутствии будет использован номер услуги, указанный в системе по умолчанию. 123
ap_order_num Int64 Нет Номер заказа. 123
ap_amount Double Да Сумма платежа. 12.10
ap_currency String(3..3) Да Цифровой трехсимвольный код валюты либо его буквенное обозначение согласно ISO4271. BYN|USD|EUR|RUB
ap_invoice_desc String (max 2500) Да Краткое описание приобретаемых товаров или оказываемых услуг. Холодильник
ap_invoice_expire Int32 Нет Дата и время: UNIX-время. Срок действия счета. Счет нельзя будет оплатить позже указанной даты и времени. При отсутствии данного поля, счет актуален 3 суток. Срок действия счета не может быть меньше 1 часа и больше 1 месяца. 1466602065
ap_epos_url_required Boolean Нет Генерировать ссылку для оплаты(только для E-POS) 1
ap_client_type Enum Нет Тип используемого клиентского приложения:
  • «srv» – взаимодействие осуществляется между сервером точки обслуживания\агрегатора и сервером «ArtPay»;
  • «brw» – интернет-браузер;
  • «apk» – мобильное приложение для Android;
  • «ipa» – мобильное приложение iOS;
  • «pos» – терминал
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_erip_cust_account String Нет номер лицевого счета плательщика ЕРИП у сервис провайдера в разрезе услуги 970
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_server_dt Int32 | DateTime Да Дата и время. Дата и время не должны отличаться более чем на 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_test Boolean Нет Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза. При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). 1|0
ap_service_id UID Нет Уникальный идентификатор операции. 7a29-724a-f26e-9a78-4b4c-f7a7-9da5-7b72
ap_erip_service_no Int32 Да Номер услуги в ЕРИП. 123
ap_erip_invoice_id String Да Уникальный номер счета в разрезе «ap_erip_service_no» для оплаты в системе ЕРИП. Система "ArtPay" генерирует номер счета методом последовательного инкремента в разрезе указанного "ap_erip_service_no". 123
ap_epos_url String Нет Ссылка для оплаты(только для E-POS) https://pay.raschet.by/...
ap_epos_qr String Нет QR с ссылкой для оплаты base64 png(только для E-POS)
ap_signature String (32…512) Да Хеш-Подпись. ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579

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

{"ap_request":"EripAddInvoice","ap_storeid":"120037","ap_order_num":"12","ap_client_dt":"Thu, 25 Jan 2018 13:20:41 +0300","ap_proto_ver":"1.3.0","ap_lang":"ru","ap_test":"1","ap_erip_service_no":"0","ap_amount":"10","ap_currency":"933","ap_invoice_desc":"Test Erip","ap_signature":"7bca35a812abcf11289c8881ef22cc6dea7d533ab535559cb653c9542d5649870c443ffc60551200d6f3e2ed4e8b500cf8325ba2ae47cd043d15eb9f06564a03"}

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

{"ap_storeid":"120037","ap_store_desc":"my test","ap_erip_service_no":"37011","ap_erip_invoice_id":"20506","ap_status":"Success","ap_result_code":0,"ap_result_text":"Выполнено успешно","ap_service_id":"0766-7bd7-ef69-7c26-6753-2fe3-b085-972f","ap_server_dt":"2018-01-25T13:46:28+03:00","ap_test":1,"ap_signature":"62e4e1e5df507dd1bfeae5a549707432b8365b5400180826a175352aa62a32266a044a74da06c4b57cab867a2c22391f537256377eb448add8f1a54737f718b8"}