Przelewy24
Обзор
Przelewy24 — альтернативный платёжный метод для проведения оплат и возвратов с использованием интернет-банкинга на территории Польши. Оплаты осуществляются через Payment Page и Gate, возвраты — через Gate.
Характеристика
Тип платёжного метода | банковские платежи |
---|---|
Платёжные инструменты |
|
Регионы использования | PL |
Валюты платежей | PLN, EUR |
Конвертация валют | На стороне ecommpay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | По согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием Przelewy24 задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также сервис Przelewy24, который обеспечивает проведение платежей с участием банков.
Основные операции
Интерфейсы | Суммы, EUR/PLN | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | |
Оплаты | + | – | + | – | 1,00 | 55 000,00 |
Полные возвраты | – | – | + | – | – | – |
Частичные возвраты | – | – | + | – | – | – |
Сценарии использования
Проведение оплат с использованием метода Przelewy24 выполняется с перенаправлением пользователей к сервису Przelewy24, проведение возвратов — с заявкой от пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Przelewy24 со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Przelewy24 можно делать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на открытие Payment Page.
- Запрос на открытие Payment Page поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает платёжный метод Przelewy24.
- Запрос на проведение оплаты через сервис Przelewy24 поступает в платёжную платформу.
- Запрос на проведение оплаты перенаправляется в сервис Przelewy24.
- Выполняются дальнейшая обработка запроса на стороне Przelewy24.
- От сервиса Przelewy24 к платёжной платформе передаются данные для перенаправления пользователя к форме оплаты.
- Данные для перенаправления пользователя к форме оплаты передаются в Payment Page.
- Пользователь перенаправляется к форме оплаты Przelewy24.
- Пользователь выбирает банк для оплаты, подтверждает оплату и перенаправляется на страницу ожидания результата.
- На стороне Przelewy24 выполняется обработка платежа.
- Пользователю в сервисе отображается результат оплаты.
- Пользователь возвращается в Payment Page на страницу с результатом.
- От сервиса Przelewy24 к платёжной платформе ecommpay направляется уведомление о результате платежа.
- От платёжной платформы к веб-сервису направляется оповещение о результате платежа.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Przelewy24, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в отдельном разделе.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Przelewy24 необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Валютой платежа может быть PLN или EUR.
- Для открытия Payment Page необходимо передать код языка платёжной формы в параметре language_code. Подробнее см. в Управление языком платёжной формы.
- Дополнительно должны использоваться параметры:
- customer_email — электронный адрес пользователя,
- customer_first_name — имя пользователя,
- customer_last_name — фамилия пользователя.
- Для предварительного выбора метода Przelewy24 необходимо указывать код платёжного метода в параметре force_payment_method —
przelewy24
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Przelewy24 должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, а также валюту и сумму платежа:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 10000, payment_currency: 'PLN', project_id: 239, language_code: en, customer_id: 'customer1', customer_email: 'example@gmail.com', customer_first_name: 'John', customer_last_name: 'Johnson', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU\/RLCvhtT4DqtVUkDJrOcZCwX6R\/ekpZhkIQg==" } )
Детальная информация обо всех указанных параметрах приведена в отдельном разделе.
Формат оповещений
Для оповещений о результатах оплат с применением метода Przelewy24 используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
была успешно проведена оплата в размере 100,00 PLN
со счёта № 2626324568
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 238, "payment": { "id": "test_Sofort_02", "type": "purchase", "status": "success", "date": "2019-02-19T14:25:25+0000", "method": "przelewy24", "sum": { "amount": 10000, "currency": "PLN" }, "description": "payment_02" }, "account": { "number": "2626324568" }, "operation": { "id": 14153000003282, "type": "sale", "status": "success", "date": "2019-02-19T14:25:25+0000", "created_date": "2019-02-19T14:25:24+0000", "request_id": "9d11b2ca618ec3bad2913b488" "amount": 10000, "currency": "PLN" }, "sum_converted": { "amount": 10000, "currency": "PLN" }, "provider": { "id": 1169, "payment_id": "105887607", "date": "2019-02-19T14:25:24+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "of8k9xerKSKpFBR4XL1QFaDRbOmstt9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }
В следующем примере оплата была отклонена из-за того, что сумма оплаты меньше установленного лимита.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 238, "payment": { "id": "TEST_154996862174000", "type": "purchase", "status": "decline", "date": "2019-02-12T10:56:22+0000", "method": "przelewy24", "sum": { "amount": 100, "currency": "PLN" }, "description": "TEST_154996862174000" }, "customer": { "id": "1" }, "operation": { "id": 9172000003183, "type": "sale", "status": "decline", "date": "2019-02-12T10:56:22+0000", "created_date": "2019-02-12T10:56:18+0000", "request_id": "11d4aabf869cb74c0681927ad7", "sum_initial": { "amount": 100, "currency": "PLN" }, "sum_converted": { "amount": 100, "currency": "PLN" }, "provider": { "id": 1169, "payment_id": "", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "dfgfds1oVdS/mE0AlVOUDbbNqlXO/+e0Vt05S8vyeI14MBiRz0yJRrqn7HiBOEIObz2tN5SLw==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Przelewy24 со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить перенаправление пользователя в сервис Przelewy24.
- Принять оповещение о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через один из банков, поддерживающих работу с методом Przelewy24.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Przelewy24.
- На стороне Przelewy24 выполняется обработка запроса на оплату.
- От сервиса Przelewy24 к платёжной платформе передаются данные для перенаправления пользователя в сервис Przelewy24.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в объекте redirect_data.
- Пользователь перенаправляется в сервис Przelewy24.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Przelewy24 выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса Przelewy24 к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициирования оплат через Gate при работе с методом Przelewy24, а также о форматах данных для перенаправления пользователей и о формате оповещений о результатах оплат приведена далее; общая информация о работе с API — в разделе Работа с API.
Формат запросов
При формировании запросов на оплату с применением метода Przelewy24 необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/przelewy24/sale
, отправляемый методом POST. Этот запрос относится к группе запросов через интернет-банкинг /v2/payment/online-banking/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — используемый IP-адрес,
- email — адрес электронной почты (если не передан, то может быть запрошен через уточнение параметров),
- first_name — имя (если не передан, то может быть запрошен через уточнение параметров),
- last_name — фамилия (если не передан, то может быть запрошен через уточнение параметров);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в дробных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- return_url — URL для возврата пользователя с сайта банка:
- return — URL сайта для возврата.
- general — объект, содержащий основные идентификационные сведения запроса:
- Валютой платежа может быть PLN или EUR.
- Дополнительно могут использоваться любые другие параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Przelewy24 должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, данные пользователя и URL для перенаправления:
Рис.: Пример запроса на оплату через Gate
{ "general": { "project_id": 2990, "payment_id": "payment_id", "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA==" }, "customer": { "ip_address": "1.1.1.1", "last_name": "Johnson", "first_name": "John", "email": "example@mail.com", "id": "customer123" }, "payment": { "amount": 1000, "currency": "EUR" }, "return_url": { "return": "http://example.com" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса в сервис Przelewy24 необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы методом, указанным в redirect_data.method.
Далее приведён фрагмент примера оповещения, содержащего данные для перенаправления.
"redirect_data": {
"body": [],
"method": "GET",
"url": "https://p24.de/p24?tx=421417103&rs=uv333db1260e2"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода Przelewy24 используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
была успешно проведена оплата в размере 100,00 PLN
со счёта № 2626324568
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 238, "payment": { "id": "test_Sofort_02", "type": "purchase", "status": "success", "date": "2019-02-19T14:25:25+0000", "method": "przelewy24", "sum": { "amount": 10000, "currency": "PLN" }, "description": "payment_02" }, "account": { "number": "2626324568" }, "operation": { "id": 14153000003282, "type": "sale", "status": "success", "date": "2019-02-19T14:25:25+0000", "created_date": "2019-02-19T14:25:24+0000", "request_id": "9d11b2ca618ec3bad2913b488" "amount": 10000, "currency": "PLN" }, "sum_converted": { "amount": 10000, "currency": "PLN" }, "provider": { "id": 1169, "payment_id": "105887607", "date": "2019-02-19T14:25:24+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "of8k9xerKSKpFBR4XL1QFaDRbOmstt9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }
В следующем примере оплата была отклонена из-за того, что сумма оплаты меньше установленного лимита.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 238, "payment": { "id": "TEST_154996862174000", "type": "purchase", "status": "decline", "date": "2019-02-12T10:56:22+0000", "method": "przelewy24", "sum": { "amount": 100, "currency": "PLN" }, "description": "TEST_154996862174000" }, "customer": { "id": "1" }, "operation": { "id": 9172000003183, "type": "sale", "status": "decline", "date": "2019-02-12T10:56:22+0000", "created_date": "2019-02-12T10:56:18+0000", "request_id": "11d4aabf869cb74c0681927ad7", "sum_initial": { "amount": 100, "currency": "PLN" }, "sum_converted": { "amount": 100, "currency": "PLN" }, "provider": { "id": 1169, "payment_id": "", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "dfgfds1oVdS/mE0AlVOUDbbNqlXO/+e0Vt05S8vyeI14MBiRz0yJRrqn7HiBOEIObz2tN5SLw==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
Przelewy24 поддерживает проведение полных и частичных возвратов через Gate следующим способом: со стороны веб-сервиса мерчанта необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay, и принять оповещение о результате платежа. Полная схема проведения возврата представлена далее.
Рис.: Схема проведения возврата через Gate
- Пользователь запрашивает возврат средств в веб-сервисе.
- От веб-сервиса мерчанта на заданный URL ecommpay передаётся запрос на проведение возврата через Gate.
- Gate перенаправляет запрос в платёжную платформу ecommpay для дальнейшей обработки.
- На стороне платёжной платформы ecommpay выполняются необходимые проверка и первичная обработка запроса.
- От платёжной платформы в веб-сервис передается ответ с результатом первичной обработки запроса. Подробнее см. в разделе Формат ответа.
- Обработанный запрос передается в сервис Przelewy24.
- На стороне Przelewy24 выполняется обработка платежа.
- От Przelewy24 к платёжной платформе ecommpay направляется оповещение о результате.
- От платёжной платформы ecommpay к веб-сервису направляется оповещение о результате.
- Пользователь получает информацию о поступлении запрошенных средств (в соответствии с порядком работы веб-сервиса).
Информация о формате запросов и параметрах инициирования возвратов методом Przelewy24 через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API — в отдельном разделе.
Формат запросов
При работе с запросами на возврат с применением метода Przelewy24 необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/przelewy24/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 — объект, содержащий основные идентификационные сведения о запросе:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода Przelewy24 должен содержать идентификаторы проекта и платежа, подпись и IP-адрес пользователя:
Рис.: Пример запроса на возврат
"general": { "project_id": 239, "payment_id": "refund_02", "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }, "customer": { "ip_address": "1.2.3.4" }, "payment": { "amount": 10000, "currency": "PLN", "description": "refund_02" }
Формат оповещений
Для оповещений о результатах возврата с применением метода Przelewy24 используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
для пользователя был успешно проведён возврат в размере 100,00 PLN
на счёт № 2626324568
.
Рис.: Пример оповещения о проведенном возврате
{
"project_id": 238,
"payment": {
"id": "refund_02",
"type": "purchase",
"status": "refunded",
"date": "2019-02-19T14:25:25+0000",
"method": "przelewy24",
"sum": {
"amount": 10000,
"currency": "PLN"
},
"description": "test_02"
},
"account": {
"number": "2626324568"
},
"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": 10000,
"currency": "PLN"
},
"sum_converted": {
"amount": 10000,
"currency": "PLN"
},
"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": 238,
"payment": {
"id": "refund_02",
"type": "purchase",
"status": "decline",
"date": "2019-02-19T14:25:25+0000",
"method": "przelewy24",
"sum": {
"amount": 100000,
"currency": "PLN"
},
"description": "test_02"
},
"account": {
"number": "2626324568"
},
"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": "PLN"
},
"sum_converted": {
"amount": 100000,
"currency": "PLN"
},
"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, при использовании метода Przelewy24 доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.