«Платежи с использованием карт через партнёра (Индия)»
Обзор
Платёжный метод, который позволяет проводить оплаты и возвраты с использованием платёжных карт через сервис партнёра. Оплаты осуществляются через Payment Page и Gate, возвраты — через Gate.
Характеристика
Тип платёжного метода | платежи с использованием карт через партнёра |
---|---|
Регионы использования | IN |
Валюты платежей | INR |
Конвертация валют | на стороне ECommPay * |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | – |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
* Более подробную информацию необходимо уточнять у курирующего менеджера ECommPay.
Схема работы
В проведении отдельного платежа с использованием данного метода задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства партнёра.
Основные операции
Интерфейсы | Суммы, INR | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | |
Оплаты | + | – | + | – | 1,00 | 400 000,00 |
Полные возвраты | – | – | + | – | – | – |
Сценарии использования
Проведение оплат с использованием метода выполняется с перенаправлением пользователей к сервису партнёра, проведение возвратов — с заявкой от пользователей через веб-сервис мерчанта.
Рис.: Оплата через 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 — сумма платежа в минорных единицах;
- customer_id — идентификатор пользователя в рамках проекта.
- Валютой платежа может быть только INR.
- Для предварительного выбора метода необходимо указать код платёжного метода в параметре force_payment_method —
card-partner
и передать кодcard-debit
в параметреpayment_extra_param
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробная информация представлена в разделе Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода должен содержать идентификаторы проекта, пользователя и платежа, валюту и сумму платежа, а также подпись:
{ project_id: 101, payment_id: 'X03936' payment_currency: 'INR', payment_amount: 1000, customer_id: 'customer1', signature: "kUi2x9dKHAVNU0xh4yo+52Kt8KU\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 101
была успешно проведена оплата в размере 10,00 INR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 101, "payment": { "id": "ECT_TEST_1573806126471", "type": "purchase", "status": "success", "date": "2019-11-15T08:53:26+0000", "method": "Card partner", "sum": { "amount": 1000, "currency": "INR" }, "description": "" }, "customer": { "phone": "7999999999" }, "operation": { "id": 123, "type": "sale", "status": "success", "date": "2019-11-15T08:53:26+0000", "created_date": "2019-11-15T08:51:59+0000", "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938", "sum_initial": { "amount": 1000, "currency": "INR" }, "sum_converted": { "amount": 1000, "currency": "INR" }, "code": "0", "message": "Success", "provider": { "id": 1, "payment_id": "3", "auth_code": "", "date": "2019-11-15T14:23:16+0000" } }, "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg==" }
В следующем примере оплата была отклонена из-за превышения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 101, "payment": { "id": "ECT_TEST_1573806126471", "type": "purchase", "status": "decline", "date": "2019-11-15T08:53:26+0000", "method": "Card partner", "sum": { "amount": 300000000, "currency": "INR" }, "description": "" }, "customer": { "phone": "7999999999" }, "operation": { "id": 123, "type": "sale", "status": "decline", "date": "2019-11-15T08:53:26+0000", "created_date": "2019-11-15T08:51:59+0000", "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938", "sum_initial": { "amount": 300000000, "currency": "INR" }, "sum_converted": { "amount": 300000000, "currency": "INR" }, "code": "20101", "message": "Decline due to amount or frequency limit", "provider": { "id": 1, "payment_id": "3", "auth_code": "", "date": "2019-11-15T14:23:16+0000" } }, "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg==" }
Дополнительные материалы
Для организации работы с оплатами через 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 — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Работа с подписью к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах валюты;
- currency — валюта платежа в формате ISO-4217 alpha-3;
- extra_param — для оплаты с использованием данного метода необходимо передать код
card-debit
;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта;
- ip_address — IP-адрес;
- first_name — имя;
- last_name — фамилия;
- phone — номер телефона;
- email — адрес электронной почты;
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- success — URL для перенаправления пользователя после успешно проведённого платежа.
- general — объект, содержащий основные идентификационные сведения запроса:
- Валютой платежа может быть только INR.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением данного метода должен содержать идентификаторы проекта и платежа, подпись, валюту и сумму платежа, данные пользователя и URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 101, "payment_id": "ECP_TEST_15392667771145", "signature": "Uhka8CiYAlDlc2wRq60vlSmTTCb0Zp0KYV4NP64Pn2ja9u0filH8Z03Gr0wh8Q==" }, "payment": { "amount": 501, "currency": "INR", "extra_param": "card-debit" }, "customer": { "id": "customer123", "ip_address": "1.1.1.1", "first_name": "Mary", "last_name": "Smith", "phone": "76575657657676", "email": "smith@example.com" }, "return_url": { "success": "http://example.com/success" }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса партнёра необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data":{
"body":{ },
"method":"POST",
"url":"https://test.cashfree.com/billpay/order/example123"
}
Формат оповещений
Для оповещений о результатах оплат с применением данного метода используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 101
была успешно проведена оплата в размере 10,00 INR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 101, "payment": { "id": "ECT_TEST_1573806126471", "type": "purchase", "status": "success", "date": "2019-11-15T08:53:26+0000", "method": "Card partner", "sum": { "amount": 1000, "currency": "INR" }, "description": "" }, "customer": { "phone": "7999999999" }, "operation": { "id": 123, "type": "sale", "status": "success", "date": "2019-11-15T08:53:26+0000", "created_date": "2019-11-15T08:51:59+0000", "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938", "sum_initial": { "amount": 1000, "currency": "INR" }, "sum_converted": { "amount": 1000, "currency": "INR" }, "code": "0", "message": "Success", "provider": { "id": 1, "payment_id": "3", "auth_code": "", "date": "2019-11-15T14:23:16+0000" } }, "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg==" }
В следующем примере оплата была отклонена из-за превышения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 101, "payment": { "id": "ECT_TEST_1573806126471", "type": "purchase", "status": "decline", "date": "2019-11-15T08:53:26+0000", "method": "Card partner", "sum": { "amount": 300000000, "currency": "INR" }, "description": "" }, "customer": { "phone": "7999999999" }, "operation": { "id": 123, "type": "sale", "status": "decline", "date": "2019-11-15T08:53:26+0000", "created_date": "2019-11-15T08:51:59+0000", "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938", "sum_initial": { "amount": 300000000, "currency": "INR" }, "sum_converted": { "amount": 300000000, "currency": "INR" }, "code": "20101", "message": "Decline due to amount or frequency limit", "provider": { "id": 1, "payment_id": "3", "auth_code": "", "date": "2019-11-15T14:23:16+0000" } }, "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
Данный метод поддерживает проведение полных возвратов. Для проведения возврата через Gate со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь запрашивает возврат.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение возврата через Gate.
- Gate перенаправляет запрос в платёжную платформу ECommPay для дальнейшей обработки.
- На стороне платёжной платформы ECommPay выполняются необходимые проверка и первичная обработка запроса.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробная информация представлена в разделе Формат ответа.
- Обработанный запрос передаётся в сервис партнёра.
- На стороне партнёра выполняется обработка платежа.
- От партнёра к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат возврата (в соответствии с порядком работы веб-сервиса).
Информация о формате запросов и параметрах инициации возвратов данным методом через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API представлена в разделе Работа с API.
Формат запросов
При работе с запросами на возврат с применением данного метода необходимо учитывать следующее:
- Должен использоваться запрос v2/payment/card-partner/refund, отправляемый методом POST.
- В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Работа с подписью к данным);
- payment — объект, содержащий сведения о возврате:
- description — комментарий или описание возврата.
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением данного метода должен содержать идентификаторы проекта и платежа, подпись и описание возврата:
Рис.: Пример запроса на возврат
{
"general": {
"project_id": 101,
"payment_id": "ECT_TEST_1572258898441234343232",
"signature": "NUpXRpdrU/rRcwEa/jQYoYbXA/YIc/dgeuncPmD/BJZGZvt59GbTSAUKHI/WrQ=="
},
"payment": {
"description":"test_refund"
}
Формат оповещений
Для оповещений о результатах возврата с применением данного метода используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 197
был успешно проведён возврат в размере 350,00 INR
.
Рис.: Пример оповещения о проведении возврата
{ "project_id": 197, "payment": { "id": "TEST_554862", "type": "purchase", "status": "refunded", "date": "2020-09-09T10:02:18+0000", "method": "Card partner", "sum": { "amount": 0, "currency": "INR" }, "merchant_refund_id": "TEST_554862", "description": "TEST_554862" }, "customer": { "id": "1", "phone": "1234567890" }, "operation": { "id": 90266010010271, "type": "refund", "status": "success", "date": "2020-09-09T10:02:18+0000", "created_date": "2020-09-09T09:46:14+0000", "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090267", "sum_initial": { "amount": 35000, "currency": "INR" }, "sum_converted": { "amount": 35000, "currency": "INR" }, "code": "0", "message": "Success", "provider": { "id": 1751, "payment_id": "4952688", "auth_code": "" } }, "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g==" }
В следующем примере возврат был отклонён, так как значение суммы в запросе на возврат больше суммы в первоначальной оплате.
Рис.: Пример оповещения об отказе в проведении возврата
{ "project_id": 197, "payment": { "id": "TEST_554863", "type": "purchase", "status": "success", "date": "2020-09-09T10:02:18+0000", "method": "Card partner", "sum": { "amount": 35000, "currency": "INR" }, "merchant_refund_id": "TEST_554863", "description": "TEST_554863" }, "customer": { "id": "1", "phone": "1234567890" }, "operation": { "id": 90266010010272, "type": "refund", "status": "decline", "date": "2020-09-09T10:02:18+0000", "created_date": "2020-09-09T09:46:14+0000", "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090268", "sum_initial": { "amount": 35000, "currency": "INR" }, "sum_converted": { "amount": 35000, "currency": "INR" }, "code": "3283", "message": "Refund amount more than init amount" } }, "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g==" }
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода партнёра доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.