Open Banking in Latvia
Обзор
Open Banking in Latvia — метод интернет-банкинга с использованием открытых банковских протоколов и расширенными возможностями для защищённой работы с информацией о пользователях. Этот метод относится к группе Open Banking и позволяет проводить платежи в евро через банки Латвии.
В платёжной платформе ecommpay поддерживаются оплаты методом Open Banking in Latvia. Вместе с тем, для проведения выплат, в том числе в целях возврата средств по проведённым оплатам, при работе с этим методом может использоваться комплементарный метод Выплаты на банковские счета в ЕЗПЕ (SEPA).
Характеристика
Тип платёжного метода | банковские платежи |
---|---|
Платёжные инструменты |
|
Регионы использования | LV |
Валюты платежей | EUR |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности |
|
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием метода Open Banking in Latvia задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также сервис одного из банков, поддерживающих работу с этим методом.
Основные операции
Интерфейсы | Суммы, EUR | ||||||
---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Mobile SDK | Gate | Dashboard | Минимум | Максимум | |
Оплаты | + | – | + | + | – | * | * |
* Ограничения сумм платежей зависят от банков.
Сценарии использования
Проведение оплат с использованием метода Open Banking in Latvia выполняется с перенаправлением пользователя к сервису провайдера.
Поддержка со стороны банков
Проведение платежей с применением метода Open Banking in Latvia осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании оплат через Gate, а также при вызове Payment Page для отображения страницы с выбором метода оплаты.
Далее в таблице в ознакомительных целях представлена информация об этих банках, которую следует уточнять у курирующего менеджера ecommpay или по запросу /v2/info/banks/latvia/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": 1000, "currency": "EUR" } }
Банк | ID |
---|---|
Rietumu bank | 2001 |
SEB bank | 1991 |
Swedbank | 1981 |
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения оплат, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Подтверждение зачисления средств
В проведении оплат с использованием метода Open Banking in Latvia участвуют банки, и в некоторых случаях обработка платежей на стороне этих банков и сервиса Open Banking in Latvia может занимать продолжительное время (в некоторых случаях до семи дней и больше). В связи с этим возможны ситуации, когда первичная информация о проведении или отклонении платежа не соответствует итоговому результату (например, при получении информации об отклонении платежа средства могут быть зачислены на счёт получателя позднее, и наоборот).
Чтобы обеспечить корректное уведомление мерчантов о состоянии платежей в таких случаях, в платёжной платформе ecommpay используется процедура подтверждения зачисления средств получателю. При подключении метода Open Banking in Latvia следует согласовывать с курирующим менеджером использование этой процедуры, а также перевод платежей, по которым получено подтверждение о том, что средства не зачислены, в статус reversed
или decline
(для удобства контроля и анализа платежей).
Подтверждение зачисления средств выполняется следующим образом: после выполнения пользователем всех необходимых действий платёж поступает в обработку на стороне сервиса Open Banking in Latvia, а пользователь возвращается к платёжному интерфейсу (Payment Page или веб-сервиса), где получает информацию о приёме платежа в обработку. В таком случае на стороне платёжной платформы формируется операция payment confirmation
, при этом платежу присваивается статус awaiting confirmation
, а операции sale
— статус success
до получения со стороны сервисного провайдера информации о зачислении средств и к веб-сервису отправляется соответствующее оповещение о состоянии платежа.
По итогам выполнения операции payment confirmation
ей может присваиваться один из следующих статусов:
success
— при получении подтверждения со стороны сервисного провайдера о зачислении средств получателю. В этом случае платежу присваивается статусsuccess
и к веб-сервису отправляется итоговое оповещение с информацией о результате оплаты.decline
— при получении информации со стороны сервисного провайдера о том, что средства не зачислены получателю. В этом случае, с учётом свойств проекта, заданных при подключении, допустимы следующие сценарии:- На стороне платёжной платформы автоматически формируется операция
reversal
и к веб-сервису последовательно отправляются соответствующие оповещения: промежуточное, с информацией о том, что средства не были зачислены, и итоговое, с информацией о возврате средств и переводе платежа в статусreversed
. - Платёж переводится в статус
decline
и к веб-сервису направляется итоговое оповещение с информацией об отклонении оплаты.
- На стороне платёжной платформы автоматически формируется операция
Контролировать изменение статусов платежей при использовании этой процедуры также можно через интерфейс Dashboard.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Open Banking in Latvia со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Open Banking in Latvia можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов).
Проведение платежа выполняется с перенаправлением пользователя к сервису провайдера. В некоторых случаях пользователь может быть также перенаправлен к сервису выбранного банка для подтверждения платежа. Также следует учитывать, что, в зависимости от специфики провайдера, обрабатывающего платёж, при работе с этим методом для проведения оплаты может требоваться дополнительное согласие пользователя и, в некоторых случаях, дополнительные данные о пользователе. Для получения такого согласия и дополнительных сведений (когда они необходимы) на Payment Page отображается соответствующая страница.
Рис.: Схема проведения оплаты через Payment Page с перенаправлением пользователя к сервису провайдера
Рис.: Проведение оплаты через Payment Page с перенаправлением пользователя к веб-сервису провайдера
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты передаётся к платёжной платформе.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется подготовка к открытию платёжной формы с учётом параметров вызова и свойств используемого проекта.
- Платёжная форма отображается пользователю.
- Пользователь выбирает платёжный метод Open Banking in Latvia и один из банков, поддерживающих работу с этим методом.
- Запрос на проведение оплаты через выбранный банк передаётся к платёжной платформе.
- На стороне платёжной платформы выполняется обработка запроса. При этом выявляется необходимость в получении дополнительного согласия пользователя и дополнительных данных о пользователе — с учётом специфики провайдера, через которого требуется провести платёж. Если необходимо получить такое согласие (и данные), выполняются следующие шаги:
- От платёжной платформы к Payment Page направляется информация о необходимости получения согласия пользователя на проведение оплаты и, если необходимо, дополнительных данных, требуемых для проведения платежа.
- На Payment Page пользователю отображается страница с уведомлением о необходимости подтвердить проведение оплаты и полями, которые необходимо заполнить для продолжения платежа.
- Пользователь предоставляет запрашиваемые данные, соглашается с указанной информацией и подтверждает проведение платежа.
- От Payment Page к платёжной платформе направляется предоставленная пользователем информация.
- На стороне платёжной платформы выполняется обработка полученной информации.
- От платёжной платформы к Payment Page передаются данные для перенаправления пользователя к сервису провайдера.
- Пользователь перенаправляется к сервису провайдера, где ему отображается платёжная инструкция.
- Пользователь выполняет необходимые действия для проведения оплаты.
- Запрос на проведение платежа передаётся от сервиса провайдера к сервису банка.
- На стороне сервиса банка выполняется обработка платежа.
- От сервиса банка к сервису провайдера направляется уведомление о результате оплаты.
- Информация о результате оплаты отображается пользователю на стороне сервиса провайдера.
- Пользователь перенаправляется к Payment Page.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется информация о результате проведения оплаты.
- Информация о результате оплаты отображается пользователю на Payment Page.
Рис.: Схема проведения оплаты через Payment Page с перенаправлением пользователя к сервису банка
Рис.: Проведение оплаты через Payment Page с перенаправлением пользователя к сервису банка
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты передаётся к платёжной платформе.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется подготовка к открытию платёжной формы с учётом параметров вызова и свойств используемого проекта.
- Платёжная форма отображается пользователю.
- Пользователь выбирает платёжный метод Open Banking in Latvia и один из банков, поддерживающих работу с этим методом.
- Запрос на проведение оплаты через выбранный банк передаётся к платёжной платформе.
- На стороне платёжной платформы выполняется обработка запроса. При этом выявляется необходимость в получении дополнительного согласия пользователя и дополнительных данных о пользователе — с учётом специфики провайдера, через которого требуется провести платёж. Если необходимо получить такое согласие (и данные), выполняются следующие шаги:
- От платёжной платформы к Payment Page направляется информация о необходимости получения согласия пользователя на проведение оплаты и, если необходимо, дополнительных данных, требуемых для проведения платежа.
- На Payment Page пользователю отображается страница с уведомлением о необходимости подтвердить проведение оплаты и полями, которые необходимо заполнить для продолжения платежа.
- Пользователь предоставляет запрашиваемые данные, соглашается с указанной информацией и подтверждает проведение платежа.
- От Payment Page к платёжной платформе направляется предоставленная пользователем информация.
- На стороне платёжной платформы выполняется обработка полученной информации.
- От платёжной платформы к Payment Page передаются данные для перенаправления пользователя к сервису провайдера.
- Пользователь перенаправляется к сервису провайдера, а затем — к сервису банка, где пользователю отображается платёжная инструкция.
- Пользователь выполняет необходимые действия для проведения оплаты.
- На стороне сервиса банка выполняется обработка платежа.
- Информация о результате оплаты отображается пользователю на стороне сервиса банка.
- Пользователь перенаправляется к Payment Page.
- От сервиса банка к сервису провайдера направляется уведомление о результате оплаты.
- Уведомление о результате оплаты передаётся от сервиса провайдера к платёжной платформе.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется информация о результате проведения оплаты.
- Информация о результате оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с методом Open Banking in Latvia, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Open Banking in Latvia необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_amount — сумма платежа в дробных единицах валюты;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Валютой платежа может быть только EUR.
- Дополнительно рекомендуется указывать имя и фамилию пользователя в параметрах 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
. - При использовании платёжного метода Open Banking in Latvia можно настраивать отображение страницы Payment Page с выбором метода оплаты.
По умолчанию банки, поддерживающие проведение оплат методом Open Banking in Latvia, объединены в группу и отображаются одной кнопкой Open Banking in Latvia, поэтому выбор банка осуществляется в платёжной форме Payment Page в два этапа: сначала выбирается метод Open Banking in Latvia среди прочих, а затем на следующей странице с перечнем банков выбирается конкретный банк. Существует несколько вариантов отображения страницы Payment Page с выбором метода оплаты:
- Отображение каждого банка группы отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением
true
в строке payment_methods_options."payment_methods_options": "{\"online_latvian_banks\": {\"split_banks\": true}}"
- Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Open Banking in Latvia. Для этого необходимо передавать идентификаторы банков в параметре banks_id. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.
"payment_methods_options": "{\"online_latvian_banks\": {\"split_banks\": true, \"banks_id\": [2001, 1991]}}"
- Отображение только банков группы без других методов. Для этого используется предварительный выбор метода Open Banking in Latvia. Необходимо передавать код платежного метода
online-latvian-banks
в параметре force_payment_method. Пользователю открывается страница с выбором банков, минуя страницу с выбором метода оплаты. - Отображение предварительно выбранного банка в платёжной форме. Для этого используется предварительный выбор метода Open Banking in Latvia. Необходимо передавать код платежного метода
online-latvian-banks
в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options.Рис.: Пример запроса на оплату с отображением выбранного банка
{ payment_id: 'X03936', payment_amount: 1000, payment_currency: 'EUR', project_id: 123, customer_id: 'customer1', force_payment_method: 'online-latvian-banks', payment_methods_options: '{\"online_latvian_banks\": {\"banks_id\": [2001]}}', signature: "kUi2x9dKHAVNU0FYlSCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" }
- Отображение каждого банка группы отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением
- Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробнее — в разделе Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Open Banking in Latvia должен содержать идентификаторы пользователя, проекта и платежа, сумму и валюту платежа, информацию о пользователе, URL для перенаправления пользователя к веб-сервису, а также подпись:
{ payment_id: 'X03936', payment_amount: 1000, payment_currency: 'EUR', project_id: 123, customer_id: 'customer1', customer_first_name: 'John', customer_last_name: 'Doe', merchant_return_url: 'http://example.com/return', signature: "kUi2x9dKHAVNU0FYldJrxh4...zUCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода Open Banking in Latvia используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 200
была успешно проведена оплата в размере 10,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 200, "payment": { "id": "abc12345", "type": "purchase", "status": "success", "date": "2020-03-20T14:22:06+0000", "method": "Latvian Banks", "sum": { "amount": 1000, "currency": "EUR" }, "description": "Success" }, "customer": { "id": "123" }, "operation": { "id": 9529253065607, "type": "sale", "status": "success", "date": "2020-03-20T14:22:06+0000", "created_date": "2020-03-20T14:22:00+0000", "request_id": "f1de353331a01fd14163fe4226-00009530", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "code": "0", "message": "Success", "provider": { "id": 1914, "payment_id": "", "auth_code": "" } }, "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivMlmbhQ==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 200, "payment": { "id": "abc67890", "type": "purchase", "status": "decline", "date": "2020-03-20T14:22:07+0000", "method": "Latvian Banks", "sum": { "amount": 1000, "currency": "EUR" }, "description": "Decline" }, "customer": { "id": "123" }, "operation": { "id": 9529253065608, "type": "sale", "status": "decline", "date": "2020-03-20T14:22:07+0000", "created_date": "2020-03-20T14:22:00+0000", "request_id": "f1de353331a01fd14163fe4226-00009531", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "code": "20000", "message": "General decline", "provider": { "id": 1914, "payment_id": "", "auth_code": "" } }, "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivM2mbhQ==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Open Banking in Latvia со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить перенаправление пользователя к сервису провайдера, поддерживающего работу с методом Open Banking in Latvia.
- Принять оповещение о результате оплаты.
Проведение платежа выполняется с перенаправлением пользователя к сервису провайдера. В некоторых случаях пользователь может быть также перенаправлен к сервису выбранного банка для подтверждения платежа. Также следует учитывать, что при работе с этим методом для проведения оплаты может требоваться дополнительное согласие пользователя и, в некоторых случаях, дополнительные данные о пользователе. Информация о том, что необходимо сделать со стороны веб-сервиса для получения согласия пользователя, представлена в разделе Форматы данных для получения согласия пользователей), а далее приведены полные схемы проведения оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Схема проведения оплаты через Gate с перенаправлением пользователя к сервису провайдера
Рис.: Проведение оплаты через Gate с перенаправлением пользователя к веб-сервису провайдера
- Пользователь на стороне веб-сервиса инициирует оплату через один из банков, поддерживающих работу с методом Open Banking in Latvia.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
- На стороне платёжной платформы выполняется дальнейшая обработка запроса. При этом выявляется необходимость в получении дополнительного согласия пользователя и дополнительных данных о пользователе — с учётом специфики провайдера, через которого требуется провести платёж. Если необходимо получить такое согласие (и данные), выполняются следующие шаги:
- От платёжной платформы к веб-сервису направляется информация о необходимости получения согласия пользователя на проведение оплаты и, если необходимо, дополнительных данных, требуемых для проведения платежа.
- На стороне веб-сервиса запрашивается согласие пользователя на проведение платежа и предоставление пользователем дополнительных данных, которые необходимы для продолжения платежа.
- Пользователь предоставляет запрашиваемые данные, соглашается с указанной информацией и подтверждает проведение платежа.
- От веб-сервиса к платёжной платформе направляется предоставленная пользователем информация.
- На стороне платёжной платформы выполняется обработка полученной информации.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя к сервису провайдера.
- Пользователь перенаправляется к сервису провайдера, где пользователю отображается платёжная инструкция.
- Пользователь выполняет необходимые действия для проведения оплаты.
- Запрос на проведение оплаты передаётся от сервиса провайдера к сервису банка.
- На стороне сервиса банка выполняется обработка платежа.
- От сервиса банка к сервису провайдера направляется уведомление о результате оплаты.
- Информация о результате оплаты отображается пользователю на стороне сервиса провайдера.
- Пользователь перенаправляется к веб-сервису мерчанта.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется информация о результате оплаты.
Рис.: Схема проведения оплаты через Gate с перенаправлением пользователя к сервису банка
Рис.: Проведение оплаты через Gate с перенаправлением пользователя к сервису банка
- Пользователь на стороне веб-сервиса инициирует оплату через один из банков, поддерживающих работу с методом Open Banking in Latvia.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
- На стороне платёжной платформы выполняется дальнейшая обработка запроса. При этом выявляется необходимость в получении дополнительного согласия пользователя и дополнительных данных о пользователе — с учётом специфики провайдера, через которого требуется провести платёж. Если необходимо получить такое согласие (и данные), выполняются следующие шаги:
- От платёжной платформы к веб-сервису направляется информация о необходимости получения согласия пользователя на проведение оплаты и, если необходимо, дополнительных данных, требуемых для проведения платежа.
- На стороне веб-сервиса запрашивается согласие пользователя на проведение платежа и предоставление пользователем дополнительных данных, которые необходимы для продолжения платежа.
- Пользователь предоставляет запрашиваемые данные, соглашается с указанной информацией и подтверждает проведение платежа.
- От веб-сервиса к платёжной платформе направляется предоставленная пользователем информация.
- На стороне платёжной платформы выполняется обработка полученной информации.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя к сервису провайдера.
- Пользователь перенаправляется к сервису провайдера, а затем — к сервису банка, где пользователю отображается платёжная инструкция.
- Пользователю отображается страница оплаты, и пользователь выполняет необходимые действия для проведения оплаты.
- На стороне сервиса банка выполняется обработка платежа.
- Информация о результате оплаты отображается пользователю на стороне сервиса банка.
- Пользователь перенаправляется к веб-сервису мерчанта.
- От сервиса банка к сервису провайдера направляется уведомление о результате оплаты.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется информация о результате оплаты.
Информация о формате запросов и параметрах инициирования оплат через Gate при работе с методом Open Banking in Latvia, а также о форматах данных для перенаправления пользователей и о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в разделе Работа с API.
Формат запросов
При формировании запросов на оплату с применением метода Open Banking in Latvia необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/banks/latvia/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 — объект, содержащий сведения о пользователе:
- Валютой платежа может быть только EUR.
- Дополнительно могут использоваться любые другие параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Open Banking in Latvia должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, информацию о пользователе, идентификатор банка и URL для перенаправления:
{ "general": { "project_id": 2990, "payment_id": payment_id, "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 1000, "currency": "EUR" }, "customer": { "id": "customer123", "ip_address": "1.2.3.4", "first_name": "John", "last_name": "Doe" }, "account":{ "bank_id": 140 }, "return_url":{ "return": "http://example.com/return" } }
Форматы данных для получения согласия пользователей
При работе с методом Open Banking in Latvia, в зависимости от специфики провайдера, может потребоваться получать дополнительное согласие пользователей на проведение платежей с использованием этого метода. Для проведения платежа с учётом согласия пользователя со стороны веб-сервиса необходимо:
- Принять от платёжной платформы оповещение о необходимости получения согласия пользователя (и дополнения информации о платеже, если это необходимо).
- Получить от пользователя это согласие (и дополнительные сведения, если это необходимо).
- Передать информацию о согласии пользователя (и дополнительные сведения, если это необходимо) в запросе в платёжную платформу.
В оповещении от платёжной платформы в параметре clarification_fields.customer.properties.psu_consent_text.default содержится текст, который необходимо отобразить пользователю для получения его согласия на проведение платежа.
Далее приведён фрагмент оповещения о необходимости получения согласия пользователя.
{ "clarification_fields": { "customer": { "type": "object", "description": "", "properties": { "psu_consent": { "type": "string", "description": "Need to request the users consent to make a payment" }, "psu_consent_text": { "type": "string", "description": "The text to be displayed on the payment form", "default": "=== The PSU consent text to be displayed on payment page ===" }
Запрос на продолжение платежа с учётом согласия пользователя (и дополнительных сведений, если это необходимо) отправляется методом POST к конечной точке /v2/payment/clarification и должен содержать следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, к которому относится проводимый платёж.
- payment_id — идентификатор платежа, к которому относятся отправляемые данные.
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным).
- additional_data — объект с информацией о согласии пользователя на проведение платежа (и дополнительными сведениями, если они необходимы):
- customer — объект, содержащий сведения о пользователе:
- psu_consent — информация о получении согласия пользователя на проведение оплаты. Если пользователь дал согласие на проведение платежа, необходимо передать значение
1
; если указать иное значение, согласие на проведение платежа запрашивается повторно. - psu_consent_text — текст запроса согласия пользователя на проведение оплаты, который был отображён пользователю. В значении этого параметра должен передаваться именно тот текст, который был получен в оповещении о необходимости получения согласия пользователя. Если текст, указанный в запросе, отличается от текста, полученного в оповещении, согласие на проведение платежа запрашивается повторно.
- psu_consent — информация о получении согласия пользователя на проведение оплаты. Если пользователь дал согласие на проведение платежа, необходимо передать значение
- customer — объект, содержащий сведения о пользователе:
Вместе с информацией о согласии в запросе на продолжение платежа может потребоваться указать дополнительные данные о пользователе, приведённые в разделе Формат запросов.
Таким образом, корректный запрос должен содержать идентификаторы проекта и платежа, информацию о согласии пользователя и текст, который был отображён пользователю, а также, при необходимости, дополнительные данные пользователя, и подпись:
{ "general": { "project_id": 10571, "payment_id": "1234567890", "signature": "=== signature ===" }, "additional_data": { "customer": { "psu_consent": "1", "psu_consent_text": "=== The PSU consent text to be displayed on payment page ===", "first_name": "Firstname", "last_name": "Lastname" "account": { "number": "AB123456789" } } }
Форматы данных для перенаправления пользователей
В зависимости от специфики провайдера, обрабатывающего платёж, поддерживается передача от платёжной платформы к веб-сервису двух вариантов оповещений для перенаправления пользователя к сервису провайдера. Информацию о варианте, используемом для конкретного проекта, можно уточнять у специалистов технической поддержки ecommpay.
Вариант 1
Для перенаправления пользователя от веб-сервиса к сервису провайдера необходимо:
- Принять от платёжной платформы оповещение с объектом redirect_data, содержащим в объекте body данные для подключения JavaScript-библиотеки провайдера и вызова функции перенаправления к сервису провайдера.
- Подключить JavaScript-библиотеку провайдера, ссылка на которую указана в параметре widget_url объекта body.
- Вызвать функцию перенаправления к сервису провайдера с использованием параметров, переданных в объекте body (в соответствии с требованиями провайдера).
В объекте body содержатся следующие обязательные параметры:
- widget_url — ссылка на JavaScript-библиотеку провайдера,
- widget_host — доменное имя сервера провайдера,
- token — токен, который необходимо использовать в
data.token
в функции перенаправления, - other — определяет возможность оплаты через банки, которые не поддерживаются по умолчанию на стороне провайдера; в данной технической реализации эта возможность не поддерживается, в значении параметра всегда передаётся
off
, - callback_url — URL для перенаправления пользователя к веб-сервису после оплаты;
Также в объекте body могут содержаться следующие необязательные параметры:
- creditor — банковский идентификационный код (БИК); используется при выборе банка на стороне веб-сервиса;
- css — ссылка на файл формата CSS, который со стороны мерчанта можно использовать для настройки оформления сервиса провайдера для конкретного вызова;
- default_country — код страны, через банки которой может быть проведён платёж, в формате ISO 3166-1 alpha-2.
Рис.: Пример данных для перенаправления
"redirect_data": { "url": "http://pay.test/example", "method": "POST", "body": { "widget_url":"https://psd2.neopay.lt/widget.js", "widget_host":"https://psd2.neopay.lt/", "token": "eyJhbGciOiJIUzI1NiIsInR5cCIp0cnVlLCJpYXQiOjE0OTMyMD", "other": "off", "creditor": "HABALV22", "css": "https://css.test.org", "default_country": "LV", "callback_url": "https://callback.url.org" } }
Далее представлены примеры ссылки на JavaScript-библиотеку провайдера и вызова функции перенаправления к сервису провайдера, созданные с использованием данных из примера выше.
Рис.: Пример ссылки на JavaScript-библиотеку провайдера
<script type="text/javascript" src="https://psd2.neopay.lt/widget.js"></script>
Рис.: Пример вызова функции перенаправления к сервису провайдера
var NEOWidgetHost = "https://psd2.neopay.lt"; NEOWidget.initialize( NEOWidgetHost, data.token, { 'other':'off', 'creditor': 'HABALV22', 'css':'https://css.test.org', 'default_country':'LV', 'callback_url':'https://callback.url.org' } );
Вариант 2
Для перенаправления пользователя от веб-сервиса на сайт сервиса Open Banking in Latvia необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Рис.: Пример данных для перенаправления
"redirect": { "method": "POST", "body": [], "encrypted": [], "url": "https://web-app.example.com/app/request-token/rq:3R123" }
Формат оповещений о результатах оплат
Для оповещений о результатах оплат с применением метода Open Banking in Latvia используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 200
была успешно проведена оплата в размере 10,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 200, "payment": { "id": "abc12345", "type": "purchase", "status": "success", "date": "2020-03-20T14:22:06+0000", "method": "Latvian Banks", "sum": { "amount": 1000, "currency": "EUR" }, "description": "Success" }, "customer": { "id": "123" }, "operation": { "id": 9529253065607, "type": "sale", "status": "success", "date": "2020-03-20T14:22:06+0000", "created_date": "2020-03-20T14:22:00+0000", "request_id": "f1de353331a01fd14163fe4226-00009530", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "code": "0", "message": "Success", "provider": { "id": 1914, "payment_id": "", "auth_code": "" } }, "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivMlmbhQ==" }
В следующем примере оплата была отклонена из-за нарушения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 200, "payment": { "id": "abc67890", "type": "purchase", "status": "decline", "date": "2020-03-20T14:22:07+0000", "method": "Latvian Banks", "sum": { "amount": 1000, "currency": "EUR" }, "description": "Decline" }, "customer": { "id": "123" }, "operation": { "id": 9529253065608, "type": "sale", "status": "decline", "date": "2020-03-20T14:22:07+0000", "created_date": "2020-03-20T14:22:00+0000", "request_id": "f1de353331a01fd14163fe4226-00009531", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "code": "20000", "message": "General decline", "provider": { "id": 1914, "payment_id": "", "auth_code": "" } }, "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivM2mbhQ==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода Open Banking in Latvia доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.