Promptpay
Обзор
Promptpay — это платёжный метод для проведения оплат с помощью сканирования QR-кода в с использованием мобильных приложений таиландских банков. Для работы с этим методом доступно проведение оплат через Payment Page и Gate.
Характеристика
Тип платёжного метода | платежи с помощью QR-кода |
---|---|
Регионы использования | TH |
Валюты платежей | THB |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | срок действия QR-кода на стороне провайдера — 6 минут |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием Promptpay задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства провайдера.
Основные операции
Интерфейсы | Суммы, THB | Время* | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | Минимум | Максимум | Базовое | Предельное | |
Оплаты | + | – | + | – | 500,00 | 500 000,00 | 3-4 минуты | – |
* Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.
Сценарии использования
Проведение оплат с использованием метода Promptpay выполняется с перенаправлением пользователей к сервису провайдера.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Promptpay со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Promptpay можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сформированная платёжная форма.
- Пользователь выбирает для оплаты метод Promptpay.
- Запрос на проведение оплаты через провайдера поступает в платёжную платформу.
- Выполняется дальнейшая обработка запроса.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис провайдера.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса провайдера выполняется обработка платежа.
- Пользователь перенаправляется к Payment Page.
- От сервиса провайдера к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Promptpay, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Promptpay необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Для предварительного выбора метода Promptpay необходимо указывать код платёжного метода в параметре force_payment_method —
promptpay
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Promptpay должен содержать идентификаторы проекта и платежа, а также валюту и сумму платежа и подпись:
{ payment_id: 'X03936', payment_amount: 1000, payment_currency: 'THB', project_id: 123, customer_id: 'customer1', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+5...ZzUCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода Promptpay используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 382
для пользователя 123
была успешно проведена оплата в размере 1 000,00 THB
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 382, "payment": { "type": "purchase", "sum": { "amount": 100000, "currency": "THB" }, "status": "success", "method": "promptpay", "id": "cfaf576641101077ec3440ffaf476a9d", "date": "2020-09-07T12:44:54+0000" }, "customer": { "id": "123" }, "operation": { "type": "sale", "sum_initial": { "currency": "THB", "amount": 100000 }, "sum_converted": { "currency": "THB", "amount": 100000 }, "status": "success", "request_id": "057cdba3b2b54b994a5f9c3c4080ff...fdec3b0b0be6b-00089013", "provider": { "payment_id": "079253339", "id": 3351, "date": "2020-09-07T04:44:52+0000" }, "message": "Success", "id": 89012010009801, "date": "2020-09-07T12:44:54+0000", "created_date": "2020-09-07T12:42:17+0000", "code": "0" }, "signature": "mwiKFBdPKMUEmDieNYeJ...w0R0GGfIBVExvubTbimclPgfx2/CY8Yq+g==" } }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 383, "payment": { "type": "purchase", "sum": { "amount": 185384, "currency": "THB" }, "status": "decline", "method": "promptpay", "id": "bde45cdea1ac5c4a75e2d04689a06ad4", "date": "2020-09-07T11:01:34+0000" }, "customer": { "id": "456" }, "operation": { "type": "sale", "sum_initial": { "currency": "THB", "amount": 185384 }, "sum_converted": { "currency": "THB", "amount": 185384 }, "status": "decline", "request_id": "c7d5631fdd81a4394e85d82...eb70af0e207f1a133-00085510", "provider": { "payment_id": "079243093", "id": 3351, "date": "2020-09-07T03:01:32+0000" }, "message": "General decline", "id": 85509010009741, "date": "2020-09-07T11:01:34+0000", "created_date": "2020-09-07T10:09:31+0000", "code": "20000" }, "signature": "FEPNq/ijls1WTCdNdz8FD1bM6kWe04AO...Lri/KEHcn/ihMSmzv/cNmQ==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Promptpay со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис провайдера.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через провайдера.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- Выполняется дальнейшая обработка запроса.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в провайдера в объекте redirect_data.
- Пользователь перенаправляется в сервис провайдера.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса провайдера выполняется обработка платежа.
- Пользователь перенаправляется к веб-сервису.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом Promptpay через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Promptpay необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/banks/promptpay/sale
, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в дробных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор на стороне веб-сервиса,
- ip_address — IP-адрес пользователя;
- return_url — объект, содержащий URL для перенаправления пользователя после оплаты:
- success — URL для перенаправления пользователя после проведенной оплаты.
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Promptpay должен содержать идентификаторы проекта и платежа, подпись, идентификатор и IP-адрес пользователя, валюту и сумму платежа, а также URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 125, "payment_id": "ID_184", "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV+VHq3L wY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 10000, "currency": "THB" }, "customer": { "ip_address": "1.1.1.1", "id": "123" }, "return_url":{ "success" : "http://example.com" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт провайдера необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data":{ "url":"http://api.example.biz/MerchantTransfer", "method":"POST", "body":{ "Reference":"2000016", "Amount": "58.00", "Merchant": "M0114", "Currency": "THB", "Key": "21312434tgdfgdjif", "Datetime":"2017-09-19 02:55:00PM", "FrontURI": "http://example.com", "BackURI": "http://test.example2.com", "Bank":"123", "Language": "en-us", "ClientIP":"183.171.94.142", "Customer":"tester77" } }
Формат оповещений
Для оповещений о результатах оплат с применением метода Promptpay используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 382
для пользователя 123
была успешно проведена оплата в размере 1 000,00 THB
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 382, "payment": { "type": "purchase", "sum": { "amount": 100000, "currency": "THB" }, "status": "success", "method": "promptpay", "id": "cfaf576641101077ec3440ffaf476a9d", "date": "2020-09-07T12:44:54+0000" }, "customer": { "id": "123" }, "operation": { "type": "sale", "sum_initial": { "currency": "THB", "amount": 100000 }, "sum_converted": { "currency": "THB", "amount": 100000 }, "status": "success", "request_id": "057cdba3b2b54b994a5f9c3c4080ff...fdec3b0b0be6b-00089013", "provider": { "payment_id": "079253339", "id": 3351, "date": "2020-09-07T04:44:52+0000" }, "message": "Success", "id": 89012010009801, "date": "2020-09-07T12:44:54+0000", "created_date": "2020-09-07T12:42:17+0000", "code": "0" }, "signature": "mwiKFBdPKMUEmDieNYeJ...w0R0GGfIBVExvubTbimclPgfx2/CY8Yq+g==" } }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 383, "payment": { "type": "purchase", "sum": { "amount": 185384, "currency": "THB" }, "status": "decline", "method": "promptpay", "id": "bde45cdea1ac5c4a75e2d04689a06ad4", "date": "2020-09-07T11:01:34+0000" }, "customer": { "id": "456" }, "operation": { "type": "sale", "sum_initial": { "currency": "THB", "amount": 185384 }, "sum_converted": { "currency": "THB", "amount": 185384 }, "status": "decline", "request_id": "c7d5631fdd81a4394e85d82...eb70af0e207f1a133-00085510", "provider": { "payment_id": "079243093", "id": 3351, "date": "2020-09-07T03:01:32+0000" }, "message": "General decline", "id": 85509010009741, "date": "2020-09-07T11:01:34+0000", "created_date": "2020-09-07T10:09:31+0000", "code": "20000" }, "signature": "FEPNq/ijls1WTCdNdz8FD1bM6kWe04AO...Lri/KEHcn/ihMSmzv/cNmQ==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Promptpay доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.