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

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

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

Название Тип Обязательность Значение Пример
ap_request String Да Константа GetEripInvoiceInfo GetEripInvoiceInfo
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 Int32 Нет Номер услуги в системе ЕРИП. Является обязательным, если у продавца зарегистрировано более 1 услуги в ЕРИП. При отсутствии будет использован номер услуги, указанный в системе по умолчанию. 123
ap_erip_invoice_id String(1..30) Да Уникальный номер счета в разрезе «ap_erip_service_no» для оплаты в системе ЕРИП. 123

Поля ответа.

Название Тип Обязательность Значение Пример
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_trn_state Enum Да Текущее состояние счета. Принимает следующие значения:
  • «Paid» - счет оплачен;
  • «Canceled» - оплата счета сторнирована;
  • «PayError» - ошибка оплаты счета;
  • «CancelError» - ошибка сторнирования оплаты счета;
  • «Pending» - в ожидании выполнения оплаты или отмены;
  • «Error» - ошибка регистрации или обработки счета, в этом статусе счет является недействительным;
  • «Expired» - срок действия счета истек, счет является недействительным
ap_error_text String(1..999) Нет В случае неуспешного статуса может содержать описание ошибки.
ap_erip_service_no String-Number(1..8) Да Номер услуги в ЕРИП. 23
ap_erip_invoice_id String(1..30) Да Уникальный номер оплаченного счета в системе ЕРИП. 123
ap_amount String-Decimal(12,2) Нет Сумма операции. 12.10
ap_currency String- Number(3) Нет Валюта операции. BYN|USD|EUR|RUB
ap_trans_dt DateTime Нет Дата и время выполнения транзакции на сервере ЕРИП.
ap_erip_trn_id String(1..11) Нет Уникальный номер транзакции в системе ЕРИП.
ap_sp_trn_id String(1..12) Нет Уникальный номер транзакции у поставщика услуг.
ap_sub_amounts subAmount array Нет Комплексный тип данных, содержащий список (массив) дополнительных сумм.
ap_cust_name stName Нет Структура ФИО плательщика.
ap_cust_address stAddress Нет Структура адреса плательщика.
ap_erip_ivoice_details eripInvoiceDetails Нет Дополнительные данные по оплаченному счету ЕРИП.
up_... String(1..1024) Нет Набор пользовательских параметров. Отправляется массив параметров из запроса регистрации счета см. запрос регистрации счета

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

ap-content-signature: "1.e716aca5b7ddc0c466db5ed426546fcc197f9ad72b8ffb978cc8739187cbf045"

{
   "ap_request":"GetEripInvoiceInfo",
   "ap_erip_service_no":"70",
   "ap_erip_invoice_id":"380",
   "ap_client_dt":"2025-01-29T14:07:23.599Z",
   "ap_client_inf":"GTPOS",
   "ap_client_ver":"5.1.6",
   "ap_proto_ver":"3.5",
   "ap_store_id":"600060",
   "ap_test":1,
   "up_terminal_id":"N5111112"
}

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

В ожидании выполнения оплаты или отмены 
ap-content-signature: "1.e6ad92feb2ba3395a990b11062dfc087b0b69aae070171f86b216a995e94908a"

{
    "ap_erip_trn_state":"Pending",
    "ap_erip_service_no":"70",
    "ap_erip_invoice_id":"27676845",
    "ap_status":"Success",
    "ap_result_code":0,
    "ap_result_text":"Выполнено успешно",
    "ap_server_dt":"2025-01-29T17:06:45+03:00",
    "ap_test":1
}
Счет оплачен 
ap-content-signature: "1.17ad9еfeb2ba3395a920b11462df7087b0b49aaef7017cf86d216a695e94305b"

{
    "ap_erip_trn_state":"Paid",
    "ap_erip_service_no":"1070",
    "ap_erip_invoice_id":"42486569",
    "ap_erip_trn_id":"5641403970",
    "ap_status":"Success",
    "ap_result_code":0,
    "ap_result_text":"Выполнено успешно",
    "ap_server_dt":"2025-01-27T17:16:28+03:00",
    "ap_test":0
}

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