Sofort (legacy)
Обзор
Sofort — альтернативный платёжный метод для проведения оплат и возвратов с использованием интернет-банкинга. Оплаты осуществляются через Payment Page и Gate, возвраты — через Gate.
Для работы с методом Sofort доступен новый вариант, описанный в разделе Sofort.
Информацию о способах перехода на новый вариант работы с методом уточняйте у курирующих менеджеров.
Характеристика
Тип платёжного метода | Интернет-банкинг |
---|---|
Регионы использования | AT, BE, CH, DE, ES, NL |
Валюты платежей | EUR, CHF * |
Конвертация валют | на стороне ecommpay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | По согласованию с курирующим менеджером ecommpay |
* Точную информацию уточняйте у курирующего менеджера ecommpay.
Схема работы
В проведении отдельного платежа с использованием Sofort задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также сервис Sofort, который обеспечивает проведение платежей с участием банков.
Основные операции
Интерфейсы | Суммы, EUR | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | |
Оплаты | + | – | – | – | 1,00 | 5 000,00 * |
Полные возвраты | – | – | + | – | – | – |
Частичные возвраты | – | – | + | – | – | – |
* По согласованию с курирующим менеджером ecommpay.
Сценарии использования
Проведение оплат с использованием метода Sofort выполняется с перенаправлением пользователей к сервису Sofort, проведение возвратов — с заявкой от пользователей через веб-сервис мерчанта и уведомлением о поступлении средств на счет.
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Sofort со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Sofort можно делать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Информация о формате запросов и параметрах вызова Payment Page при работе с Sofort, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в отдельном разделе.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Sofort необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах.
- Валютами платежа могут быть только EUR и CHF.
- Для открытия Payment Page необходимо передать код языка платёжной формы в параметре language_code. Подробнее см. в Управление языком платёжной формы.
- Дополнительно должны использоваться параметры с информацие о пользователе:
- customer_id — идентификатор в проекте,
- customer_first_name — имя,
- customer_last_name — фамилия,
- customer_email — адрес электронной почты,
- customer_country — страна.
- Для предварительного выбора метода Sofort необходимо указывать код платёжного метода в параметре force_payment_method —
sofort
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Sofort должен содержать идентификаторы проекта и платежа, подпись, данные пользователеля, а также валюту и сумму платежа:
Детальная информация обо всех указанных параметрах приведена в отдельном разделе.
Формат оповещений
Для оповещений о результатах оплат с применением метода Sofort используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
была успешно проведена оплата в размере 100,00 EUR
со счёта № 2626324568
.
В следующем примере оплата была отклонена из-за того, что сумма оплаты меньше установленного лимита.
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Sofort со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить перенаправление в сервис Sofort.
- Принять оповещение от платежной платформы ecommpay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Информация о формате запросов и параметрах инициализации оплат методом Sofort через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Sofort необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/sofort/sale
, отправляемый методом POST. Этот запрос относится к группе запросов на оплату с помощью интернет-банкинга: /v2/payment/online-banking/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- id — идентификатор в проекте,
- first_name — имя,
- last_name — фамилия,
- email — адрес электронной почты,
- country — страна,
- ip_address — используемый IP-адрес;
- payment — сведения о платеже:
- amount — сумма,
- currency — валюта платежа в формате ISO-4217 alpha-3.
- return_url — URL для возврата пользователя с сайта банка:
- return — URL сайта для возврата.
- general — основные сведения:
- Валютами платежа могут быть только EUR и CHF.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Sofort должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа:
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Sofort необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент примера оповещения, содержащего данные для перенаправления.
Формат оповещений
Для оповещений о результатах оплат с применением метода Sofort используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
была успешно проведена оплата в размере 100,00 EUR
со счёта № 2626324568
.
В следующем примере оплата была отклонена из-за того, что сумма оплаты меньше установленного лимита.
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
Sofort поддерживает проведение полных и частичных возвратов через Gate следующим способом: со стороны веб-сервиса мерчанта необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay, и принять оповещение о результате возврата. Полная схема проведения возврата представлена далее.
Информация о формате запросов и параметрах инициирования возвратов методом Sofort через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API — в отдельном разделе.
Формат запросов
При работе с запросами на возврат с применением метода Sofort необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/sofort/refund/
, отправляемый методом POST. Этот запрос относится к группе запросов для платежей с использованием интернет-банкинга /v2/payment/online-banking/{payment_method}/refund - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта;
- payment_id — идентификатор платежа;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес;
- payment — объект, содержащий сведения о возврате:
- description — комментарий или описание возврата,
- amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате),
- currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
- general — объект, содержащий основные идентификационные сведения о запросе:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода Sofort должен содержать идентификаторы проекта и платежа, IP-адрес пользователя:
Формат оповещений
Для оповещений о результатах возврата с применением метода Sofort используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
для пользователя был успешно проведён возврат в размере 100,00 EUR
на счёт № 2626324568
.
В следующем примере возврат был отклонён, так как значение суммы в запросе на возврат больше суммы в инитной оплате.
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода Sofort доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.