Open Banking in Portugal
Обзор
Open Banking in Portugal — метод интернет-банкинга для проведения платежей через банки Португалии. Для работы с этим методом доступно проведение оплат через Payment Page и Gate.
Характеристика
Тип платёжного метода | интернет-банкинг |
---|---|
Регионы использования | PT |
Валюты платежей | EUR |
Конвертация валют | на стороне ECommPay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | для данного метода можно задавать дополнительные параметры при вызове Payment Page |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием метода Open Banking in Portugal задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также сервис одного из банков, поддерживающих работу с этим методом.
Основные операции
Интерфейсы | Суммы | Время** | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | * | * | * | * |
* Ограничения сумм и время проведения платежей зависят от банков.
** Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.
Сценарии использования
Проведение оплат с использованием метода Open Banking in Portugal выполняется с перенаправлением пользователей к сервису провайдера.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Поддержка со стороны банков
Проведение оплат с применением метода Open Banking in Portugal осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании оплат через Gate, а также при вызове Payment Page для отображения страницы с выбором метода оплаты.
Далее в таблице в ознакомительных целях представлена информация об этих банках, которую следует уточнять у курирующего менеджера ECommPay или по запросу /v2/info/banks/portugal/sale/list
, отправляемым методом POST через Gate API: /v2/info/banks/{payment_method}/{operationType}/list для уточнения списка банков.
Запрос должен содержать идентификаторы проекта и платежа, подпись, валюту и сумму платежа, как указано в примере. Важно передавать реальные данные о платеже, но в случае если платёж еще не сформирован, для идентификатора платежа в запросе можно указать случайное значение.
Рис.: Пример запроса списка банков
{ "general": { "project_id": 200, "payment_id": "ORDER_155860015", "signature": "K6jllym+PtObocZtr345st...==" }, "payment": { "amount": 1500, "currency": "EUR" } }
Банк | ID |
---|---|
Banco BPI | 6661 |
Banco Activobank | 6651 |
Millennium bcp | 6641 |
Novo Banco Dos Acores | 6631 |
Novo Banco | 6621 |
Banco Santander Totta | 6331 |
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Open Banking in Portugal со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Open Banking in Portugal можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает один из банков, поддерживающих работу с платёжным методом Open Banking in Portugal.
- Запрос на проведение оплаты через банк поступает в платёжную платформу.
- На стороне платёжной платформы выполняются дальнейшая обработка запроса.
- Данные для перенаправления пользователя на сайт провайдера передаются к Payment Page.
- Пользователь перенаправляется на сайт провайдера.
- Пользователь подтверждает выбор банка.
- Пользователь перенаправляется на сайт банка.
- Пользователю отображается страница оплаты на сайте банка.
- Пользователь выполняет необходимые действия для оплаты на сайте банка.
- На стороне сервиса банка выполняется обработка платежа.
- Результат оплаты отображается пользователю на сайте банка.
- От сервиса банка к сервису провайдера направляется уведомление о результате оплаты.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Open Banking in Portugal, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Open Banking in Portugal необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- 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 с выбором метода оплаты.
По умолчанию названия банков, объединены в группу и отображаются одной кнопкой Portuguese banks, поэтому выбор банка осуществляется в два этапа. Сначала выбирается метод Portuguese banks среди прочих методов, а затем на следующей странице с перечнем банков выбирается конкретный банк. Существует несколько вариантов отображения страницы Payment Page с выбором метода оплаты:
- Отображение банков одной кнопкой Portuguese banks среди прочих методов.
- Отображение только поддерживаемых банков одной кнопкой Portuguese banks. Для этого используется предварительный выбор метода Open Banking in Portugal. Необходимо передавать код платежного метода
online-portuguese-banks
в параметре force_payment_method. Пользователю сразу открывается страница с выбором банков. - Отображение банков отдельными кнопками среди прочих методов. Для этого необходимо передавать параметр split_banks со значением
true
в параметре payment_methods_options.payment_methods_options={"portugal ": {"split_banks": true}}
- Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Open Banking in Portugal. Для этого используется предварительный выбор метода Open Banking in Portugal, но с указанием конкретного банка. Для этого необходимо передавать код платежного метода
online-portuguese-banks
в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.payment_methods_options={"portugal": {"split_banks": true, "banks_id": [6651, 6641]}}
Ниже приведён пример запроса на открытие Payment Page с предварительно выбранным банком.
Рис.: Пример запроса с предварительным выбором метода и банка
{ payment_id: '580', payment_amount: 1000, payment_currency: 'EUR', project_id: 120, force_payment_method: 'online-portuguese-banks', payment_methods_options={"portugal": {"banks_id": [5021]}}, customer_id: 'customer1', customer_first_name: 'John', customer_last_name: 'Doe', signature: "XFyr/D1zXj84lUZVfpbWZol9JAZLnUZoPJKPXRbOqBUpxxa/hOKm2 P8XOqydoyeIi7KdqrcxLFd3GxgPgUzIDg== }
- Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Open Banking in Portugal должен содержать идентификаторы проекта, пользователя и платежа, валюту и сумму платежа, имя и фамилию пользователя, а также подпись:
{ payment_id: 'X03936', payment_amount: 1000, payment_currency: 'EUR', project_id: 123, customer_id: 'customer1', customer_first_name: 'John', customer_last_name: 'Doe', signature: "kUi2x9dKHA...\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода Open Banking in Portugal используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 239
была успешно проведена оплата в размере 10,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 239, "payment": { "id": "TEST_PAYMENT_671446", "type": "purchase", "status": "success", "date": "2020-11-03T14:41:38+0000", "method": "Portuguese Banks", "sum": { "amount": 1000, "currency": "EUR" }, "description": "TEST_PAYMENT_671446" }, "customer": { "id": "1" }, "operation": { "id": 77796010023511, "type": "sale", "status": "success", "date": "2020-11-03T14:41:38+0000", "created_date": "2020-11-03T14:39:34+0000", "request_id": "4727897a23d96203f784...d22c87a7f4f473d93-00077797", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "code": "0", "message": "Success", "provider": { "id": 3901, "payment_id": "t:5nFu358iuKC3vz8g...zQLtgSSoyAQubVf", "auth_code": "" } }, "signature": "8UuSBBDvR9RlVXJR+3A3JeYOOPhf...1VlLygAOq+NPNKLu37IZ0kw==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "customer": { "id": "1" }, "project_id": 10801, "payment": { "id": "TEST_PAYMENT_624318", "type": "purchase", "status": "decline", "date": "2020-11-03T15:47:39+0000", "method": "Portuguese Banks", "sum": { "amount": 100, "currency": "EUR" }, "description": "TEST_PAYMENT_624318" }, "operation": { "id": 92939010024021, "type": "sale", "status": "decline", "date": "2020-11-03T15:47:39+0000", "created_date": "2020-11-03T15:47:02+0000", "request_id": "2973231f346e408fcf62f1e3388a...3971c8ccb13-00092940", "sum_initial": { "amount": 100, "currency": "EUR" }, "sum_converted": { "amount": 100, "currency": "EUR" }, "code": "20000", "message": "General decline", "provider": { "id": 3901, "payment_id": "" } }, "signature": "GK7q/MHaYQuUqSQiCzWFi.../6UzJhblNPSr7tj1/PWfWgCJLbnaeg==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Open Banking in Portugal со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис провайдера.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через один из банков, поддерживающих работу с методом Open Banking in Portugal.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя на сайт провайдера.
- Пользователь перенаправляется на сайт провайдера.
- Пользователь подтверждает выбор банка.
- Пользователь перенаправляется на сайт банка.
- Пользователю отображается страница оплаты на сайте банка.
- Пользователь выполняет необходимые действия для оплаты на сайте банка.
- На стороне сервиса банка выполняется обработка платежа.
- Результат оплаты отображается пользователю на сайте банка.
- От сервиса банка к сервису провайдера направляется уведомление о результате оплаты.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом Open Banking in Portugal через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Open Banking in Portugal необходимо учитывать следующее:
- Должен использоваться запрос к конечной точке
/v2/payment/banks/portugal/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 Portugal должен содержать идентификаторы проекта, пользователя и платежа, подпись, сумму и валюту платежа, информацию о пользователе, идентификатор банка и URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 2990, "payment_id": payment_id, "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 1000, "currency": "EUR" }, "customer": { "id": "customer1", "ip_address": "66.249.64.45", "first_name": "John", "last_name": "Doe" }, "account":{ "bank_id": 6651 }, "return_url":{ "return": "http://example.com/return" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Open Banking in Portugal необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect": { "method": "POST", "encrypted": [], "url": "https://web-app.example.com/app/request-token/rq:3R123" }
Формат оповещений
Для оповещений о результатах оплат с применением метода Open Banking in Portugal используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 239
была успешно проведена оплата в размере 10,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 239, "payment": { "id": "TEST_PAYMENT_671446", "type": "purchase", "status": "success", "date": "2020-11-03T14:41:38+0000", "method": "Portuguese Banks", "sum": { "amount": 1000, "currency": "EUR" }, "description": "TEST_PAYMENT_671446" }, "customer": { "id": "1" }, "operation": { "id": 77796010023511, "type": "sale", "status": "success", "date": "2020-11-03T14:41:38+0000", "created_date": "2020-11-03T14:39:34+0000", "request_id": "4727897a23d96203f784...d22c87a7f4f473d93-00077797", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "code": "0", "message": "Success", "provider": { "id": 3901, "payment_id": "t:5nFu358iuKC3vz8g...zQLtgSSoyAQubVf", "auth_code": "" } }, "signature": "8UuSBBDvR9RlVXJR+3A3JeYOOPhf...1VlLygAOq+NPNKLu37IZ0kw==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "customer": { "id": "1" }, "project_id": 10801, "payment": { "id": "TEST_PAYMENT_624318", "type": "purchase", "status": "decline", "date": "2020-11-03T15:47:39+0000", "method": "Portuguese Banks", "sum": { "amount": 100, "currency": "EUR" }, "description": "TEST_PAYMENT_624318" }, "operation": { "id": 92939010024021, "type": "sale", "status": "decline", "date": "2020-11-03T15:47:39+0000", "created_date": "2020-11-03T15:47:02+0000", "request_id": "2973231f346e408fcf62f1e3388a...3971c8ccb13-00092940", "sum_initial": { "amount": 100, "currency": "EUR" }, "sum_converted": { "amount": 100, "currency": "EUR" }, "code": "20000", "message": "General decline", "provider": { "id": 3901, "payment_id": "" } }, "signature": "GK7q/MHaYQuUqSQiCzWFi.../6UzJhblNPSr7tj1/PWfWgCJLbnaeg==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежа
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Open Banking in Portugal доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.