CashU
Обзор
CashU — платёжный метод для проведения оплат и возвратов с использованием электронного кошелька CashU. Оплаты осуществляются через Payment Page и Gate, возвраты — через Gate.
Характеристика
Тип платёжного метода | платежи с использованием электронных кошельков |
---|---|
Регионы использования | все страны |
Валюты платежей | AED, BHD, DZD, EGP, EUR, GBP, JOD, KWD, LBP, MAD, OMR, QAR, SAR, TRY, USD |
Конвертация валют | на стороне ECommPay |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием CashU задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства CashU.
Основные операции
Интерфейсы | Суммы | Время* | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | базовое | предельное | |
Оплаты | + | – | + | – | – | – | в течение минуты | 30 минут |
Полные возвраты | – | – | + | – | – | – | – | – |
Частичные возвраты | – | – | + | – | – | – | – | – |
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.
Сценарии использования
Проведение оплат с использованием метода CashU выполняется с перенаправлением пользователей к сервису CashU, проведение возвратов — с заявкой от пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода CashU со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод CashU можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сформированная платёжная форма.
- Пользователь выбирает для оплаты электронный кошелёк CashU.
- Запрос на проведение оплаты через CashU поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис CashU.
- На стороне CashU выполняется обработка запроса на оплату.
- От сервиса CashU к платёжной платформе передаются данные для перенаправления пользователя в сервис CashU.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис CashU.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса CashU выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе CashU.
- Пользователь перенаправляется к Payment Page.
- От сервиса CashU к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с CashU, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API представлена в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода CashU необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах.
- customer_id — идентификатор пользователя в рамках проекта.
- Для предварительного выбора метода CashU необходимо указывать код платёжного метода в параметре force_payment_method —
cashu
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробная информация представлена в разделе Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода CashU должен содержать идентификаторы проекта, пользователя и платежа, валюту и сумму платежа, а также подпись:
{ payment_id: 'test_payment', payment_amount: 1000, payment_currency: 'USD', project_id: 112, customer_id: 'customer121', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+UCwX6R\/ekpZhkIQg==" }
Формат оповещений
Для оповещений о результатах оплат с применением метода CashU используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 112
для пользователя была успешно проведена оплата в размере 10,00 USD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 112, "payment": { "id": "ORDER_ID_123", "type": "purchase", "status": "success", "date": "2020-01-14T08:27:24+0000", "method": "CashU", "sum": { "amount": 1000, "currency": "USD" }, "description": "Cashu sale transaction completed successfully" }, "customer": { "id": "Ada Lovelace" }, "operation": { "id": 1028, "type": "sale", "status": "success", "date": "2020-01-14T08:27:24+0000", "created_date": "2020-01-14T08:26:38+0000", "request_id": "4adb525e9fb723c6bf152bc4da0bc683696c6778ca-00000001", "sum_initial": { "amount": 1000, "currency": "USD" }, "sum_converted": { "amount": 1000, "currency": "USD" }, "code": "0", "message": "Success", "provider": { "id": 1870, "payment_id": "5e1d7b4bc3c305e1d7b4bc3c8815789904118019", "auth_code": "" } }, "signature": "NUiS/gcididh1CX4QcWkDubYDSK07gSq+qmllo868b8lQ==" } }
В следующем примере оплата была отклонена из-за недоступности сервиса CashU.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 1362, "payment": { "id": "ORDER_ID_2", "type": "purchase", "status": "decline", "date": "2020-01-14T08:27:24+0000", "method": "CashU", "sum": { "amount": 1000, "currency": "USD" }, "description": "Cashu sale transaction failed to complete" }, "customer": { "id": "Ada Lovelace" }, "operation": { "id": 1029, "type": "sale", "status": "decline", "date": "2020-01-14T08:27:24+0000", "created_date": "2020-01-15T08:26:38+0000", "request_id": "4adb525e9fb723c6bf152bc4da0bc683696c6778ca-00000002", "sum_initial": { "amount": 1000, "currency": "USD" }, "sum_converted": { "amount": 1000, "currency": "USD" }, "code": "20202", "message": "PSP system is unavailable", "provider": { "id": 1870, "payment_id": "5e1d7b4bc3c305e1d7b4bc3c8815789904118020", "auth_code": "" } }, "signature": "NUiS/gcididh1CX4QcWkDubYDSK07gSq+qmllo868b8lD==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода CashU со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис CashU.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через CashU.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис CashU.
- На стороне CashU выполняется обработка запроса на оплату.
- От сервиса CashU к платёжной платформе передаются данные для перенаправления пользователя на сайт CashU.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в CashU в объекте redirect_data.
- Пользователь перенаправляется в сервис CashU.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса CashU выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса CashU к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом CashU через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода CashU необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/wallet/cashu/sale
, отправляемый методом POST. Этот запрос относится к группе запросов для проведения оплат с использованием электронных кошельков /v2/payment/wallet/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции,
- payment_id — идентификатор платежа, уникальный в рамках проекта,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор в рамках проекта,
- ip_address — используемый IP-адрес;
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3.
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно рекомендуется указывать URL для перенаправления пользователя при успешной и отклонённой оплате. Рекомендуется использовать следующие параметры объекта return_url:
- success — URL для перенаправления пользователя при успешной оплате;
- decline — URL для перенаправления пользователя при отклонённой оплате.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода CashU должен содержать идентификаторы проекта и платежа, подпись, IP-адрес пользователя, валюту и сумму платежа, а также URL для перенаправления:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 112, "payment_id": "test_payment", "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" }, "customer": { "ip_address": "56.34.85.96", "id": "123" }, "payment": { "amount: 1000, "currency": "USD" }, "return_url":{ "success": "http://example.com/return", "decline": "http://example.com/decline" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса CashU необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": { "method": "POST", "body": { "Transaction_Code": "test123" }, "encrypted": [], "url": "https://example.cashu.com/cgi-bin/payment/pcashu.cgi" }
Формат оповещений
Для оповещений о результатах оплат с применением метода CashU используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 112
для пользователя была успешно проведена оплата в размере 10,00 USD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 112, "payment": { "id": "ORDER_ID_123", "type": "purchase", "status": "success", "date": "2020-01-14T08:27:24+0000", "method": "CashU", "sum": { "amount": 1000, "currency": "USD" }, "description": "Cashu sale transaction completed successfully" }, "customer": { "id": "Ada Lovelace" }, "operation": { "id": 1028, "type": "sale", "status": "success", "date": "2020-01-14T08:27:24+0000", "created_date": "2020-01-14T08:26:38+0000", "request_id": "4adb525e9fb723c6bf152bc4da0bc683696c6778ca-00000001", "sum_initial": { "amount": 1000, "currency": "USD" }, "sum_converted": { "amount": 1000, "currency": "USD" }, "code": "0", "message": "Success", "provider": { "id": 1870, "payment_id": "5e1d7b4bc3c305e1d7b4bc3c8815789904118019", "auth_code": "" } }, "signature": "NUiS/gcididh1CX4QcWkDubYDSK07gSq+qmllo868b8lQ==" } }
В следующем примере оплата была отклонена из-за недоступности сервиса CashU.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 1362, "payment": { "id": "ORDER_ID_2", "type": "purchase", "status": "decline", "date": "2020-01-14T08:27:24+0000", "method": "CashU", "sum": { "amount": 1000, "currency": "USD" }, "description": "Cashu sale transaction failed to complete" }, "customer": { "id": "Ada Lovelace" }, "operation": { "id": 1029, "type": "sale", "status": "decline", "date": "2020-01-14T08:27:24+0000", "created_date": "2020-01-15T08:26:38+0000", "request_id": "4adb525e9fb723c6bf152bc4da0bc683696c6778ca-00000002", "sum_initial": { "amount": 1000, "currency": "USD" }, "sum_converted": { "amount": 1000, "currency": "USD" }, "code": "20202", "message": "PSP system is unavailable", "provider": { "id": 1870, "payment_id": "5e1d7b4bc3c305e1d7b4bc3c8815789904118020", "auth_code": "" } }, "signature": "NUiS/gcididh1CX4QcWkDubYDSK07gSq+qmllo868b8lD==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
CashU поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода CashU со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь запрашивает возврат.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение возврата.
- Запрос на проведение возврата поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис CashU.
- На стороне CashU выполняется обработка платежа.
- От CashU к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат возврата.
Информация о формате запросов и параметрах инициации возвратов методом CashU через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на возврат с применением метода CashU необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/wallet/cashu/refund
, отправляемый методом POST. Этот запрос относится к группе запросов для платежей с использованием электронных кошельков /v2/payment/wallet/{payment_method}/refund. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес;
- payment — объект, содержащий сведения о возврате :
- description — комментарий или описание возврата,
- amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате),
- currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода CashU должен содержать идентификаторы проекта и платежа, подпись, описание возврата, сумму и валюту платежа (при частичном возврате), а также IP-адрес пользователя:
Рис.: Пример запроса на возврат
{ "general": { "project_id": 112, "payment_id": "456", "signature": "kUi2x9dKHJkdq2w9De4RF6w7FHJqe23zUCwX6R\/ekpZhkIQg==" }, "customer": { "ip_address": "1.1.1.1" }, "payment": { "description": "CashU test refund", "amount": 1000, "currency": "USD" } }
Формат оповещений
Для оповещений о результатах возврата с применением метода CashU используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 112
был успешно проведён возврат в размере 10,00 USD
.
Рис.: Пример оповещения о проведенном возврате
{
"project_id": 112,
"payment": {
"id": "ORDER_ID_3",
"type": "purchase",
"status": "refunded",
"date": "2020-01-14T08:25:21+0000",
"method": "CashU",
"sum": {
"amount": 0,
"currency": "USD"
},
"description": "test"
},
"customer": {
"id": "Ada Lovelace"
},
"operation": {
"id": 1026,
"type": "refund",
"status": "success",
"date": "2020-01-14T08:25:21+0000",
"created_date": "2020-01-14T08:24:33+0000",
"request_id": "6e1c2660cc20dc3c9d142bd4cff61bc96ce5864ff-00000001",
"sum_initial": {
"amount": 1000,
"currency": "USD"
},
"sum_converted": {
"amount": 1000,
"currency": "USD"
},
"code": "0",
"message": "Success",
"provider": {
"id": 1870,
"payment_id": "1578990316",
"auth_code": ""
}
},
"signature": "m20IVFvCQvDVd27LcPP68z1zC/sLxY29TBHtPgeU1uzlCYfrEmsg=="
}
}
В следующем примере возврат был отклонён из-за недоступности сервиса CashU.
Рис.: Пример оповещения об отказе в проведении возврата
{
"project_id": 1362,
"payment": {
"id": "ORDER_ID_4",
"type": "purchase",
"status": "success",
"date": "2020-01-15T08:25:21+0000",
"method": "CashU",
"sum": {
"amount": 1000,
"currency": "USD"
},
"description": "test"
},
"customer": {
"id": "Ada Lovelace"
},
"operation": {
"id": 1026,
"type": "refund",
"status": "decline",
"date": "2020-01-14T08:25:21+0000",
"created_date": "2020-01-14T08:24:33+0000",
"request_id": "6e1c2660cc20dc3c9d142bd4cff61bc96ce5864ff-00000002",
"sum_initial": {
"amount": 1000,
"currency": "USD"
},
"sum_converted": {
"amount": 1000,
"currency": "USD"
},
"code": "0",
"message": "Success",
"provider": {
"id": 1870,
"payment_id": "1578990317",
"auth_code": ""
}
},
"signature": "m20IVFvCQvDVd27LcPP68z1zC/sLxY29TBHtPgeU1uzlCYfrEmld=="
}
}
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода CashU доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.