CUP QR
Обзор
CUP QR — платёжный метод для оплаты с помощью QR-кода. Оплаты осуществляются через Payment Page и Gate.
Характеристика
Тип платёжного метода | платежи с помощью QR-кодов |
---|---|
Платёжные инструменты | банковские счета |
Регионы использования | Китай |
Валюты платежей | CNY |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием CUP QR задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства провайдера.
Основные операции
Интерфейсы | Суммы | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | |
Оплаты | + | – | + | – | – | – |
Сценарии использования
Проведение оплат с использованием метода CUP QR выполняется со сканированием QR-кода пользователем с помощью мобильного приложения.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода CUP QR со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод CUP QR можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает платёжный метод CUP QR и подтверждает готовность использовать этот метод (если метод был задан предварительно выбранным, то только подтверждает готовность).
- Пользователю отображается список доступных банков.
- Пользователь выбирает банк.
- Запрос на проведение оплаты в сервисе CUP QR поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис CUP QR.
- На стороне CUP QR выполняется обработка запроса на оплату.
- От сервиса CUP QR к платёжной платформе передаются данные для отображения QR-кода пользователю.
- Данные для отображения QR-кода передаются к Payment Page.
- QR-код для оплаты отображается на Payment Page.
- Пользователь сканирует QR-код с помощью мобильного приложения и совершает необходимые действия для оплаты.
- На стороне CUP QR выполняется обработка платежа.
- От сервиса CUP QR пользователю направляется письмо по электронной почте с результатом оплаты.
- От сервиса CUP QR к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с CUP QR, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода CUP QR необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа;
- customer_id — идентификатор пользователя в рамках проекта.
- Дополнительно должны передаваться параметры с данными пользователя (если данные не переданы, они будут запрошены у пользователя на Payment Page):
- customer_first_name и customer_last_name — имя и фамилия на китайском языке,
- customer_email — адрес электронной почты,
- customer_phone — номер телефона,
- customer_country — страна в формате ISO 3166-1 alpha-2,
- customer_city — город проживания,
- customer_street — адрес проживания,
- customer_zip — почтовый индекс.
А также описание платежа в параметре payment_description.
- Валютой платежа может быть только CNY.
- Для предварительного выбора метода CUP QR необходимо указывать код платёжного метода
cup-qr
в параметреforce_payment_method
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода CUP QR должен содержать идентификаторы проекта и платежа, данные пользователя, валюту и сумму платежа, электронный адрес и подпись:
EPayWidget.run( { payment_id: '876543, payment_amount: 30000, payment_currency: 'CNY', payment_description: 'payment_876543', project_id: 100, customer_id: 'customer121', customer_first_name: '伍', customer_last_name: '伍', customer_email: 'paul@mail.com', customer_country: 'CH', customer_city: '倩', customer_street: '倩', customer_phone: '13632264147', customer_zip: '123456', signature: "kUi2x9dKHAVNU0FYldJrxh4yo8552Kt8KU+Y1Y4HASCQ9vySO...==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода CUP QR используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 843
для пользователя 2233
была успешно проведена оплата в размере 300,00 CNY
.
Рис.: Пример оповещения о проведенной оплате
"project_id": 843, "payment": { "id": "EP761d-6f6d", "type": "purchase", "status": "success", "date": "2019-12-11T12:20:17+0000", "method": "cup-qr", "sum": { "amount": 30000, "currency": "CNY" }, "description": "123" }, "account": { "number": "qwerty@qwe.fff" }, "customer": { "phone": "2233" }, "operation": { "id": 2000000029, "type": "sale", "status": "success", "date": "2019-12-11T12:20:17+0000", "created_date": "2019-12-11T12:18:04+0000", "request_id": "9a593318e4842a725b60498b-00000003", "sum_initial": { "amount": 30000, "currency": "CNY" }, "sum_converted": { "amount": 30000, "currency": "CNY" }, "code": "0", "message": "Success", "provider": { "id": 1838, "payment_id": "1001905226143910", "auth_code": "", "date": "2019-12-11T12:18:14+0000" } }, "signature": "y/DQVScN32bQi2BHO4YU1gfuikigFEbA...==" }
В следующем примере оплата была отклонена из-за истечения времени ожидания.
Рис.: Пример оповещения об отказе в проведении оплаты
"project_id": 843, "payment": { "id": "EP761d-6f6d", "type": "purchase", "status": "decline", "date": "2019-12-11T12:20:17+0000", "method": "cup-qr", "sum": { "amount": 30000, "currency": "CNY" }, "description": "123" }, "account": { "number": "qwerty@qwe.fff" }, "customer": { "phone": "2233" }, "operation": { "id": 2000000029, "type": "sale", "status": "decline", "date": "2019-12-11T12:20:17+0000", "created_date": "2019-12-11T12:18:04+0000", "request_id": "9a593318e4842a725b60498b-00000003", "sum_initial": { "amount": 30000, "currency": "CNY" }, "sum_converted": { "amount": 30000, "currency": "CNY" }, "code": "20602", "message": "Time-out", "provider": { "id": 1838, "payment_id": "1001905226143910", "auth_code": "", "date": "2019-12-11T12:18:14+0000" } }, "signature": "y/DQVScN32bQi2BHO4YU1gfuikigFEbA...==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода CUP QR со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить отображение QR-кода для проведения оплаты.
- Принять оповещение о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату методом CUP QR.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис CUP QR.
- На стороне CUP QR выполняется обработка запроса на оплату.
- От сервиса CUP QR к платёжной платформе передаются данные для отображения QR-кода пользователю.
- Данные для отображения QR-кода передаются к веб-сервису.
- QR-код для оплаты отображается на стороне веб-сервиса.
- Пользователь сканирует QR-код с помощью мобильного приложения и совершает необходимые действия для оплаты.
- На стороне CUP QR выполняется обработка платежа.
- От сервиса CUP QR пользователю направляется письмо по электронной почте с результатом оплаты.
- От сервиса CUP QR к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициализации оплат методом CUP QR через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода CUP QR необходимо учитывать следующее:
- Должен использоваться запрос, отправляемый методом POST на /v2/payment/cup/qr/sale.
- В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — IP-адрес,
- first_name — имя, только на китайском языке,
- last_name — фамилия, только на китайском языке,
- phone — номер телефона без знака "+",
- email — адрес электронной почты,
- zip — почтовый индекс,
- country — страна в формате ISO 3166-1 alpha-2,
- city — город на китайском,
- street — адрес на китайском;
- payment — сведения о платеже:
- amount — сумма,
- currency — валюта платежа в формате ISO-4217 alpha-3,
- description — описание или комментарий к платежу;
- return_url — объект, содержащий URL для возврата пользователя с сайта банка в проект мерчанта после совершения оплаты:
- success — URL возврата в случае проведенного патежа.
- general — основные сведения:
- Валютой платежа может быть только CNY.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода CUP QR должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 200, "payment_id": "ECT_TEST_1559134591371-pz-3", "signature": "pK1YN6fd7yajGSWAzsbYeJo5nvotVBtOijOzgFvAU5Cc8PB...==" }, "customer": { "ip_address": "183.57.40.238", "first_name": "伍", "last_name": "倩文", "phone": "13632264147", "email": "2524243674@email.com", "street":"street", "city": "city", "zip": "123045607", "country": "CH", "id": "123" } }, "payment": { "amount": 1000, "currency": "CNY", "description": "payment" }, "return_url: { "success": "http://example.com" } }
Формат данных для передачи пользователю
Для завершения оплаты необходимо отобразить пользователю QR-код. Информация для отображения QR-кода содержится в оповещении от платёжной платформы в объекте display_data. Поэтому прежде чем отобразить QR-код, надо принять и обработать такое оповещение.
Данное оповещение отправляется от платёжной платформы ecommpay на URL, указанный в настройках проекта мерчанта. Статус платежа в данном случае будет awaiting customer action до момента завершения оплаты со стороны пользователя.
Далее приведён фрагмент оповещения, содержащего данные QR-кода для оплаты.
"display_data": [
{
"type": "qr_data",
"title": "QR Code",
"data": "https://cashier.xhepay.com/paygate/union/pay/MDAyMDUxNjk0OTMwNjYyMTQzMTgwOHwwNHw0ODgxMDAwMA=="
},
{
"type": "add_info",
"title": "QR Code Timeout",
"data": "600"
}
]
Формат оповещений
Для оповещений о результатах оплат с применением метода CUP QR используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 843
для пользователя 2233
была успешно проведена оплата в размере 300,00 CNY
.
Рис.: Пример оповещения о проведении оплаты
"project_id": 843, "payment": { "id": "EP761d-6f6d", "type": "purchase", "status": "success", "date": "2019-12-11T12:20:17+0000", "method": "cup-qr", "sum": { "amount": 30000, "currency": "CNY" }, "description": "123" }, "account": { "number": "qwerty@qwe.fff" }, "customer": { "phone": "2233" }, "operation": { "id": 2000000029, "type": "sale", "status": "success", "date": "2019-12-11T12:20:17+0000", "created_date": "2019-12-11T12:18:04+0000", "request_id": "9a593318e4842a725b60498b-00000003", "sum_initial": { "amount": 30000, "currency": "CNY" }, "sum_converted": { "amount": 30000, "currency": "CNY" }, "code": "0", "message": "Success", "provider": { "id": 1838, "payment_id": "1001905226143910", "auth_code": "", "date": "2019-12-11T12:18:14+0000" } }, "signature": "y/DQVScN32bQi2BHO4YU1gfuikigFEbA...==" }
В следующем примере оплата была отклонена из-за истечения времени ожидания.
Рис.: Пример оповещения об отказе в проведении оплаты
"project_id": 843, "payment": { "id": "EP761d-6f6d", "type": "purchase", "status": "decline", "date": "2019-12-11T12:20:17+0000", "method": "cup-qr", "sum": { "amount": 30000, "currency": "CNY" }, "description": "123" }, "account": { "number": "qwerty@qwe.fff" }, "customer": { "phone": "2233" }, "operation": { "id": 2000000029, "type": "sale", "status": "decline", "date": "2019-12-11T12:20:17+0000", "created_date": "2019-12-11T12:18:04+0000", "request_id": "9a593318e4842a725b60498b-00000003", "sum_initial": { "amount": 30000, "currency": "CNY" }, "sum_converted": { "amount": 30000, "currency": "CNY" }, "code": "20602", "message": "Time-out", "provider": { "id": 1838, "payment_id": "1001905226143910", "auth_code": "", "date": "2019-12-11T12:18:14+0000" } }, "signature": "y/DQVScN32bQi2BHO4YU1gfuikigFEbA...==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода CUP QR доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.