Crypto
Обзор
Crypto — платёжный метод, позволяющий пользователям проводить платежи с использованием электронных кошельков, поддерживающих криптовалюты. Проведение оплат поддерживается через Payment Page, выплат — через Gate.
Характеристика
Тип платёжного метода | платежи с использованием криптовалют |
---|---|
Платёжные инструменты | криптокошельки |
Регионы использования | все страны, кроме DZ, BO, EC, NP, PK, KH, IR, KP * |
Валюты платежей | EUR, USD |
Конвертация валют | на стороне ecommpay * |
Оплаты | + |
Выплаты | + |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности |
|
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
* Информацию следует уточнять у курирующего менеджера ecommpay.
Схема работы
В проведении отдельного платежа с использованием Crypto задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства Crypto.
Основные операции
Интерфейсы | Суммы | Время ** | ||||||
---|---|---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | базовое | предельное | |
Оплаты | + | – | – | – | * | * | * | * |
Выплаты | – | – | + | – | 45,00 EUR | – | – | – |
* Информацию следует уточнять у курирующего менеджера ecommpay.
** Базовое и предельное время определяются следующим образом:
- Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
- Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус
decline
. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ecommpay.
Сценарии использования
Проведение оплат с использованием метода Crypto выполняется с перенаправлением пользователей к сервису провайдера или отображением платёжной инструкции, проведение выплат — с уведомлением пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Выплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Crypto со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод Crypto можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется формирование Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сформированная платёжная форма.
- Пользователь выбирает для оплаты метод Crypto.
- Запрос на проведение оплаты через Crypto поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис провайдера.
- На стороне провайдера выполняется обработка запроса на оплату.
- От провайдера к платёжной платформе передаются данные для перенаправления пользователя к сервису провайдера.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис провайдера.
- Пользователь выполняет необходимые действия для оплаты. В зависимости от провайдера, обрабатывающего платёж, действия, которые пользователю необходимо выполнить для оплаты, отличаются. За более подробной информацией следует обращаться к курирующему менеджеру ecommpay.
- На стороне сервиса провайдера выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе провайдера.
- Пользователь перенаправляется к Payment Page.
- От сервиса провайдера к платёжной платформе направляется информация о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется информация о результате проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Crypto, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API представлены в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Crypto необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в дробных единицах,
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Дополнительно могут потребоваться передаваться следующие данные пользователя, которые необходимо указать на Payment Page. Необходимость использования этих параметров следует уточнять у курирующего менеджера ecommpay.
- customer_first_name — имя;
- customer_last_name — фамилия;
- customer_email — адрес электронной почты;
- customer_country — в формате ISO 3166-1 alpha-2;
- customer_day_of_birth — дата рождения в формате ДД-ММ-ГГГГ.
Если хотя бы один из тех параметров, которые должны использоваться, отсутствует в запросе, то на стороне платёжной платформы выявляется необходимость в дополнении данных и применяется соответствующая процедура — Дополнение информации о платежах.
- Для предварительного выбора метода Crypto необходимо указывать код платёжного метода
crypto
в параметре force_payment_method. Также в этом случае, в зависимости от провайдера, обрабатывающего платёж, можно задать криптовалюту (вследствие пользователь не сможет поменять заданную криптовалюту при оплате). Для этого в запросе необходимо указать код (тикер) криптовалюты в параметре payment_methods_options. Значение этого параметра имеет формат"{"currency_id":["..."]}"
, где...
это символ одной из доступных криптовалют. Пример корректного значения —"{"currency_id":["BTC"]}"
. За информацией о возможности задания криптовалюты следует обращаться к курирующему менеджеру ecommpay. - В некоторых случаях (в зависимости от провайдера, обрабатывающего платёж), если в запросе указывается адрес электронной почты пользователя в параметре customer_email, то после проведённого или отклонённого платежа со стороны платёжной платформы на этот адрес отправляется письмо с информацией о результате оплаты.
- Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробная информация представлена в разделе Работа с подписью к данным.
Таким образом, корректный запрос на оплату с применением метода Crypto должен содержать идентификаторы проекта и платежа, подпись, сумму и валюту платежа, данные пользователя, а также подпись:
project_id: '398', payment_id: '115', payment_currency: 'EUR', payment_amount: 1500, customer_id: 'customer121', 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=="
Формат оповещений
Для оповещений о результатах оплат с применением метода Crypto используется стандартный формат, описание которого представлено в разделе Оповещения.
При успешной оплате через некоторых провайдеров, в оповещении в объекте crypto содержатся следующие параметры с дополнительной информацией о платеже:
- blockchain_url — ссылка для отслеживания информации об оплате в стороннем сервисе;
- exchange_rate — курс криптовалюты к фиатной валюте, который использовался при платеже;
- address — крипто-адрес, используемый пользователем для проведения оплаты;
- crypto_currency — символ криптовалюты, используемой для оплаты.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 398
была успешно проведена оплата в размере 15,00 EUR
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "purchase", "status": "success", "date": "2019-06-17T08:56:47+0000", "method": "crypto", "sum": { "amount": 1500, "currency": "EUR" }, "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": 1500, "currency": "EUR" }, "sum_converted": { "amount": 1500, "currency": "EUR" }, "provider": { "id": 1288, "payment_id": "148947", "date": "2019-06-17T08:56:46+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "crypto": { "exchange_rate": "32378.76267999", "address": "emulateBTCaddrjooterthas42ro87b0z", "blockchain_url": "https://api.example.com/c4ba632a094c078", "crypto_currency": "BTC" }, "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "purchase", "status": "decline", "date": "2019-06-17T08:56:47+0000", "method": "crypto", "sum": { "amount": 500, "currency": "EUR" }, "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": 500, "currency": "EUR" }, "sum_converted": { "amount": 500, "currency": "EUR" }, "provider": { "id": 1288, "payment_id": "148948", "date": "2019-06-17T08:56:46+0000", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Выплаты через Gate
Общая информация
Для выплаты через Gate с использованием метода Crypto со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.
Рис.: Проведение выплаты через Gate
- Пользователь на стороне веб-сервиса инициирует выплату через Crypto.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение выплаты через Gate.
- Запрос на проведение выплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис провайдера.
- На стороне провайдера выполняется обработка платежа.
- От сервиса провайдера к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат выплаты.
Информация о формате запросов и параметрах инициирования выплат методом Crypto через Gate, а также о формате оповещений о результатах выплат приведена далее, общая информация о работе с API представлена в разделе Работа с API.
Формат запросов
При работе с запросами на выплаты с применением метода Crypto необходимо учитывать следующее:
- Должен использоваться запрос /v2/payment/crypto/payout, отправляемый методом POST.
- В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма выплаты в дробных единицах валюты;
- currency — код валюты платежа в формате ISO-4217 alpha-3;
- customer — объект, содержащий сведения о пользователе:
- ip_address — используемый IP-адрес;
- first_name — имя;
- last_name — фамилия;
- email — электронная почта;
- country — страна в формате ISO 3166-1 alpha-2;
- account — объект, содержащий сведения о счёте пользователя:
- wallet_address — адрес электронного кошелька, поддерживающего криптовалюты;
- crypto_currency — символ криптовалюты, поддерживаемой электронным кошельком, например:
BTC
,BCH
,USDT
,ETH
(информацию о поддерживаемых криптовалютах следует уточнять у курирующего менеджера ecommpay).
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно могут использоваться любые другие параметры, указанные в спецификации.
Таким образом, корректный запрос на выплату с применением метода Crypto должен содержать идентификаторы проекта и платежа, подпись, валюту и сумму платежа, данные пользователя и информацию о счёте:
Рис.: Пример запроса на выплату
{ "general": { "project_id": 398, "payment_id": "115", "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg==" }, "payment": { "amount": 5000, "currency": "EUR" }, "customer": { "ip_address": "1.1.1.1", "first_name": "Mary", "last_name": "Smith", "email": "smith@example.com", "country": "TR" }, "account": { "wallet_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2", "crypto_currency": "BTC" } }
Формат оповещений
Для оповещений о результатах оплат с применением метода Crypto используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 398
была успешно проведена выплата в размере 50,00 EUR
.
Рис.: Пример оповещения о проведенной выплате
{ "project_id": 398, "payment": { "id": "TEST_1560760354708", "type": "payout", "status": "success", "date": "2019-06-17T08:56:47+0000", "method": "crypto", "sum": { "amount": 5000, "currency": "EUR" }, "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": 5000, "currency": "EUR" }, "sum_converted": { "amount": 5000, "currency": "EUR" }, "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": "payout", "status": "decline", "date": "2019-06-17T08:56:47+0000", "method": "crypto", "sum": { "amount": 4000, "currency": "EUR" }, "description": "" }, "operation": { "id": 29891000002815, "type": "payout", "status": "decline", "date": "2019-06-17T08:56:47+0000", "created_date": "2019-06-17T08:50:34+0000", "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0", "sum_initial": { "amount": 4000, "currency": "EUR" }, "sum_converted": { "amount": 4000, "currency": "EUR" }, "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, при использовании метода Crypto доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ecommpay.