Hong Kong FPS QR
Обзор
Hong Kong FPS QR — это платёжный метод для проведения оплат в Гонконге с помощью сканирования QR-кодов с использованием мобильных приложений банков. Оплаты осуществляются через Payment Page и Gate.
Характеристика
Тип платёжного метода | платежи с помощью QR-кодов |
---|---|
Платёжные инструменты | банковские счета |
Регионы использования | HK |
Валюты платежей | HKD, CNY |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием Hong Kong FPS QR задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства провайдера.
Основные операции
Интерфейсы | Суммы, HKD | Время* | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | – | 10 000,00 | – | – |
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ecommpay.
Сценарии использования
Проведение оплат с использованием метода Hong Kong FPS QR выполняется со сканированием QR-кода пользователем с помощью мобильного приложения.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Hong Kong FPS QR со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Hong Kong FPS QR можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сформированная платёжная форма.
- Пользователь выбирает для оплаты метод Hong Kong FPS QR.
- Запрос на проведение оплаты через провайдера поступает в платёжную платформу.
- Выполняется дальнейшая обработка запроса.
- Данные для отображения платёжной инструкции пользователю передаются к Payment Page.
- Пользователю отображается платёжная инструкция.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса провайдера выполняется обработка платежа.
- От сервиса провайдера к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page отправляется информация о результате проведения оплаты.
- Информация о результате оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Hong Kong FPS QR, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Hong Kong FPS QR необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- customer_id — идентификатор пользователя в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа, указанная в дробных единицах валюты.
- Валютой платежа может быть только HKD или CNY.
- Для предварительного выбора метода Hong Kong FPS QR необходимо указывать код платёжного метода в параметре force_payment_method —
hk-qr
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись (подробнее).
Таким образом, корректный запрос на открытие платёжной формы с применением метода Hong Kong FPS QR должен содержать идентификаторы проекта, пользователя и платежа, валюту и сумму платежа, а также подпись:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 10000, payment_currency: 'HKD', project_id: '12345', customer_id: '123' signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU...ZhkIQg==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода Hong Kong FPS QR используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 123
для пользователя customer1
была успешно проведена оплата в размере 100,00 HKD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 123, "payment": { "id": "123123123", "type": "purchase", "status": "success", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 5205000010711, "type": "sale", "status": "success", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "23fdebfc248b0676209a5e0694487738a...08525", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "0", "message": "Success", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "Dj2MN6VS9yDGrRAnJ5sMRnr/J4C7FPOl8...nLN08qIVqFA7pTlw==" } }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 0123, "payment": { "id": "12341234", "type": "purchase", "status": "decline", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 4991000010711, "type": "sale", "status": "decline", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "3d12732e00fb397dbe99ad866e05ecfc...004992", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "20000", "message": "General decline", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "LbcKUUDELHz8wxx56WCT0T/W00cC6rEAXax7u1kORhK32...wYqSekS6Kg==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Hong Kong FPS QR со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Отобразить пользователю инструкцию для оплаты.
- Принять оповещение от платежной платформы ecommpay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через провайдера.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ecommpay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности (подробнее).
- Выполняется дальнейшая обработка запроса.
- От платёжной платформы к веб-сервису направляется оповещение с данными для отображения платёжной инструкции пользователю.
- Пользователю отображается платёжная инструкция.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса провайдера выполняется обработка платежа.
- От сервиса провайдера к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом Hong Kong FPS QR через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Hong Kong FPS QR необходимо учитывать следующее:
- Должен использоваться запрос к конечной точке
/v2/payment/banks/hk-qr/sale
, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- ip_address — используемый IP-адрес;
- id — идентификатор пользователя в рамках проекта;
- payment — сведения о платеже:
- amount — сумма платежа, указанная в дробных единицах валюты;
- currency — валюта платежа в формате ISO-4217 alpha-3.
- general — основные сведения:
- Валютой платежа может быть только HKD или CNY.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Hong Kong FPS QR должен содержать идентификаторы проекта, пользователя и платежа, IP-адрес пользователя, валюту и сумму платежа, а также подпись:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 383000, "payment_id": "abc123456", "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAaQlYc9...xI5vOA7w==" }, "customer": { "ip_address": "1.1.1.1", "id": "123" }, "payment": { "amount": 10000, "currency": "HKD" } }
Форматы данных для отображения платёжной инструкции
Для отображения платёжной инструкции необходимо принять и обработать оповещение от платёжной платформы, содержащее данные о платеже в массиве display_data, и отобразить пользователю платёжную инструкцию.
Помимо текста инструкции рекомендуется отобразить пользователю информацию о времени, отведённом на выполнение необходимых для проведения оплаты действий. Если пользователь не подтверждает платёж до истечения указанного срока, выдаётся сообщение об ошибке.
Далее приведён текст инструкции для отображения пользователю:
Текст инструкции на китайском языке (традиционное письмо) | Текст инструкции на английском языке |
---|---|
二維碼有效期 | QR code expiration date |
請下載二維碼並在網上銀行應用程序的二維碼掃描功能中使用 | Please download the QR code and use it in the QR scan function of your online banking application |
此二維碼僅供一次性掃描 | For one-time use only |
Массив display_data содержит следующие параметры:
- type — тип передаваемых данных (в значении всегда передаётся
qr_data
); - title — название передаваемых данных, которые необходимо отобразить пользователю (в значении всегда передаётся
QR code
); - data — строка с закодированным изображением QR-кода.
Далее приведён фрагмент оповещения, содержащего данные для отображения пользователю.
"display_data": [ { "type": "qr_img", "title": "QR code", "data": "1213323442...523521424" } ]
Формат оповещений
Для оповещений о результатах оплат с применением метода Hong Kong FPS QR используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 456
от пользователя customer1
была успешно проведена оплата в размере 100,00 HKD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 456, "payment": { "id": "123123123", "type": "purchase", "status": "success", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 5205000010711, "type": "sale", "status": "success", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "23fdebfc248b0676209a5e0694487738a...08525", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "0", "message": "Success", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "Dj2MN6VS9yDGrRAnJ5sMRnr/J4C7FPOl8...nLN08qIVqFA7pTlw==" } }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 0123, "payment": { "id": "12341234", "type": "purchase", "status": "decline", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 4991000010711, "type": "sale", "status": "decline", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "3d12732e00fb397dbe99ad866e05ecfc...004992", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "20000", "message": "General decline", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "LbcKUUDELHz8wxx56WCT0T/W00cC6rEAXax7u1kORhK32...wYqSekS6Kg==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода Hong Kong FPS QR доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.