UPI
Обзор
UPI (Unified Payments Interface) — платёжный метод позволяющий пользователям осуществлять оплаты и получать возвраты и выплаты средств с помощью банковских переводов. Оплаты осуществляются через Payment Page и Gate, возвраты — через Gate, выплаты — через Gate и Dashboard.
Характеристика
Тип платёжного метода | банковские платежи |
---|---|
Платёжные инструменты | банковские счета |
Регионы использования | IN |
Валюты платежей | INR, USD |
Конвертация валют | На стороне ecommpay |
Оплаты | + |
Выплаты | + |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием UPI задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства UPI, обеспечивающие взаимодействие с сервисами банков.
Основные операции
Интерфейсы | Суммы, INR/ USD | Время ** | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | * | * | * | * |
Выплаты | – | – | + | + | * | * | * | * |
Полные возвраты | – | – | + | – | – | – | * | * |
Частичные возвраты | – | – | + | – | – | – | * | * |
* Информацию следует уточнять у курирующего менеджера ecommpay.
** Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ecommpay.
Сценарии использования
Проведение оплат с использованием метода UPI выполняется с перенаправлением пользователей на сайт сервиса UPI, проведение возвратов и выплат — с уведомлением пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через Gate
Рис.: Выплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода UPI со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод UPI можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает платёжный метод UPI.
- Запрос на проведение оплаты через UPI поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис UPI.
- На стороне UPI выполняется обработка запроса на оплату.
- От сервиса UPI к платёжной платформе передаются данные для перенаправления пользователя в сервис UPI.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис UPI.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса UPI выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе UPI.
- Пользователь перенаправляется к Payment Page.
- От сервиса UPI к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с UPI, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода UPI необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах.
- Дополнительно должны использоваться параметры с данными пользователя:
- customer_first_name — имя,
- customer_last_name — фамилия,
- customer_email — адрес электронной почты,
- customer_city — город проживания,
- customer_street — улица проживания,
- customer_building — номер дома проживания,
- identify_doc_number — номер документа, подтверждающего личность Permanent Account Number (PAN), который состоит из 10 символов: 5 букв, 4 цифры, 1 буква или число.
Если параметры не переданы в запросе на открытие, то данные запрашиваются у пользователя на Payment Page.
- Валютой платежа может быть только INR или USD.
- Для предварительного выбора метода UPI необходимо указывать код платёжного метода в параметре force_payment_method —
upi
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в разделе Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода UPI должен содержать идентификаторы проекта и платежа, данные пользователя, валюту и сумму платежа и подпись:
EPayWidget.run( { project_id: 198, payment_id: '3936', payment_amount: 250, payment_currency: 'USD', customer_id: 'customer1', customer_first_name: 'John', customer_last_name: 'Johnson', customer_email: 'John@mail.com', customer_city: 'Delhi', customer_street: 'New Delhi', customer_building: '123A', identify_doc_number: 'EHFGA5967A', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода UPI используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 580
от пользователя была успешно проведена оплата в размере 2,50 USD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 580, "payment": { "id": "TEST_Ref1215267492448813313", "type": "purchase", "status": "success", "date": "2019-09-03T10:58:10+0000", "method": "UPI", "sum": { "amount": 250, "currency": "USD" }, "description": "TEST_Ref1215267492448813313" }, "customer": { "id": "1" }, "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": 250, "currency": "USD" }, "sum_converted": { "amount": 17993, "currency": "INR" }, "provider": { "id": 1309, "payment_id": "fcccab5d465e", "date": "2019-09-03T09:43:50+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 580, "payment": { "id": "TEST_REFUNDUPIIINR1567592437", "type": "purchase", "status": "decline", "date": "2019-09-06T07:41:03+0000", "method": "UPI", "sum": { "amount": 250, "currency": "INR" }, "description": "TEST_REFUNDUPIIINR156759437" }, "customer": { "id": "1" }, "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": 250, "currency": "INR" }, "sum_converted": { "amount": 250, "currency": "INR" }, "provider": { "id": 1309, "payment_id": "" }, "code": "603", "message": "Auto decline" }, "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода UPI со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Принять оповещение с данными для перенаправления пользователя в сервис UPI.
- Принять оповещение о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату методом UPI.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис UPI.
- На стороне UPI выполняется обработка запроса на оплату.
- От сервиса UPI к платёжной платформе передаются данные для перенаправления пользователя в сервис UPI.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в объекте
redirect_data
. - Пользователь перенаправляется в сервис UPI.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса UPI выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса UPI к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом UPI через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Канал 1. Формат запросов
При работе с запросами на оплаты с применением метода UPI необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bank-transfer/upi/sale
, отправляемый методом POST. Этот запрос относится к группе запросов с помощью банковского перевода: /v2/payment/bank-transfer/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — используемый IP-адрес,
- first_name — имя,
- last_name — фамилия,
- email — адрес электронной почты,
- city — город проживания,
- street — улица проживания,
- building — номер дома проживания,
- identify — объект, содержащий сведения о документе, подтверждающем личность:
- doc_number — номер документа, подтверждающего личность Permanent Account Number (PAN), который состоит из 10 символов: 5 букв, 4 цифры, 1 буква или число,
- payment — сведения о платеже:
- amount — сумма в дробных единицах валюты,
- currency — валюта в формате ISO-4217 alpha-3;
- general — основные сведения:
- Валютой платежа может быть только INR или USD.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода UPI должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 200, "payment_id": "payment_id", "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...==" }, "customer": { "ip_address": "1.1.1.1", "id": "customer123", "email": "Johnson@mail.com", "first_name": "John", "last_name": "Johnson", "city": "Delhi", "street": "New Delhi", "building": "123A", "identify": { "doc_number": "EHFGA5967A" }, "payment": { "amount": 250, "currency": "USD" } }
Канал 2. Формат запросов
При работе с запросами на оплаты с применением метода UPI необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bank-transfer/upi/sale
, отправляемый методом POST. Этот запрос относится к группе запросов с помощью банковского перевода: /v2/payment/bank-transfer/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- ip_address — используемый IP-адрес,
- first_name — имя,
- last_name — фамилия,
- email — адрес электронной почты,
- phone — номер телефона,
- payment — сведения о платеже:
- amount — сумма в дробных единицах валюты,
- currency — валюта в формате ISO-4217 alpha-3;
- account — объект, содержащий сведения о виртуальном платёжном адресе пользователя:
- number — виртуальный платёжный адрес (обязательность этого параметра зависит от провайдера, который проводит платёж, подробнее уточняйте у курирующего менеджера ecommpay);
- return_url — объект, содержащий URL-ссылки для перенаправления пользователя после оплаты:
- success — URL-ссылка для перенаправления пользователя после проведенной оплаты.
- general — основные сведения:
- Валютой платежа может быть только INR или USD.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода UPI должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа, а также URL для возврата пользователя в веб-сервис:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 200, "payment_id": "payment_id", "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...==" }, "customer": { "ip_address": "1.1.1.1", "email": "Johnson@mail.com", "first_name": "John", "last_name": "Johnson", "phone": "312567890" }, "payment": { "amount": 250, "currency": "USD" }, "account": { "number": "123456@ABC" }, "return_url": { "success": "http://merchant.com/returnurl.asp" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса в сервис UPI необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре 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"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода UPI используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 580
от пользователя была успешно проведена оплата в размере 2,50 USD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 580, "payment": { "id": "TEST_Ref1215267492448813313", "type": "purchase", "status": "success", "date": "2019-09-03T10:58:10+0000", "method": "UPI", "sum": { "amount": 250, "currency": "USD" }, "description": "TEST_Ref1215267492448813313" }, "customer": { "id": "1" }, "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": 250, "currency": "USD" }, "sum_converted": { "amount": 17993, "currency": "INR" }, "provider": { "id": 1309, "payment_id": "fcccab5d465e", "date": "2019-09-03T09:43:50+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 580, "payment": { "id": "TEST_REFUNDUPIIINR1567592437", "type": "purchase", "status": "decline", "date": "2019-09-06T07:41:03+0000", "method": "UPI", "sum": { "amount": 250, "currency": "INR" }, "description": "TEST_REFUNDUPIIINR156759437" }, "customer": { "id": "1" }, "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": 250, "currency": "INR" }, "sum_converted": { "amount": 250, "currency": "INR" }, "provider": { "id": 1309, "payment_id": "" }, "code": "603", "message": "Auto decline" }, "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
UPI поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода UPI со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь запрашивает возврат.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение возврата.
- Запрос на проведение возврата поступает в платёжную платформу ecommpay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис UPI.
- На стороне UPI выполняется обработка платежа.
- От UPI к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат возврата.
Информация о формате запросов и параметрах инициации возвратов методом UPI через Gate, а также о формате оповещений о результатах возврата приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на возврат с применением метода UPI необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bank-transfer/upi/refund
, отправляемый методом POST. Этот запрос относится к группе запросов с помощью банковского перевода: /v2/payment/bank-transfer/{payment_method}/refund. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения о запросе:
- project_id — идентификатор проекта;
- payment_id — идентификатор платежа;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес;
- payment — объект, содержащий сведения о возврате :
- description — комментарий или описание возврата,
- amount — сумма возврата в дробных единицах валюты (обязательный при частичном возврате),
- currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
- general — объект, содержащий основные идентификационные сведения о запросе:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода UPI должен содержать идентификаторы проекта и платежа, подпись, IP-адрес пользователя, сумму и описание возврата, если это частичный возврат:
Рис.: Пример запроса на возврат
{ "general": { "project_id": 239, "payment_id": "refund_02", "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO5...==" }, "customer": { "ip_address": "1.2.3.4" }, "payment": { "amount": 100, "currency": "USD", "description": "refund_02" } }
Формат оповещений
Для оповещений о результатах возврата с применением метода UPI используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 580
для пользователя был успешно проведён частичный возврат в размере 1,00 USD
на счёт пользователя.
Рис.: Пример оповещения о проведенном возврате
{
"project_id": 580,
"payment": {
"id": "TEST_7492448813313334",
"type": "purchase",
"status": "partially refunded",
"date": "2019-09-03T11:20:07+0000",
"method": "UPI",
"sum": {
"amount": 100,
"currency": "USD"
},
"description": "TEST_7492448813313334"
},
"customer": {
"id": "1"
},
"operation": {
"id": 49572000001897,
"type": "refund",
"status": "success",
"date": "2019-09-03T11:20:07+0000",
"created_date": "2019-09-03T11:05:07+0000",
"request_id": "225baf528bbd401",
"sum_initial": {
"amount": 150,
"currency": "USD"
},
"sum_converted": {
"amount": 10796,
"currency": "INR"
},
"provider": {
"id": 1309,
"payment_id": "REF-2456-4d0da54c-e6bd-4070-af92-da8c826d8645",
"date": "2019-09-03T11:05:07+0000",
"auth_code": ""
},
"code": "0",
"message": "Success"
},
"signature": "eCv6ySrrAYJVkh+oK/zF9iMfXB8ZYu2ITT0EfM...=="
}
В следующем примере возврат был отклонён из-за некорректных настроек со стороны эквайера.
Рис.: Пример оповещения об отказе в проведении возврата
{ "project_id": 580, "payment": { "id": "TEST_267492448813313334", "type": "purchase", "status": "partially refunded", "date": "2019-09-06T07:41:07+0000", "method": "UPI", "sum": { "amount": 100, "currency": "USD" }, "description": "TEST_267492448813313334" }, "customer": { "id": "1" }, "operation": { "id": 49572000002071, "type": "refund", "status": "decline", "date": "2019-09-06T07:41:08+0000", "created_date": "2019-09-06T07:41:06+0000", "request_id": "57938102bf03", "sum_initial": { "amount": 100, "currency": "USD" }, "sum_converted": { "amount": 100, "currency": "USD" }, "provider": { "id": 1309, "payment_id": "", "auth_code": "" }, "code": "20503", "message": "Incorrect acquirer settings" }, "signature": "p3y5ZHqoFeD6S1ECuJYdHoflju3DSimozOWngEC...==" }
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Выплаты через Gate
Общая информация
Для выплаты через Gate с использованием метода UPI со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.
Рис.: Проведение выплаты через Gate
- Пользователь на стороне веб-сервиса инициирует выплату через UPI.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение выплаты через Gate.
- Запрос на проведение выплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис провайдера.
- На стороне провайдера выполняется обработка платежа.
- От провайдера к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат выплаты.
Информация о формате запросов и параметрах инициации выплат методом UPI через Gate, а также о формате оповещений о результатах выплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на выплаты с применением метода UPI необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bank-transfer/upi/payout
, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/bank-transfer/{payment_method}/payout. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции,
- payment_id — идентификатор платежа, уникальный в рамках проекта,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в дробных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор пользователя на стороне веб-сервиса,
- ip_address — используемый IP-адрес,
- first_name — имя,
- last_name — фамилия,
- phone — номер телефона,
- email — адрес электронной почты,
- address — почтовый адрес;
- account — объект, содержащий сведения о счёте получателя выплаты:
- number — номер счёта.
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на выплату с применением метода UPI должен содержать идентификаторы проекта и платежа, подпись, номер счёта и данные пользователя, валюту и сумму платежа, а также сведения о счёте получателя:
Рис.: Пример запроса на выплату
{ "general": { "project_id": 818, "payment_id": "ORDER_I1558600157", "signature": "+K6jllym+PtObocZ1yS...xfWJTXdESkijfsBeR6bKROUsslA==" }, "payment": { "amount": 150000, "currency": "INR" }, "customer": { "id": "24900", "ip_address": "1.2.3.4", "first_name": "Ada", "last_name": "Lovelace", "phone": "321654987", "email": "Lovelace@mail.com", "address": "Delhi, Main st., 20" }, "account": { "number": "johndoe@upi" } }
Формат оповещений
Для оповещений о результатах выплат с применением метода UPI используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 239
была успешно проведена выплата в размере 1000,00 INR
.
Рис.: Пример оповещения о проведении выплаты
{ "project_id": 239, "payment": { "id": "ORDER53", "type": "payout", "status": "success", "date": "2020-05-21T13:23:32+0000", "method": "UPI", "sum": { "amount": 100000, "currency": "INR" }, "description": "description" }, "account": { "number": "johndoe@upi" }, "customer": { "id": "24901" }, "operation": { "id": 1386, "type": "payout", "status": "success", "date": "2020-05-21T13:23:32+0000", "created_date": "2020-05-21T13:23:28+0000", "request_id": "e48da2df266940ce5f534c84cae31237ca774b6fb-00000002", "sum_initial": { "amount": 100000, "currency": "INR" }, "sum_converted": { "amount": 100000, "currency": "INR" }, "code": "0", "message": "Success", "provider": { "id": 1309, "payment_id": "15141-1589360772-26", "auth_code": "" } }, "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q==" }
В следующем примере выплата была отклонена.
Рис.: Пример оповещения об отказе в проведении выплаты
{ "project_id": 239, "payment": { "id": "ORDER54", "type": "payout", "status": "decline", "date": "2020-05-21T13:23:32+0000", "method": "UPI", "sum": { "amount": 1000, "currency": "INR" }, "description": "description" }, "account": { "number": "johndoe@upi" }, "customer": { "id": "24900" }, "operation": { "id": 1386, "type": "payout", "status": "decline", "date": "2020-05-21T13:23:32+0000", "created_date": "2020-05-21T13:23:28+0000", "request_id": "e48da2df266940ce5fdc7ae31237ca774b6fb-00000001", "sum_initial": { "amount": 1000, "currency": "INR" }, "sum_converted": { "amount": 1000, "currency": "INR" }, "code": "20000", "message": "General decline", "provider": { "id": 1309, "payment_id": "", "auth_code": "" } }, "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q==" }
Дополнительные материалы
Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:
Выплаты через Dashboard
При использовании интерфейса Dashboard можно проводить одиночные и массовые выплаты методом UPI с единичной и пакетной отправкой запросов, называемые соответственно одиночными и массовыми.
- Для проведения одиночной выплаты необходимо открыть форму выплаты, задать все необходимые параметры (включая метод), отправить запрос и убедиться в проведении выплаты.
-
Для проведения массовой выплаты необходимо подготовить и загрузить файл с информацией обо всех целевых выплатах, отправить пакет запросов и убедиться в проведении выплат.
При этом должен использоваться файл формата CSV, структура которого соответствует требованиям, представленным в разделе Сведения о массовых платежах, а параметры выплат — должны соответствовать требованиям, представленным в разделе Выплаты через Gate этой статьи (за исключением пункта о подписи).
Более подробная информация о проведении выплат через Dashboard представлена в отдельной статье.
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода UPI доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.