«Платежи с использованием карт через партнёра (РФ)»
Обзор
Платёжный метод, который позволяет проводить оплаты и выплаты с использованием платёжных карт через сервис партнёра. Оплаты осуществляются через Payment Page и Gate, выплаты — через Gate.
Характеристика
Тип платёжного метода | платежи с использованием карт через партнёра |
---|---|
Регионы использования | RU |
Валюты платежей | RUB |
Конвертация валют | – |
Оплаты | + |
Выплаты | + |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | Проведение выплат через сервис партнёра аналогично проведению выплат с использованием платёжных карт |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием данного метода задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства партнёра.
Основные операции
Интерфейсы | Суммы, RUB | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | |
Оплаты | + | – | + | – | * | * |
Выплаты | – | – | + | – | * | * |
* Информацию об ограничениях сумм необходимо уточнять у курирующего менеджера ECommPay.
Сценарии использования
Проведение оплат с использованием метода выполняется с перенаправлением пользователей к сервису партнёра, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Выплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием данного метода со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает для оплаты платёжный метод.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис партнёра.
- На стороне партнёра выполняется обработка запроса на оплату.
- От сервиса партнёра к платёжной платформе передаются данные для перенаправления пользователя в сервис партнёра.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис партнёра.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса партнёра выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе партнёра.
- Пользователь перенаправляется к Payment Page.
- От сервиса партнёра к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с данным методом, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции.
- payment_id — идентификатор платежа, уникальный в рамках проекта.
- payment_currency — валюта платежа в формате ISO-4217 alpha-3.
- payment_amount — сумма платежа в дробных единицах.
Для работы с некоторыми партнёрами необходимо округлять суммы до целых чисел, и решения о порядке округления должны приниматься на стороне мерчанта. Например, для суммы 100,05 (RUB) могут быть переданы как
10000
, так и10100
. За более подробной информацией следует обращаться к курирующему менеджеру ECommPay. - customer_id — идентификатор пользователя уникальный в рамках проекта.
- Валютой платежа может быть только RUB.
- Для предварительного выбора метода необходимо указать код платёжного метода в параметре force_payment_method —
card-partner
и передать один из кодов в параметреpayment_extra_param
(в зависимости от партнёра, обрабатывающего платёж) —mobi-card
илиp2p
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода должен содержать идентификаторы проекта и платежа, а также валюту и сумму платежа и подпись:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 10000, payment_currency: 'RUB', project_id: 250, customer_id: 'customer1', signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода используется стандартный формат, описание которого представлено в разделе Оповещения.
В зависимости от партнёра, обрабатывающего платёж, номер карты пользователя передаётся в параметре number
объекта account
.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 874
от пользователя customer_10
была успешно проведена оплата в размере 100,00 RUB
с карты 553691******0802
.
Рис.: Пример оповещения о проведенной оплаты
{ { "project_id": 874, "payment": { "id": "3013", "type": "purchase", "status": "success", "date": "2019-06-24T11:08:49+0000", "method": "Card partner", "sum": { "amount": 10000, "currency": "RUB" }, "description": "sale" }, "account": { "number": "553691******0802" // передаётся в зависимости от партнёра }, "customer": { "id": "customer_10" }, "operation": { "id": 14, "type": "sale", "status": "success", "date": "2019-06-24T11:08:49+0000", "created_date": "2019-06-24T11:07:42+0000", "request_id": "71228f54d21e776a481", "sum_initial": { "amount": 10000, "currency": "RUB" }, "sum_converted": { "amount": 10000, "currency": "RUB" }, "provider": { "id": 1496, "payment_id": "60-1c6072de6000", "date": "2019-06-24T11:08:47+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "+GTEzb3Xw4A9Ap8q/LE8TyyJM+MEXXja28RXtr8v2EITaK4UzSgifLxgB6c9TSeb/peLxw==" } }
В следующем примере оплата была отклонена из-за неподдерживаемой валюты платежа.
Рис.: Пример оповещения об отказе в проведении оплаты
{ { "project_id": 874, "payment": { "id": "3014", "type": "purchase", "status": "decline", "date": "2019-06-24T11:12:34+0000", "method": "Card partner", "sum": { "amount": 1000, "currency": "EUR" }, "description": "sale" }, "customer": { "id": "customer_10" }, "operation": { "id": 2000000013, "type": "sale", "status": "decline", "date": "2019-06-24T11:12:35+0000", "created_date": "2019-06-24T11:11:57+0000", "request_id": "10b3228392a76024", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "provider": { "id": 1496, "payment_id": "8a14-4da680069d1e", "date": "2019-06-24T11:12:33+0000", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "gExJfJirZithIopm68xkJAty50SAH1F3u/wqC1geqM9N9hO0DLej2pJJm8kZZo6ZfGxrWw==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис партнёра.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через партнёра.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис партнёра.
- На стороне партнёра выполняется обработка запроса на оплату.
- От сервиса партнёра к платёжной платформе передаются данные для перенаправления пользователя на сайт партнёра.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в сервис партнёра в объекте redirect_data.
- Пользователь перенаправляется в сервис партнёра.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса партнёра выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса партнёра к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода необходимо учитывать следующее:
- Должен использоваться запрос v2/payment/card-partner/sale, отправляемый методом POST.
- В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- id — идентификатор,
- ip_address — используемый IP-адрес;
- payment — сведения о платеже:
- amount — сумма платежа в дробных единицах.
Для работы с некоторыми партнёрами необходимо округлять суммы до целых чисел, и решения о порядке округления должны приниматься на стороне мерчанта. Например, для суммы 100,05 (RUB) могут быть переданы как
10000
, так и10100
. За более подробной информацией следует обращаться к курирующему менеджеру ECommPay. - currency — валюта платежа в формате ISO-4217 alpha-3.
- extra_param — дополнительный параметр. Для оплаты необходимо передать один из следующих кодов (в зависимости от партнёра, обрабатывающего платёж):
mobi-card
илиp2p
.
- amount — сумма платежа в дробных единицах.
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- return * — URL сайта для возврата на любом шаге проведения платежа.
Прим.: * Необходимость использования данного параметра следует уточнять у курирующего менеджера ECommPay.
- general — основные сведения:
- Валютой платежа может быть только RUB.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа, а так же URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 874, "payment_id": "561719496", "signature": "fCkXYCxiTjiN9AkFvEZCpbe/a+wKKMv4i4BmNB2sVcrW0r3wcXQggExZHbeXH/VPAMbywQ==" }, "customer": { "id": "customer_test", "ip_address": "1.2.3.4" }, "payment": { "amount": 1000, "currency": "RUB", "extra_param": "mobi-card" }, "return_url": { "return": "http://example.com/return" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса партнёра необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data":{
"body":{ },
"method":"GET",
"url":"http://pay\/start\/50caac72-3607-34ba-a2ea-94c0ac708f31"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода партнёра используется стандартный формат, описание которого представлено в разделе Оповещения.
В зависимости от партнёра, обрабатывающего платёж, номер карты пользователя передаётся в параметре number
объекта account
.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 874
от пользователя customer_10
была успешно проведена оплата в размере 100,00 RUB
с карты 553691******0802
.
Рис.: Пример оповещения о проведенной оплаты
{ { "project_id": 874, "payment": { "id": "3013", "type": "purchase", "status": "success", "date": "2019-06-24T11:08:49+0000", "method": "Card partner", "sum": { "amount": 10000, "currency": "RUB" }, "description": "sale" }, "account": { "number": "553691******0802" // передаётся в зависимости от партнёра }, "customer": { "id": "customer_10" }, "operation": { "id": 14, "type": "sale", "status": "success", "date": "2019-06-24T11:08:49+0000", "created_date": "2019-06-24T11:07:42+0000", "request_id": "71228f54d21e776a481", "sum_initial": { "amount": 10000, "currency": "RUB" }, "sum_converted": { "amount": 10000, "currency": "RUB" }, "provider": { "id": 1496, "payment_id": "60-1c6072de6000", "date": "2019-06-24T11:08:47+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "+GTEzb3Xw4A9Ap8q/LE8TyyJM+MEXXja28RXtr8v2EITaK4UzSgifLxgB6c9TSeb/peLxw==" } }
В следующем примере оплата была отклонена из-за неподдерживаемой валюты платежа.
Рис.: Пример оповещения об отказе в проведении оплаты
{ { "project_id": 874, "payment": { "id": "3014", "type": "purchase", "status": "decline", "date": "2019-06-24T11:12:34+0000", "method": "Card partner", "sum": { "amount": 1000, "currency": "EUR" }, "description": "sale" }, "customer": { "id": "customer_10" }, "operation": { "id": 2000000013, "type": "sale", "status": "decline", "date": "2019-06-24T11:12:35+0000", "created_date": "2019-06-24T11:11:57+0000", "request_id": "10b3228392a76024", "sum_initial": { "amount": 1000, "currency": "EUR" }, "sum_converted": { "amount": 1000, "currency": "EUR" }, "provider": { "id": 1496, "payment_id": "8a14-4da680069d1e", "date": "2019-06-24T11:12:33+0000", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "gExJfJirZithIopm68xkJAty50SAH1F3u/wqC1geqM9N9hO0DLej2pJJm8kZZo6ZfGxrWw==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Выплаты через Gate
Общая информация
Для выплаты через Gate с использованием данного метода со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.
Рис.: Проведение выплаты через Gate
- Пользователь на стороне веб-сервиса инициирует выплату через партнёра.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
- Запрос на проведение выплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис партнёра.
- На стороне партнёра выполняется обработка платежа.
- От партнёра к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат выплаты.
Подробная информация о формате запросов и параметрах инициации выплат через Gate, а также о формате оповещений о результатах выплат приведена в разделе Выплаты, общую информацию о работе с API см. в разделе Работа с API.
Дополнительные материалы
Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода партнёра доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.