Instant QR
Обзор
Instant QR — платёжный метод позволяющий пользователям осуществлять оплаты с помощью банковских переводов. Для работы с этим методом доступно проведение оплат через Payment Page и Gate.
Характеристика
Тип платёжного метода | банковские переводы |
---|---|
Регионы использования | TR |
Валюты платежей | TRY |
Конвертация валют | на стороне ECommPay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | суммы указываются с нулевой дробной частью; суммы с ненулевой дробной частью не допускаются |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием Instant QR задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства Instant QR.
Основные операции
Интерфейсы | Суммы, TRY | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | |
Оплаты | + | – | + | – | 50,00 * | 3 000,00 * |
* Информацию об ограничениях сумм необходимо уточнять у курирующего менеджера ECommPay.
Сценарии использования
Проведение оплат с использованием метода Instant QR выполняется с перенаправлением пользователей к сервису Instant QR.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Instant QR со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Instant QR можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сформированная платёжная форма.
- Пользователь выбирает для оплаты метод Instant QR.
- Запрос на проведение оплаты через Instant QR поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис Instant QR.
- На стороне Instant QR выполняется обработка запроса на оплату.
- От сервиса Instant QR к платёжной платформе передаются данные для перенаправления пользователя в сервис Instant QR.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис Instant QR.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Instant QR выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе Instant QR.
- Пользователь перенаправляется к Payment Page.
- От сервиса Instant QR к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Instant QR, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API представлена в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Instant QR необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах.
- Дополнительно должны передаваться следующие данные пользователя, которые необходимо указать на Payment Page:
- customer_id — идентификатор пользователя уникальный в рамках проекта;
- customer_first_name — имя;
- customer_last_name — фамилия;
- customer_email — адрес электронной почты;
- customer_country — страна в формате ISO 3166-1 alpha-2;
- customer_day_of_birth — дата рождения в формате ДД-ММ-ГГГГ.
- Валютой платежа может быть только TRY.
- Для предварительного выбора метода Instant QR необходимо указывать код платёжного метода в параметре force_payment_method —
instant-qr
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробная информация представлена в разделе Работа с подписью к данным.
Таким образом, корректный запрос на оплату с применением метода Instant QR должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, данные пользователя, а также подпись:
project_id: '398', payment_id: '115', payment_currency: 'TRY', payment_amount: 10000, customer_id: 'customer1', customer_first_name": "Mary", customer_last_name": "Smith", customer_email": "smith@example.com", customer_country": "TR", customer_day_of_birth": "12-12-1990", signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\ /RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
Формат оповещений
Для оповещений о результатах оплат с применением метода Instant QR используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 398
была успешно проведена оплата в размере 100,00 TRY
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "purchase", "status": "success", "date": "2019-06-17T08:56:47+0000", "method": "instant-qr", "sum": { "amount": 10000, "currency": "TRY" }, "description": "" }, "operation": { "id": 29891000002814, "type": "sale", "status": "success", "date": "2019-06-17T08:56:47+0000", "created_date": "2019-06-17T08:50:34+0000", "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0", "sum_initial": { "amount": 10000, "currency": "TRY" }, "sum_converted": { "amount": 10000, "currency": "TRY" }, "provider": { "id": 1288, "payment_id": "148947", "date": "2019-06-17T08:56:46+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw==" }
В следующем примере оплата была отклонена из-за нарушения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "purchase", "status": "decline", "date": "2019-06-17T08:56:47+0000", "method": "instant-qr", "sum": { "amount": 600000, "currency": "TRY" }, "description": "" }, "operation": { "id": 29891000002815, "type": "sale", "status": "decline", "date": "2019-06-17T08:56:47+0000", "created_date": "2019-06-17T08:50:34+0000", "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0", "sum_initial": { "amount": 600000, "currency": "TRY" }, "sum_converted": { "amount": 600000, "currency": "TRY" }, "provider": { "id": 1288, "payment_id": "148948", "date": "2019-06-17T08:56:46+0000", "auth_code": "" }, "code": "20101", "message": "Decline due to amount or frequency limit" }, "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Instant QR со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис Instant QR.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через Instant QR.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее — в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Instant QR.
- На стороне Instant QR выполняется обработка запроса на оплату.
- От сервиса Instant QR к платёжной платформе передаются данные для перенаправления пользователя на сайт Instant QR.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в Instant QR в объекте redirect_data.
- Пользователь перенаправляется в сервис Instant QR.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Instant QR выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса Instant QR к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициирования оплат методом Instant QR через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API представлена в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Instant QR необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/bank-transfer/instant-qr/sale
, отправляемый методом POST. Этот запрос относится к группе запросов на оплату с помощью банковского перевода: /v2/payment/bank-transfer/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта;
- payment_id — идентификатор платежа;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах;
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — используемый IP-адрес;
- first_name — имя;
- last_name — фамилия;
- email — электронная почта;
- country — страна в формате ISO 3166-1 alpha-2;
- day_of_birth — дата рождения в формате ДД-ММ-ГГГГ;
- return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
- success — после проведённого платежа;
- decline — после отклонённого платежа.
- general — объект, содержащий основные идентификационные сведения запроса:
- Валютой платежа может быть только TRY.
- Дополнительно могут использоваться любые другие параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Instant QR должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, данные пользователя и URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 398, "payment_id": "115", "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg==" }, "payment": { "amount": 10000, "currency": "TRY" }, "customer": { "ip_address": "1.1.1.1", "first_name": "Mary", "last_name": "Smith", "email": "smith@example.com", "country": "TR", "day_of_birth": "12-12-1990", "id": "123" }, "return_url": { "success": "http://example.com/success", "decline": "http://example.com/decline" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Instant QR необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data" : {
"body" : [],
"method" : "GET",
"url" : "https://checkout.bestpaycard.com/example"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода Instant QR используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 398
была успешно проведена оплата в размере 100,00 TRY
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "purchase", "status": "success", "date": "2019-06-17T08:56:47+0000", "method": "instant-qr", "sum": { "amount": 10000, "currency": "TRY" }, "description": "" }, "operation": { "id": 29891000002814, "type": "sale", "status": "success", "date": "2019-06-17T08:56:47+0000", "created_date": "2019-06-17T08:50:34+0000", "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0", "sum_initial": { "amount": 10000, "currency": "TRY" }, "sum_converted": { "amount": 10000, "currency": "TRY" }, "provider": { "id": 1288, "payment_id": "148947", "date": "2019-06-17T08:56:46+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw==" }
В следующем примере оплата была отклонена из-за нарушения ограничения на сумму.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "purchase", "status": "decline", "date": "2019-06-17T08:56:47+0000", "method": "instant-qr", "sum": { "amount": 600000, "currency": "TRY" }, "description": "" }, "operation": { "id": 29891000002815, "type": "sale", "status": "decline", "date": "2019-06-17T08:56:47+0000", "created_date": "2019-06-17T08:50:34+0000", "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0", "sum_initial": { "amount": 600000, "currency": "TRY" }, "sum_converted": { "amount": 600000, "currency": "TRY" }, "provider": { "id": 1288, "payment_id": "148948", "date": "2019-06-17T08:56:46+0000", "auth_code": "" }, "code": "20101", "message": "Decline due to amount or frequency limit" }, "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Instant QR доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.