Open Banking in Hungary
Обзор
Open Banking in Hungary — метод интернет-банкинга с использованием открытых банковских протоколов и расширенными возможностями для защищённой работы с информацией о пользователях. Этот метод относится к группе Open Banking и позволяет проводить платежи в форинтах через банки Венгрии.
Характеристика
Тип платёжного метода | банковские платежи |
---|---|
Платёжные инструменты |
|
Регионы использования | HU |
Валюты платежей | HUF |
Конвертация валют | на стороне ecommpay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности |
|
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием метода Open Banking in Hungary задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также сервис одного из банков, поддерживающих работу с этим методом.
Основные операции
Интерфейсы | Суммы | Время** | |||||||
---|---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Mobile SDK | Gate | Dashboard | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | + | – | * | * | * | * |
* Ограничения сумм и время проведения платежей зависят от банков.
** Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ecommpay.
Сценарии использования
Проведение оплат с использованием метода Open Banking in Hungary выполняется с перенаправлением пользователей к сервису провайдера.
Поддержка со стороны банков
Проведение оплат с применением метода Open Banking in Hungary осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании оплат через Gate, а также при вызове Payment Page для отображения страницы с выбором метода оплаты.
Далее в таблице в ознакомительных целях представлена информация об этих банках, которую следует уточнять у курирующего менеджера ecommpay или по запросу /v2/info/banks/hungary/sale/list
, отправляемым методом POST через Gate API: /v2/info/banks/{payment_method}/{operationType}/list для уточнения списка банков.
Запрос должен содержать идентификаторы проекта и платежа, подпись, валюту и сумму платежа, как указано в примере. Важно передавать реальные данные о платеже, но в случае если платёж еще не сформирован, для идентификатора платежа в запросе можно указать случайное значение.
Банк | ID |
---|---|
K&H Bank | 22401 |
OTP Banka Hungary | 22391 |
Raiffeisen Bank | 22381 |
UniCredit Bank Hungary | 22371 |
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Подтверждение зачисления средств
В проведении оплат с использованием метода Open Banking in Hungary участвуют банки, и в некоторых случаях обработка платежей на стороне этих банков и сервиса Open Banking in Hungary может занимать продолжительное время (в некоторых случаях до семи дней и больше). В связи с этим возможны ситуации, когда первичная информация о проведении или отклонении платежа не соответствует итоговому результату (например, при получении информации об отклонении платежа средства могут быть зачислены на счёт получателя позднее, и наоборот).
Чтобы обеспечить корректное уведомление мерчантов о состоянии платежей в таких случаях, в платёжной платформе ecommpay используется процедура подтверждения зачисления средств получателю. При подключении метода Open Banking in Hungary следует согласовывать с курирующим менеджером использование этой процедуры, а также перевод платежей, по которым получено подтверждение о том, что средства не зачислены, в статус reversed
или decline
(для удобства контроля и анализа платежей).
Подтверждение зачисления средств выполняется следующим образом: после выполнения пользователем всех необходимых действий платёж поступает в обработку на стороне сервиса Open Banking in Hungary, а пользователь возвращается к платёжному интерфейсу (Payment Page или веб-сервиса), где получает информацию о приёме платежа в обработку. В таком случае на стороне платёжной платформы формируется операция payment confirmation
, при этом платежу присваивается статус awaiting confirmation
, а операции sale
— статус success
до получения со стороны сервисного провайдера информации о зачислении средств и к веб-сервису отправляется соответствующее оповещение о состоянии платежа.
По итогам выполнения операции payment confirmation
ей может присваиваться один из следующих статусов:
success
— при получении подтверждения со стороны сервисного провайдера о зачислении средств получателю. В этом случае платежу присваивается статусsuccess
и к веб-сервису отправляется итоговое оповещение с информацией о результате оплаты.decline
— при получении информации со стороны сервисного провайдера о том, что средства не зачислены получателю. В этом случае, с учётом свойств проекта, заданных при подключении, допустимы следующие сценарии:- На стороне платёжной платформы автоматически формируется операция
reversal
и к веб-сервису последовательно отправляются соответствующие оповещения: промежуточное, с информацией о том, что средства не были зачислены, и итоговое, с информацией о возврате средств и переводе платежа в статусreversed
. - Платёж переводится в статус
decline
и к веб-сервису направляется итоговое оповещение с информацией об отклонении оплаты.
- На стороне платёжной платформы автоматически формируется операция
Контролировать изменение статусов платежей при использовании этой процедуры также можно через интерфейс Dashboard.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Open Banking in Hungary со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Open Banking in Hungary можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Информация о формате запросов и параметрах вызова Payment Page при работе с Open Banking in Hungary, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Open Banking in Hungary необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_amount — сумма платежа в дробных единицах валюты;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Дополнительно рекомендуется указывать имя и фамилию пользователя в параметрах customer_first_name и customer_last_name. Если параметры отсутствуют в запросе, на Payment Page пользователю отображаются поля для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платежах.
Также при выборе некоторых банков пользователю может потребоваться указать на Payment Page номер счёта (International Bank Account Number, IBAN), в то время как при работе с другими банками номер счёта указывается пользователем уже на стороне провайдера. В силу специфики метода этот номер может указываться только пользователем и не может быть указан в запросах.
- Рекомендуется передавать в запросе параметр merchant_return_url с указанием URL для перенаправления пользователя к веб-сервису, чтобы в случае отказа от предоставления согласия пользователь мог вернуться к веб-сервису мерчанта, щёлкнув соответствующую кнопку в платёжной форме. При этом, во избежание повторного оформления заказа на стороне веб-сервиса, рекомендуется указать тот адрес, который ведёт на страницу подтверждения заказа.
- Для предварительного выбора группы методов Open Banking необходимо указывать код группы
openbanking
в параметреforce_payment_group
. -
Можно настраивать отображение страницы Payment Page с выбором метода оплаты.
По умолчанию названия банков, объединены в группу и отображаются одной кнопкой Hungarian banks, поэтому выбор банка осуществляется в два этапа. Сначала выбирается метод Hungarian banks среди прочих методов, а затем на следующей странице с перечнем банков выбирается конкретный банк. Существует несколько вариантов отображения страницы Payment Page с выбором метода оплаты:
- Отображение банков одной кнопкой Hungarian banks среди прочих методов.
- Отображение только поддерживаемых банков одной кнопкой Hungarian banks. Для этого используется предварительный выбор метода Open Banking in Hungary. Необходимо передавать код платежного метода
online-hungarian-banks
в параметре force_payment_method. Пользователю сразу открывается страница с выбором банков. - Отображение банков отдельными кнопками среди прочих методов. Для этого необходимо передавать параметр split_banks со значением
true
в параметре payment_methods_options."payment_methods_options": "{\"online_hungarian_banks\": {\"split_banks\": true}}"
- Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Open Banking in Hungary. Для этого используется предварительный выбор метода Open Banking in Hungary, но с указанием конкретного банка. Для этого необходимо передавать код платежного метода
online-hungarian-banks
в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом."payment_methods_options": "{\"online_hungarian_banks\": {\"split_banks\": true, \"banks_id\": [22391, 22381]}}"
Ниже приведён пример запроса на открытие Payment Page с предварительно выбранным банком.
- Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Open Banking in Hungary должен содержать идентификаторы пользователя, проекта и платежа, сумму и валюту платежа, информацию о пользователе, URL для перенаправления пользователя к веб-сервису, а также подпись:
Формат итоговых оповещений
Для оповещений о результатах оплат с применением метода Open Banking in Hungary используется типовой формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 239
была проведена оплата в размере 10,00 EUR
.
В следующем примере оповещение свидетельствует об отклонённой оплате.
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
- Организация взаимодействия — о том, как организовать взаимодействие веб-сервиса с платёжной платформой через Payment Page.
- Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
- Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
- Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Payment Page.
- Информация о выполнении операций — о служебных кодах, которые используются в платёжной платформе, чтобы фиксировать информацию о выполнении операций.
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Open Banking in Hungary со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить перенаправление в сервис провайдера.
- Принять оповещение от платежной платформы ecommpay о результате оплаты.
При работе с методом Open Banking in Hungary требуется получение дополнительного согласия пользователя на проведение платежа с использованием этого метода. Информация о том, что необходимо сделать со стороны веб-сервиса для получения согласия пользователя, представлена в разделе Форматы данных для получения согласия пользователей, а далее приведена полная схема проведения оплаты.
Информация о формате запросов и параметрах инициации оплат методом Open Banking in Hungary через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Open Banking in Hungary необходимо учитывать следующее:
- Должен использоваться запрос к конечной точке
/v2/payment/banks/hungary/sale
, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в дробных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — используемый IP-адрес,
- account — объект, содержащий сведения о банковском счёте пользователя:
- bank_id — идентификатор банка;
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- return — URL для перенаправления пользователя на любом шаге оплаты.
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно рекомендуется указывать имя и фамилию пользователя. Если параметры отсутствуют в запросе, список недостающих параметров отправляется в оповещении на уточнение. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.
Рекомендуется использовать следующие объекты и параметры:
- customer — объект, содержащий сведения о пользователе:
- first_name — имя,
- last_name — фамилия.
- customer — объект, содержащий сведения о пользователе:
- Дополнительно могут использоваться любые другие параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Open Banking in Hungary должен содержать идентификаторы проекта, пользователя и платежа, подпись, сумму и валюту платежа, информацию о пользователе, идентификатор банка и URL для перенаправления:
Форматы данных для получения согласия пользователей
При работе с методом Open Banking in Hungary требуется получать дополнительное согласие пользователей на проведение платежей с использованием этого метода. Для проведения платежа с учётом согласия пользователя со стороны веб-сервиса необходимо:
- Принять от платёжной платформы оповещение о необходимости получения согласия пользователя (и дополнения информации о платеже, если это необходимо).
- Получить от пользователя это согласие (и дополнительные сведения, если это необходимо).
- Передать информацию о согласии пользователя (и дополнительные сведения, если это необходимо) в запросе в платёжную платформу.
В оповещении от платёжной платформы в объекте clarification_fields
содержится информация о параметрах и объектах, необходимых для проведения платежа. В структуру каждого объекта, включённого в объект clarification_fields
, входят:
- Параметры
type
иdescription
с указанием типа и описания объекта; - Объект
properties
с информацией о параметрах, включённых в объект; - Массив
required
со списком требуемых параметров; - Массив
errors
с информацией о причинах запроса указанных параметров.
Объект properties
и массив required
указываются в соответствии со спецификацией JSON Schema, а в объектах массива errors
приводятся параметры property
, message
и constraint
для указания названий запрошенных параметров, поясняющих сообщений и причин.
Текст, который необходимо отобразить пользователю для получения его согласия на проведение платежа, указывается в параметре clarification_fields.customer.properties.psu_consent_text.default
.
В следующем примере приведён фрагмент оповещения о необходимости получения согласия пользователя.
Запрос на продолжение платежа с учётом согласия пользователя (и дополнительных сведений, если это необходимо) отправляется методом POST к конечной точке /v2/payment/clarification и должен содержать следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, к которому относится проводимый платёж.
- payment_id — идентификатор платежа, к которому относятся отправляемые данные.
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным).
- additional_data — объект с информацией о согласии пользователя на проведение платежа (и дополнительными сведениями, если они необходимы):
- customer — объект, содержащий сведения о пользователе:
- psu_consent — информация о получении согласия пользователя на проведение оплаты. Если пользователь дал согласие на проведение платежа, необходимо передать значение
1
; если указать иное значение, согласие на проведение платежа запрашивается повторно. - psu_consent_text — текст запроса согласия пользователя на проведение оплаты, который был отображён пользователю. В значении этого параметра должен передаваться именно тот текст, который был получен в оповещении о необходимости получения согласия пользователя. Если текст, указанный в запросе, отличается от текста, полученного в оповещении, согласие на проведение платежа запрашивается повторно.
- psu_consent — информация о получении согласия пользователя на проведение оплаты. Если пользователь дал согласие на проведение платежа, необходимо передать значение
- customer — объект, содержащий сведения о пользователе:
Вместе с информацией о согласии в запросе на продолжение платежа может потребоваться указать дополнительные данные о пользователе, приведённые в разделе Формат запросов.
Таким образом, корректный запрос должен содержать идентификаторы проекта и платежа, информацию о согласии пользователя и текст, который был отображён пользователю, а также, при необходимости, дополнительные данные пользователя, и подпись:
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Open Banking in Hungary необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
Формат итоговых оповещений
Для оповещений о результатах оплат с применением метода Open Banking in Hungary используется типовой формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 239
была проведена оплата в размере 10,00 HUF
.
В следующем примере оповещение свидетельствует об отклонённой оплате.
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
- Организация взаимодействия — о том, как взаимодействовать с платёжной платформой через Gate.
- Работа с подписью к данным — о порядке создания и проверки подписи в программных запросах и оповещениях при взаимодействии с платёжной платформой.
- Модель проведения платежей — о типах, схемах проведения и возможных статусах поддерживаемых платежей и операций.
- Разовая оплата в одну стадию — о том, как проводить разовые оплаты через Gate.
- Информация об операциях — о служебных кодах, используемых в платёжной платформе для фиксации информации о выполнении операций.
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода Open Banking in Hungary доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.