"ДБО BS-Client. Частный Клиент" v.2.5
Описание Адаптера для платформы Единая Точка Контакта (ETK. Pay)
Руководство администратора
Версия 2.5.0.0
СОДЕРЖАНИЕ:
1. Описание платформы Единая Точка Контакта (ETK. Pay). 3
1.1. Общие сведения. 3
1.2. Архитектура и функциональные возможности. 3
1.3. Протокол обмена сообщениями. 4
1.3.1. Спецификация запроса на получение каталога услуг 4
1.3.2. Спецификация запроса на получение документов. 5
1.3.3. Спецификация запроса на проведение платежа. 7
1.3.4. Спецификация обмена финансовой информацией. 7
2. Настройка платформы в ЧК. 8
2.1. Обработчики запросов. 9
2.2. Настройки в Построителе. 9
2.2.1. Обмен сообщениями. 9
2.2.2. Оплата услуг и обновление справочника. 9
2.3. Настройки контролей. 10
2.4. Автопроцедуры используемые для работы с ЕТК. Pay. 10
2.5. Журнализация обмена данными с ЕТК. Pay. 11
3. Получение задолженностей. 11
4. Взаимодействие ЧК, ПС и АБС. 11
4.1. Порядок проведения операций. 12
4.2. Соответствие статусов. 13
4.2.1. Таблица соответствия статусов на банковской части системы ЧК и на стороне Клиента 14
1.2. Описание платформы Единая Точка Контакта (ETK. Pay)
1.1.2.1. Общие сведения
«Единая точка контакта» (ЕТК. Pay) является технологической платформой, предоставляющей кредитным учреждениям возможность организации услуг по приему дистанционных платежей, денежных переводов, приобретения товаров и услуг в режиме онлайн для своих и сторонних клиентов. Программный комплекс ЕТК. Pay устанавливается и функционирует в Банке (либо у юридического лица, осуществляющего приём платежей у населения).
Задачей ЕТК является организация информационной поддержки процессов приема и передачи распоряжений по оплате товаров и услуг между кредитными организациями, принимающими от физических лиц платежи в пользу поставщиков услуг, и юридическими лицами, получателями платежей.
ЕТК. Pay предоставляет интерфейс внешним системам, в том числе и «ДБО BS-Client. Частный клиент» (ЧК) для передачи распоряжений по оплате товаров и услуг.
Модуль интеграции с системой ETK. Pay позволяет:
1) по запросу, получать список услуг заведенных в системе ETK. Pay
2) производить оплату в пользу поставщиков услуг, заведенных в системе ETK. Pay
3) получать информацию о задолженности перед поставщиками услуг, заведенных в систему ETK. Pay, если поставщик услуги предоставляет такую информацию
4) проверят статус платежа через систему ETK. Pay
Подробнее о системе ЕТК. Pay можно узнать на сайте производителя: http://www. *****
1.2.2.2. Архитектура и функциональные возможности
Архитектура BSS. EBPP XML построена по клиент-серверной технологии, позволяющей конечному пользователю связываться с информационными системами поставщиков товаров и услуг. Формой коммуникации является модель «запрос-ответ». Один или более запросов могут объединяться в один запрос, и соответственно в качестве отклика на запрос, формируется ответ содержащий ответы на каждый входящий запрос. Спецификация BSS. EBPP XML подразумевает реализацию модели «запрос-ответ» как для синхронного так и асинхронного взаимодействия.
Спецификация BSS. EBPP XML не накладывает каких либо специальных требований к каналам передачи информации, что предоставляет возможность использования таких сред передачи, как:
- Файловый обмен Электронная почта Использование HTTP Использование SOAP
Возможна поддержка других каналов приема передачи.
Связь ЧК и ETK. Pay реализована через HTTP.
Сообщения представлены в формате XSD. Все сообщения подразделяются на два вида: запрос на проведение операций и ответ на запрос.
Спецификация BSS. EBPP XML версии 0.5 поддерживает следующие типы запросов:
- Запрос на передачу платежей, счетов (начислений), зачислений или статусов платежей Запрос на получение счетов (начислений) платежей, зачислений или статусов платежей Запрос на проведение, отзыв платежа. Запрос на получение каталога услуг или его изменений на определенную дату. Группа запросов, связанных с переводами денежных средств.
Со стороны ЧК существуют три запроса к платформе ЕТК. Pay:
· на получение каталога услуг (CatalogMsgRq);
· на проведение платежей авансовых/по выставленным счетам и отзыва платежей (PaymentMsgRq);
· на получение информации по выставленным счетам и статусам платежей (InquireMsgRq).
ЧК поддерживает отправку всех типов запросов. Поэтому с документами на оплату услуг, у которых в качестве внешней платежной системы указана ЕТК. Pay, можно производить следующие операции:
· Выгрузка (запрос BS_R_PUPAY)
· Отзыв (запрос BS_R_CANCEL)
· Квитовка (запрос BS_R_CHECK)
Также поддерживается обновление справочника услуг (запрос BS_R_PUINFO).
Программное взаимодействие ЧК и ЕТК. Pay осуществляется через ETKPay. dll библиотеку (обмен сообщениями) с использованием протокола HTTP.
1.3.2.3. Протокол обмена сообщениями
1.3.1.2.3.1. Спецификация запроса на получение каталога услуг
Каталог услуг представляет собой структурированный справочник, содержащий описание услуг предоставляемых поставщиками услуг зарегистрированными. Каждый поставщик предоставляет собственный каталог услуг. По запросу на получение каталога услуг, возвращается сводный каталог услуг от поставщиков, причем как полный каталог услуг, так и его изменения, начиная с указанной в запросе даты.
Структура запроса данных каталога CatalogMsgRq приведена на Рис. 1‑1.
Рис. 1‑1 Структура запроса CatalogMsgRq
Структура ответа CatalogMsgRs на запрос CatalogMsgRq приведена на Рис. 1‑2.
Рис. 1‑2 Структура ответа CatalogMsgRq
1.3.2.2.3.2. Спецификация запроса на получение документов
Запрос InquireMsgRq предназначен для получения счетов, платежей, зачислений, квитанций или статусов платежей в зависимости от условий запроса. Структура запроса приведена на Рис. 1‑3.
Рис. 1‑3 Структура запроса InquireMsgRq
Ответ InquireMsgRs на запрос InquireMsgRq имеет следующую структуру:
Рис. 1‑4 Структура ответа InquireMsgRq
1.3.3.2.3.3. Спецификация запроса на проведение платежа
Запрос PaymentMsgRq поступает от информационной системы кредитной организации и инициируется пользователем данной системы с целью оплаты каких либо услуг или отзыва ранее созданных распоряжений.
Рис. 1‑5 Структура запроса PaymentMsgRq
В качестве ответа на запрос выдаётся сообщение содержащее результат исполнении запроса.
Структура ответа PaymentMsgRs на запрос PaymentMsgRq приведена на Рис. 1‑6.
Рис. 1‑6 Структура ответа PaymentMsgRq
2.3. Настройка платформы в ЧК
Параметры Адаптера содержатся в справочнике «Платежные системы» (Справочники –> Оплата услуг –> Платежные системы), запись «ЕТКPay».
На вкладке «Основная» в строке «Наименование модуля системы» должно быть указано значение «ETKPay. dll».
Если выставлена галка «Обновлять справочник в автоматическом режиме», то автопроцедура «Обновление справочника услуг» будет вызывать обработчик запроса BS_R_PUINFO для системы ЕТК. Pay, прописанный в соответствующей таблице (в модуле cbank: Настройки/Настройки шлюза с АБС/Обработчики запросов к платёжным системам).
На вкладке «Дополнительные параметры» указаны параметры соединения с сервером ЕТК, данные, необходимые для составления XML-запроса, и справочные параметры.
Дополнительные параметры адаптера ЕТК.Pay отражены на Рис. 2‑1
Рис. 2‑1 Дополнительные параметры адаптера ETK. Pay
CatalogURL - URL-адрес запроса обновления каталога услуг (предоставляется ЕТК)
PayURL - URL-адрес запроса на проведение платежей (предоставляется ЕТК)
InquireURL - URL-адрес информационного запроса (предоставляется ЕТК)
SenderID - Идентификатор отправителя (предоставляется ЕТК)
MessageBufferSize - Размер буфера для входящих сообщений (в байтах)
CatalogLastUpdate - Дата последнего обновления каталога услуг
MaxVisElements - Максимальное количество видимых элементов в группе услуг
TimeoutAP - Таймаут на запросы в автопроцедурах (в секундах). Время ожианния ответа из системы ЧК.
TimeoutIC - Таймаут на запросы в Интернет Клиенте (в секундах). Время ожидания ответа от ПС.
Вкладка «Настройки филиалов» для ЕТК. Pay не используется.
На вкладке «Транзитные счета» задаются счета, предназначенные для взаиморасчетов с соответствующими платежными системами. Данные вкладки «Транзитные счета» используются для определения счёта, на который будет осуществляться платёж.
2.1.3.1. Обработчики запросов
Чтобы все операции ЧК, указанные в разделе «Описание платформы Единая Точка Контакта», могли быть осуществлены, необходимо занести соответствующие данные в таблицу «Обработчики запросов к платежным системам». Для этого нужно запустить cbank. exe и в меню выбрать Настройки –> Настройки шлюза с АБС –> Обработчики запросов к платежным системам. (Рис. 2‑2)
Рис. 2‑2 Скроллер «Обработчики запросов к платежным системам»
Добавьте недостающие обработчики событий в соответствии с Рис. 2‑2.
2.2.3.2. Настройки в Построителе
2.2.1.3.2.1. Обмен сообщениями
Для корректного обмена сообщениями в Построителе (dictman. exe) необходимо настроить следующие параметры (Конфигурации->IFIZ->ABSAPI->ETK):
Параметр | Значение по умолчанию | Описание |
DeleteEmptyGroupsOnCatalogUpdate | TRUE | Удаление пустых групп при обновлении каталога |
DeleteEmptyRegionsOnCatalogUpdate | TRUE | Удаление пустых регионов при обновлении каталога |
2.2.2.3.2.2. Оплата услуг и обновление справочника
Для корректной выгрузки документов оплаты услуг и обновления справочника, в Построителе (dictman. exe) необходимо настроить следующие параметры (параметры в узле Конфигурации->IFIZ->PUPAY):
CancelDocumentAfterPSReject | Если установлено значение TRUE, то при отказе ПС будет формироваться запрос на отзыв документа из АБС (если АБС поддерживает отзыв документа) |
StandartABSReq | Чтобы выгрузка документов и обновление справочника проходили через ПС, необходимо установить значение FALSE. Если установлено значение TRUE, то выгрузка документов и обновление справочника будут происходить только в АБС |
2.3.3.3. Настройки контролей
Для отображения в Интернет-Клиенте списка услуг, оплачиваемых через систему ЕТК. Pay, необходимо в контроле ShowExtPaysIDS (Настройки -> Настройки контролей -> Документы -> Единовременная оплата услуг -> ShowExtPaysIDS) добавить в перечисление (через запятую) ID платежной системы (для ЕТКPay = 5).
В контроле DirectCancelStatuses (Настройки -> Настройки контролей -> Документы -> Отзыв документов -> DirectCancelStatuses) необходимо задать статусы документов, при которых отзыв документов осуществляется непосредственно из ДБО (без обращения во внешнюю систему),. При работе с системой ЕТК. Pay это статусы 15003 и 17211 (статусы задаются через запятую).
2.4.3.4. Автопроцедуры используемые для работы с ЕТК.Pay
Для работы с системой ЕТК настроены и запущены следующие автопроцедуры:
· {Выгрузка} Выгрузка платежей в ЕТК
· Тип схемы – документарная операция
· Имя схемы – RetPUPayOneTime
· Имя операции – DocOut
· Тип запуска – Периодический
· {Квитовка} Квитовка документов "Частного Клиента"
· Тип схемы – простая операция
· Имя схемы – LinkABS
· Имя операции – IFizKviter
· Тип запуска – Периодический
· Квитовка документов на оплату услуг
· Тип схемы – простая операция
· Имя схемы – LinkABS
· Имя операции – PUPayKviter
· Тип запуска – Периодический
· Обновление справочника услуг
· Тип схемы – простая операция
· Имя схемы – IFIZ
· Имя операции – UpdatePUInfo
· Тип запуска – Периодический
Подробная информация о работе и настройке автопроцедур содержится в документе «Руководство администратора».
2.5.3.5. Журнализация обмена данными с ЕТК.Pay
Полный текст запросов к серверу ПС и ответов от него Адаптер записывает в общие логи с запросами/ответами в АБС (папка RetABS). В лог пишется полный текст запроса к серверу ЕТК и ответа сервера, а также сообщения о ходе процесса обмена сообщениями и о возникших ошибках.
Папки с логами по умолчанию хранятся в каталоге «Logs» (%BSSRoot%\SUBSYS\Logs). Подробная информация о настройке журнализации содержится в документе «Руководство администратора»
3.4. Получение задолженностей
Данный функционал позволяет предоставить Клиенту информацию по его задолженностям перед поставщиком услуг, а затем предоставляет возможность оплатить задолженности с помощью банковских продуктов.
В настоящее время, данный функционал доступен только при использовании платформы ЕТК и лицензируется отдельно (требуется лицензия на «Модуль интеграции ДБО BS-Client «Частный Клиент» с системой ЕТК. Обработка начислений»).
Список услуг, для которых предусмотрено получение информации о задолженности предоставляется ЕТК (загружаются при получении каталога услуг). У такой услуги в справочнике «Виды услуг» (Справочники -> Оплата услуг -> Виды услуг) на вкладке «Дополнительно» будет установлена галка «Получение задолженностей».
Добавление дополнительной услуги относящейся к данному функционалу производится на стороне ЕТК и выгружается в ЧК при обновлении каталога услуг.
При использовании данного функционала, в ЕТК направляется запрос на получение информации о задолженности по выбранным услугам. На основе полученных данных формируется стандартное распоряжение на оплату через ЕТК.
Для работы данного функционала в модуле Построитель должен быть включен параметр «ShowBills» (Конфигурации -> IFIZ -> ShowBills).
4.5. Взаимодействие ЧК, ПС и АБС
В схемах упоминаются следующие автопроцедуры:
· Автопроцедура 1 - {Выгрузка} Выгрузка платежей в ЕТК;
· Автопроцедура 2 - {Квитовка} Квитовка документов "Частного Клиента";
· Автопроцедура 3 - Квитовка документов на оплату услуг.
4.1.5.1. Порядок проведения операций
Схема взаимодействия систем на уровне бизнес-процессов при оплате услуг представлена на Рис. 4‑1.
Рис. 4‑1 Схема взаимодействия систем
Схема взаимодействия систем на уровне бизнес-процессов при оплате задолженностей представлена на Рис. 4‑2.
Рис. 4‑2 Схема взаимодействия систем при получении задолженностей
4.2.5.2. Соответствие статусов
Схема соответствия статусов документов в Интернет-клиенте статусам на Банке и в АБС.
Рис. 4‑3 Схема соответствия статусов
4.2.1.5.2.1. Таблица соответствия статусов на банковской части системы ЧК и на стороне Клиента
На Банке | На Клиенте | ||
Название | № | Название | № |
Принят+ | 15003 | Обрабатывается | 411 |
Отказан АБС | 17061 | Отказано | 375 |
Принят АБС | 17011 | Обрабатывается | 411 |
Исполнен АБС | 17131 | Обрабатывается | 411 |
Проверен ПС | 17211 | Обрабатывается | 411 |
Отказан ПС | 17161 | Отказано | 375 |
Принят ПС | 17151 | Обрабатывается | 411 |
Исполнен | 17041 | Исполнено | 413 |
Подтвержден АБС | 17121 | Исполнено | 413 |
