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

Получение информации о статусе выставленного счета ЕРИП. Метод GetEripInvoiceInfo.

Параметры запроса получения информации о выставленном счете

Название Тип Обязательность Значение Пример
ap_request String(1..30) Да Константа GetEripInvoiceInfo GetEripInvoiceInfo
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_erip_invoice_id String(1..30) Да Уникальный номер счета в разрезе «ap_erip_service_no» для оплаты в системе ЕРИП. 123
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_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 Да Номер услуги в ЕРИП. 23
ap_erip_invoice_id String Да Уникальный номер оплаченного счета в системе ЕРИП. 123
ap_erip_invoice_state Enum Да Текущее состояние счета. Принимает следующие значения:
  • «Paid» - счет оплачен;
  • «Canceled» - оплата счета сторнирована;
  • «PayError» - ошибка оплаты счета;
  • «CancelError» - ошибка сторнирования оплаты счета;
  • «Pending» - в ожидании выполнения оплаты или отмены;
  • «Error» - ошибка регистрации или обработки счета, в этом статусе счет является недействительным;
  • «Expired» - срок действия счета истек, счет является недействительным
ap_signature String (32…512) Да Хеш-Подпись. ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579

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

{"ap_request":"GetEripInvoiceInfo","ap_client_dt":"2021-10-03T09:15:01+03:00","ap_test":"1","ap_proto_ver":"1.3.0","ap_storeid":"120037","ap_erip_invoice_id":"147","ap_erip_service_no":"23","ap_client_type":"brw","ap_client_inf":"Chrome 49.0.2623.112 (Mac OS X 10.7.2);","ap_client_ver":"1.0","ap_signature":"064d320884831c46f24368249fb1a958bcaafa5c689f5528c8db857068710760aa57b342972b91f09ced8394be4c8e36c8794ff9afcc6fbfc9bc3a98fd01a979"}

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

{"ap_storeid":"120037","ap_erip_invoice_id":"19745424","ap_erip_service_no":"23","ap_erip_invoice_state":"Pending","ap_status":"Success","ap_result_code":0,"ap_result_text":"Выполнено успешно","ap_server_dt":"2021-10-03T12:52:18+03:00","ap_test":1,"ap_service_id":"72ed-4a56-fb70-0bae-ab6b-0bcb-8c0a-66d1","ap_signature":"afd4282850bf1d7e76166e371bcebc04379e8134444039abb6788c8a1ec0316d9d30cef37f674676bf3485c5858de12e0137a5f894f9a4ebc9b618fdbf27f542"}

Документация по другим методам API предоставляется по запросу.