Bancontact
Обзор
Bancontact — платёжный метод, позволяющий пользователям совершать оплаты с использованием платёжных карт Bancontact и мобильного приложения Bancontact. Пользователям также доступны возвраты. Для работы с этим методом доступно проведение оплат через Payment Page и Gate, возвратов — через Gate.
Характеристика
Тип платёжного метода | банковские платежи |
---|---|
Платёжные инструменты | платёжные карты |
Регионы использования | BE |
Валюты платежей | EUR |
Конвертация валют | на стороне ecommpay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | если сумма платежа превышает 500,00 EUR, то такой платёж не может быть совершён с использованием мобильного приложения Bancontact |
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием Bancontact задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства Bancontact.
Основные операции
Интерфейсы | Суммы, EUR | Время* | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | 1,00 | – | – | 30 дней |
Полные возвраты | – | + | – | – | – | – | – | |
Частичные возвраты | – | – | + | – | – | – | – | – |
* Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ecommpay.
Сценарии использования
Проведение оплат с использованием метода Bancontact выполняется с перенаправлением пользователей к сервису Bancontact, проведение возвратов — с заявкой от пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Bancontact со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Bancontact можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает для оплаты метод Bancontact.
- Запрос на проведение оплаты через Bancontact поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис Bancontact.
- На стороне Bancontact выполняется обработка запроса на оплату.
- От сервиса Bancontact к платёжной платформе передаются данные для перенаправления пользователя в сервис Bancontact.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис Bancontact.
- Пользователь выполняет необходимые действия для оплаты. Если сумма платежа меньше 500,00 EUR, то пользователю, помимо полей для ввода данных платёжной карты Bancontact, отображается QR-код для сканирования с использованием мобильного приложения Bancontact. Пользователь может выбрать один из упомянутых вариантов для совершения оплаты. Если сумма платежа больше 500,00 EUR, то пользователю не отображается QR-код и оплата не может быть совершена с использованием мобильного приложения.
- На стороне сервиса Bancontact выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе Bancontact.
- Пользователь перенаправляется к Payment Page.
- От сервиса Bancontact к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах формирования Payment Page при работе с Bancontact, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API представлена в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Bancontact необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах,
- customer_id — идентификатор пользователя в рамках проекта.
- Дополнительно рекомендуется использовать параметр customer_last_name — фамилия пользователя в рамках проекта (для предотвращения ошибок при проведении платежей рекомендуется указывать не менее 3 и не более 100 символов). Если параметр отсутствует в запросе, на Payment Page пользователю отображается поле для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платежах.
- Валютой платежа может быть только EUR.
- Для предварительного выбора метода Bancontact необходимо указывать код платёжного метода в параметре force_payment_method —
bancontact
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробная информация представлена в разделе Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Bancontact должен содержать идентификаторы проекта, пользователя и платежа, а также сумму и валюту платежа и подпись. Также рекомендуется указать фамилию пользователя:
{ project_id: 211, payment_id: 'X03936', payment_currency: 'EUR', payment_amount: 1000, customer_id: '123', customer_last_name: 'Johnson', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KURLCvhtT4DqtOcZzUCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода Bancontact используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 211
была успешно проведена оплата в размере 10,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 211, "payment": { "id": "ECT_TEST_1562051806691899", "type": "purchase", "status": "success", "date": "2019-07-02T09:28:29+0000", "method": "bancontact", "sum": { "amount": 1000, "currency": "EUR" }, "description": "ECT_TEST_1562051806691810" }, "customer": { "last_name": "Johnson" }, "operation": { "id": 37493000003351, "type": "sale", "status": "success", "date": "2019-07-02T09:28:29+0000", "created_date": "2019-07-02T09:28:24+0000", "request_id": "7e08d48c4f5da3692b65e5426f44ed36896e569c", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "provider": { "id": 1241, "payment_id": "", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "e7wGQAoo1wKMPwsJVCg4zqvlPHA/Hui8XhpAH3AqwpWiZVR83hnRnYsIZ84g==" }
В следующем примере оплата была отклонена из-за нарушения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 211, "payment": { "id": "ECT_TEST_1562051806691810", "type": "purchase", "status": "decline", "date": "2019-07-02T09:28:29+0000", "method": "bancontact", "sum": { "amount": 50, "currency": "EUR" }, }, "customer": { "last_name": "Johnson" }, "operation": { "id": 37493000003351, "type": "sale", "status": "decline", "date": "2019-07-02T09:28:29+0000", "created_date": "2019-07-02T09:28:24+0000", "request_id": "7e08d48c4f5da3692b65e5426f44ed36896e569c", "sum_initial": { "amount": 50, "currency": "EUR" }, "sum_converted": { "amount": 50, "currency": "EUR" }, "provider": { "id": 1241, "payment_id": "", "auth_code": "" }, "code": "20101", "message": "Decline due to amount or frequency limit" }, "signature": "e7wGQAoo1wKMPwsJVCg4zqvlPHA/Hui8XhpAH3AqwpWiZVR83hnRnYsIZ84g==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Bancontact со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить перенаправление пользователя в сервис Bancontact.
- Принять оповещение от платежной платформы ecommpay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через Bancontact.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ecommpay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробная информация представлена в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Bancontact.
- На стороне Bancontact выполняется обработка запроса на оплату.
- От сервиса Bancontact к платёжной платформе передаются данные для перенаправления пользователя на сайт Bancontact.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в Bancontact в объекте redirect_data.
- Пользователь перенаправляется в сервис Bancontact.
- Пользователь выполняет необходимые действия для оплаты. Если сумма платежа меньше 500,00 EUR, то пользователю, помимо полей для ввода данных платёжной карты Bancontact, отображается QR-код для сканирования с использованием мобильного приложения Bancontact. Пользователь может выбрать один из упомянутых вариантов для совершения оплаты. Если сумма платежа больше 500,00 EUR, то пользователю не отображается QR-код и оплата не может быть совершена с использованием мобильного приложения.
- На стороне сервиса Bancontact выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса Bancontact к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом Bancontact через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API представлена в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Bancontact необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bancontact/sale
, отправляемый методом POST. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — сведения о платеже:
- amount — сумма платежа в дробных единицах;
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор в рамках проекта,
- ip_address — используемый IP-адрес;
- last_name — фамилия (для предотвращения ошибок при проведении платежей рекомендуется указывать не менее 3 и не более 100 символов). Если параметр не указан в запросе, то он дополнительно запрашивается в оповещении о необходимости дополнить данные (подробнее — в разделе Дополнение информации о платеже);
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- return — URL для перенаправления пользователя по нажатию кнопки на любом шаге оплаты.
- general — объект, содержащий основные идентификационные сведения о запросе:
- Валютой платежа может быть только EUR.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Bancontact должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, данные пользователя и URL для перенаправления.
Рис.: Пример запроса на оплату
{ "general": { "project_id": 211, "payment_id": "payment_id", "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 1000, "currency": "EUR" }, "customer": { "last_name": "Johnson", "id": "123", "ip_address": "1.1.1.1" }, "return_url": { "return": "http://example.com/return" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Bancontact необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": {
"body": [],
"method": "GET",
"url": "https://bancontact.girogate.be/bi/t0bc?tx=example
Формат оповещений
Для оповещений о результатах оплат с применением метода Bancontact используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 211
была успешно проведена оплата в размере 10,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 211, "payment": { "id": "ECT_TEST_1562051806691899", "type": "purchase", "status": "success", "date": "2019-07-02T09:28:29+0000", "method": "bancontact", "sum": { "amount": 1000, "currency": "EUR" }, "description": "ECT_TEST_1562051806691810" }, "customer": {, "last_name: "Johnson" }, "operation": { "id": 37493000003351, "type": "sale", "status": "success", "date": "2019-07-02T09:28:29+0000", "created_date": "2019-07-02T09:28:24+0000", "request_id": "7e08d48c4f5da3692b65e5426f44ed36896e569c", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "provider": { "id": 1241, "payment_id": "", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "e7wGQAoo1wKMPwsJVCg4zqvlPHA/Hui8XhpAH3AqwpWiZVR83hnRnYsIZ84g==" }
В следующем примере оплата была отклонена из-за нарушения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 211, "payment": { "id": "ECT_TEST_1562051806691810", "type": "purchase", "status": "decline", "date": "2019-07-02T09:28:29+0000", "method": "bancontact", "sum": { "amount": 50, "currency": "EUR" }, }, "customer": { "last_name: "Johnson" }, "operation": { "id": 37493000003351, "type": "sale", "status": "decline", "date": "2019-07-02T09:28:29+0000", "created_date": "2019-07-02T09:28:24+0000", "request_id": "7e08d48c4f5da3692b65e5426f44ed36896e569c", "sum_initial": { "amount": 50, "currency": "EUR" }, "sum_converted": { "amount": 50, "currency": "EUR" }, "provider": { "id": 1241, "payment_id": "", "auth_code": "" }, "code": "20101", "message": "Decline due to amount or frequency limit" }, "signature": "e7wGQAoo1wKMPwsJVCg4zqvlPHA/Hui8XhpAH3AqwpWiZVR83hnRnYsIZ84g==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
Bancontact поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода Bancontact со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь запрашивает возврат в веб-сервисе.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение возврата через Gate.
- Gate перенаправляет запрос в платёжную платформу ecommpay для дальнейшей обработки.
- На стороне платёжной платформы ecommpay выполняются необходимые проверка и первичная обработка запроса.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробная информация представлена в разделе Формат ответа.
- Обработанный запрос передаётся в сервис Bancontact.
- На стороне Bancontact выполняется обработка платежа.
- От Bancontact к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат возврата (в соответствии с порядком работы веб-сервиса).
Информация о формате запросов и параметрах инициации возвратов методом Bancontact через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API — в разделе Работа с API.
Формат запросов
При работе с запросами на возврат с применением метода Bancontact необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bancontact/refund
, отправляемый методом POST. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о возврате:
- description — комментарий или описание возврата;
- amount — сумма возврата в дробных единицах валюты (обязательный при частичном возврате);
- currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате);
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес.
- general — объект, содержащий основные идентификационные сведения о запросе:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на частичный возврат с применением метода Bancontact должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, описание возврата и IP-адрес пользователя:
Рис.: Пример запроса на частичный возврат
"general": {
"project_id": 211,
"payment_id": "refund_02",
"signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
},
"payment": {
"amount": 1000,
"currency": "EUR",
"description": "refund"
},
"customer": {
"ip_address": "1.1.1.1"
}
Формат оповещений
Для оповещений о результатах возврата с применением метода Bancontact используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 211
для пользователя был успешно проведён возврат в размере 10,00 EUR
на счёт № 035209875690435
.
Рис.: Пример оповещения о проведении возврата
{
"project_id": 211,
"payment": {
"id": "refund_02",
"type": "purchase",
"status": "refunded",
"date": "2019-02-19T14:25:25+0000",
"method": "bancontact",
"sum": {
"amount": 1000,
"currency": "EUR"
},
"description": "test_02"
},
"account": {
"number": "035209875690435"
},
"operation": {
"id": 14153000003282,
"type": "refund",
"status": "success",
"date": "2019-02-19T14:25:25+0000",
"created_date": "2019-02-19T14:25:24+0000",
"request_id": "9d11b2ca618ec3ba0f588af8af3c4fc9f5fa58f174",
"sum_initial": {
"amount": 1000,
"currency": "EUR"
},
"sum_converted": {
"amount": 1000,
"currency": "EUR"
},
"provider": {
"id": 1169,
"payment_id": "105887607",
"date": "2019-02-19T14:25:24+0000",
"auth_code": ""
},
"code": "0",
"message": "Success"
},
"signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
}
В следующем примере возврат был отклонён так как сумма в запросе на возврат больше суммы оплаты.
Рис.: Пример оповещения об отказе в проведении возврата
{ "project_id": 211, "payment": { "id": "refund_02", "type": "purchase", "status": "success", "date": "2019-02-19T14:25:25+0000", "method": "bancontact", "sum": { "amount": 100000, "currency": "EUR" }, "description": "test_02" }, "account": { "number": "035209875690435" }, "operation": { "id": 14153000003282, "type": "refund", "status": "decline", "date": "2019-02-19T14:25:25+0000", "created_date": "2019-02-19T14:25:24+0000", "request_id": "9d11b2ca618ec3ba0f588af8af3c4fc9f5fa58f174", "sum_initial": { "amount": 100000, "currency": "EUR" }, "sum_converted": { "amount": 100000, "currency": "EUR" }, "provider": { "id": 1169, "payment_id": "105887607", "date": "2019-02-19T14:25:24+0000", "auth_code": "" }, "code": "3283", "message": "Refund amount more than init amount" }, "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода Bancontact доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.