Airtel
Обзор
Airtel — метод для проведения платежей на территории Индии с использованием электронных кошельков. Оплаты осуществляются через Payment Page и Gate.
Характеристика
Тип платёжного метода | Платежи с использованием электронных кошельков |
---|---|
Регионы использования | IN |
Валюты платежей | INR |
Конвертация валют | на стороне ECommPay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием Airtel задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства провайдера.
Основные операции
Интерфейсы | Суммы, INR | Время* | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | 10,00 | 2 000,00 | – | – |
* Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.
Сценарии использования
Проведение оплат с использованием метода Airtel выполняется с перенаправлением пользователей к сервису провайдера.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Airtel со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Airtel можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает платёжный метод Airtel.
- Запрос на проведение оплаты через Airtel поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис Airtel.
- На стороне Airtel выполняется обработка запроса на оплату.
- От сервиса Airtel к платёжной платформе передаются данные для перенаправления пользователя в сервис Airtel.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис Airtel.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Airtel выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе Airtel.
- Пользователь перенаправляется к Payment Page.
- От сервиса Airtel к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Airtel, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Airtel необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах.
- customer_id — идентификатор пользователя в рамках проекта.
- Дополнительно должны использоваться параметры с данными пользователя:
- customer_email — адрес электронной почты,
- customer_phone — город проживания,
Если параметры не переданы в запросе на открытие, то данные запрашиваются у пользователя на Payment Page.
- Валютой платежа может быть только INR.
- Для предварительного выбора метода Airtel необходимо указывать код платёжного метода в параметре force_payment_method —
airtel-wallet
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в разделе Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Airtel должен содержать идентификаторы проекта и платежа, данные пользователя, валюту и сумму платежа и подпись:
EPayWidget.run( { project_id: 198, payment_id: '3936', payment_amount: 2500, payment_currency: 'INR', customer_id: 'customer1', customer_email: 'John@mail.com', customer_phone: '61213456754', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода Airtel используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 200
от пользователя была успешно проведена оплата в размере 25,00 INR
.
Рис.: Пример оповещения о проведенной оплаты
{ "project_id": 200, "payment": { "id": "TEST_Ref1215267492448813313", "type": "purchase", "status": "success", "date": "2019-09-03T10:58:10+0000", "method": "airtel-wallet", "sum": { "amount": 2500, "currency": "INR" }, "description": "TEST_Ref1215267492448813313" }, "customer": { "id": "12345", "phone": "31647812345" }, "operation": { "id": 49572000001893, "type": "sale", "status": "success", "date": "2019-09-03T10:58:10+0000", "created_date": "2019-09-03T09:43:12+0000", "request_id": "d2debda97843c0c", "sum_initial": { "amount": 2500, "currency": "INR" }, "sum_converted": { "amount": 2500, "currency": "INR" }, "provider": { "id": 2469, "payment_id": "fcccab5d465e", "date": "2019-09-03T09:43:50+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 200, "payment": { "id": "TEST_1567592437", "type": "purchase", "status": "decline", "date": "2019-09-06T07:41:03+0000", "method": "airtel-wallet", "sum": { "amount": 2500, "currency": "INR" }, "description": "TEST_156759437" }, "customer": { "id": "12345", "phone": "31647812345" }, "operation": { "id": 48853000002113, "type": "sale", "status": "decline", "date": "2019-09-06T07:41:03+0000", "created_date": "2019-09-06T07:25:26+0000", "request_id": "60a7b84844677185e", "sum_initial": { "amount": 2500, "currency": "INR" }, "sum_converted": { "amount": 2500, "currency": "INR" }, "provider": { "id": 2469, "payment_id": "" }, "code": "603", "message": "Auto decline" }, "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Airtel со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Принять оповещение с данными для перенаправления пользователя в сервис Airtel.
- Принять оповещение о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату методом Airtel.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Airtel.
- На стороне Airtel выполняется обработка запроса на оплату.
- От сервиса Airtel к платёжной платформе передаются данные для перенаправления пользователя в сервис Airtel.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в объекте
redirect_data
. - Пользователь перенаправляется в сервис Airtel.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Airtel выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса Airtel к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом Airtel через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Airtel необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/wallet/airtel/sale
, отправляемый методом POST. Этот запрос относится к группе запросов с помощью банковского перевода: /v2/payment/wallet/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- id — идентификатор пользователя на стороне веб-сервиса,
- ip_address — используемый IP-адрес,
- email — адрес электронной почты,
- phone — номер телефона;
- payment — сведения о платеже:
- amount — сумма в минорных единицах валюты,
- currency — валюта в формате ISO-4217 alpha-3;
- return_url — объект, содержащий URL для перенаправления пользователя после оплаты:
- return — URL для возврата пользователя в веб-сервис мерчанта во время или после оплаты.
- general — основные сведения:
- Валютой платежа может быть только INR.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Airtel должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа, а также URL для возврата пользователя в веб-сервис:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 200, "payment_id": "payment_id", "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...==" }, "customer": { "id": "12345", "ip_address": "1.1.1.1", "email": "Johnson@mail.com", "phone": "312567890" }, "payment": { "amount": 250, "currency": "USD" }, "return_url": { "return": "http://merchant.com/returnurl.asp" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса в сервис Airtel необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы методом, указанным в redirect_data.method.
Далее приведён фрагмент примера оповещения, содержащего данные для перенаправления.
"redirect_data": {
"body": [],
"method": "GET",
"url": "https://pay.com/collect/pay/M-ce2f-11e9-9f3e-9f869464802f?xtid=CATH-ST"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода Airtel используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 200
от пользователя была успешно проведена оплата в размере 25,00 INR
.
Рис.: Пример оповещения о проведенной оплаты
{ "project_id": 200, "payment": { "id": "TEST_Ref1215267492448813313", "type": "purchase", "status": "success", "date": "2019-09-03T10:58:10+0000", "method": "airtel-wallet", "sum": { "amount": 2500, "currency": "INR" }, "description": "TEST_Ref1215267492448813313" }, "customer": { "id": "12345", "phone": "31647812345" }, "operation": { "id": 49572000001893, "type": "sale", "status": "success", "date": "2019-09-03T10:58:10+0000", "created_date": "2019-09-03T09:43:12+0000", "request_id": "d2debda97843c0c", "sum_initial": { "amount": 2500, "currency": "INR" }, "sum_converted": { "amount": 2500, "currency": "INR" }, "provider": { "id": 2469, "payment_id": "fcccab5d465e", "date": "2019-09-03T09:43:50+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 200, "payment": { "id": "TEST_1567592437", "type": "purchase", "status": "decline", "date": "2019-09-06T07:41:03+0000", "method": "airtel-wallet", "sum": { "amount": 2500, "currency": "INR" }, "description": "TEST_156759437" }, "customer": { "id": "12345", "phone": "31647812345" }, "operation": { "id": 48853000002113, "type": "sale", "status": "decline", "date": "2019-09-06T07:41:03+0000", "created_date": "2019-09-06T07:25:26+0000", "request_id": "60a7b84844677185e", "sum_initial": { "amount": 2500, "currency": "INR" }, "sum_converted": { "amount": 2500, "currency": "INR" }, "provider": { "id": 2469, "payment_id": "" }, "code": "603", "message": "Auto decline" }, "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Airtel доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.