СashtoCode
Обзор
CashtoCode — платежный метод, который позволяет пользователям совершать оплаты наличными средствами через терминалы, поддерживающие внесение наличных, на территории Австрии и Германии. Проведение оплат реализовано через Payment Page и Gate.
Характеристика
Тип платёжного метода | Платежи наличными через терминалы |
---|---|
Регионы использования | AT, DE |
Валюты платежей | EUR |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | По согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием CashtoCode задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также терминалы оплаты CashtoCode.
Основные операции
Интерфейсы | Суммы, EUR | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | Фиксированные | ||
Оплаты | + | – | + | – | Австрия:
|
Германия:
|
Сценарии использования
Проведение оплат с использованием метода CashtoCode выполняется пользователями в одном из терминалов оплаты с помощью штрихкода или числового кода, полученного на стороне сервиса CashtoCode.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения оплат, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода CashtoCode со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод CashtoCode можно сделать предварительно выбранным на Payment Page (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на открытие Payment Page.
- Запрос на открытие Payment Page поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает оплату наличными через терминалы CashtoCode.
- Пользователю отображается форма для ввода персональных данных, если они не были переданы в запросе на открытие Payment Page.
- Пользователь вводит данные на Payment Page.
- Запрос на проведение оплаты в сервисе CashtoCode поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис CashtoCode.
- На стороне CashtoCode выполняется обработка запроса на оплату.
- От сервиса CashtoCode к платёжной платформе передаются данные для перенаправления пользователя к сервису CashtoCode.
- Данные для перенаправления пользователя к сервису CashtoCode передаются к Payment Page.
- Пользователь перенаправляется в сервис CashtoCode.
- Пользователь выбирает терминал для оплаты из списка доступных.
- Cервис CashtoCode генерирует и отображает пользователю коды и инструкция для оплаты. Срок действия кодов настраивается.
- Пользователь совершает оплату по коду в одном из выбранных терминалов CashtoCode, следуя инструкции.
- На стороне сервиса CashtoCode выполняется обработка платежа.
- От сервиса CashtoCode к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
Информация о формате запросов и параметрах вызова Payment Page при работе с CashtoCode, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода CashtoCode необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах.
- Валютой платежа может быть только EUR.
- Дополнительно должен передаваться параметр customer_id — идентификатор пользователя в рамках проекта.
- Дополнительно могут передаваться параметры customer_first_name, customer_last_name, customer_day_of_birth, customer_country — имя, фамилия, дата рождения и страна пользователя в рамках проекта. Если эти параметры не переданы в запросе на открытие — они запрашиваются у пользователя на Payment Page, страна определяется по IP-адресу.
- Для предварительного выбора метода CashtoCode необходимо указывать код платёжного метода в параметре force_payment_method —
cashtocode
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода CashtoCode должен содержать идентификаторы проекта и платежа, данные пользователя, а также валюту и сумму платежа и подпись:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 10000, payment_currency: 'EUR', project_id: 35, customer_id: 'customer1', customer_country: 'DE', customer_first_name: 'John', customer_last_name: 'Johnson', customer_day_of_birth: '12-12-1990', signature: "kUi2x9dKHAVNU0FYldJrxo+52Kt8\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода CashtoCode используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 4473
от пользователя была успешно проведена оплата в размере 100,00 EUR
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 4473, "payment": { "id": "EPccf4-792a", "type": "purchase", "status": "success", "date": "2019-06-27T12:21:46+0000", "method": "cashtocode", "sum": { "amount": 10000, "currency": "EUR" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "day_of_birth": "12-12-1992", "first_name": "John", "last_name": "Doe", "country": "AT", "ip_address": "12.1.20.1" }, "merchant_account_id": 4473, "operation": { "id": 2000000018, "type": "sale", "status": "success", "date": "2019-06-27T12:21:46+0000", "created_date": "2019-06-27T12:19:40+0000", "request_id": "cf3d4fd91294c9ecbc125a81f011e4", "sum_initial": { "amount": 10000, "currency": "EUR" }, "sum_converted": { "amount": 10000, "currency": "EUR" }, "provider": { "id": 4473, "payment_id": "", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw==" } }
В следующем примере оплата была отклонена из-за некорректной суммы.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 4473, "payment": { "id": "EPccf4-792a", "type": "purchase", "status": "decline", "date": "2019-06-27T12:21:46+0000", "method": "cashtocode", "sum": { "amount": 100, "currency": "EUR" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "day_of_birth": "12-12-1992", "first_name": "John", "last_name": "Doe", "country": "AT", "ip_address": "12.1.20.1" }, "merchant_account_id": 4473, "operation": { "id": 2000000018, "type": "sale", "status": "decline", "date": "2019-06-27T12:21:46+0000", "created_date": "2019-06-27T12:19:40+0000", "request_id": "cf3d4fd91294c9ecbc125a81f011e4", "sum_initial": { "amount": 100, "currency": "EUR" }, "sum_converted": { "amount": 100, "currency": "EUR" }, "provider": { "id": 4473, "payment_id": "", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw==" } }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода CashtoCode со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление пользователя на сайт сервиса CashtoCode.
- Принять оповещение о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату наличными методом CashtoCode.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис CashtoCode.
- На стороне сервиса CashtoCode выполняется обработка запроса на оплату.
- От сервиса CashtoCode к платёжной платформе передаются данные для перенаправления пользователя.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в объекте redirect_data.
- Пользователь перенаправляется в сервис CashtoCode.
- Пользователь выбирает терминал из списка доступных.
- Пользователю отображаются сгенерированные коды оплаты и инструкция. Срок действия кода настраивается.
- Пользователь совершает оплату в одном из доступных терминалов CashtoCode по коду, следуя инструкции.
- На стороне сервиса CashtoCode выполняется обработка платежа.
- Пользователю отображается результат платежа на терминале CashtoCode.
- От сервиса CashtoCode к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
Информация о формате запросов и параметрах инициализации оплат методом CashtoCode через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода CashtoCode необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/cash/cashtocode/sale
, отправляемый методом POST. Этот запрос относится к группе запросов для получения оплат от пользователей через CashtoCode терминалы: /v2/payment/cash/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор,
- ip_address — используемый IP-адрес,
- first_name — имя,
- last_name — фамилия,
- day_of_birth — дата рождения,
- country — страна (если не передан — определяется по IP-адресу);
- payment — объект, содержащий сведения о платеже:
- amount — сумма,
- currency — валюта платежа в формате ISO-4217 alpha-3;
- general — объект, содержащий основные сведения:
- Валютой платежа может быть только EUR.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода CashtoCode должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 238, "payment_id": "payment", "signature": "8ff12bcdfa8496f8e93fd937f563d07e8be45353b1f60e1cad0d4bbe4c527be", }, "customer": { "id": "customer1", "first_name": "John", "last_name": "Doe", "ip_address": "185.123.111.222", "day_of_birth": "02-10-2002" }, "payment": { "amount": 10000, "currency": "EUR" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса CashtoCode необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": {
"method": "GET",
"body": { },
"url": "https://test.cashtocode.com?token=MmQyNDdlNDMtNTcxOS00YmRhLTkwY2YtMjRlNWZkN2ViMjMw"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода CashtoCode используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 4473
от пользователя была успешно проведена оплата в размере 100,00 EUR
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 4473, "payment": { "id": "EPccf4-792a", "type": "purchase", "status": "success", "date": "2019-06-27T12:21:46+0000", "method": "cashtocode", "sum": { "amount": 10000, "currency": "EUR" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "day_of_birth": "12-12-1992", "first_name": "John", "last_name": "Doe", "country": "AT", "ip_address": "12.1.20.1" }, "merchant_account_id": 4473, "operation": { "id": 2000000018, "type": "sale", "status": "success", "date": "2019-06-27T12:21:46+0000", "created_date": "2019-06-27T12:19:40+0000", "request_id": "cf3d4fd91294c9ecbc125a81f011e4", "sum_initial": { "amount": 10000, "currency": "EUR" }, "sum_converted": { "amount": 10000, "currency": "EUR" }, "provider": { "id": 4473, "payment_id": "", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw==" } }
В следующем примере оплата была отклонена из-за некорректной суммы.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 4473, "payment": { "id": "EPccf4-792a", "type": "purchase", "status": "decline", "date": "2019-06-27T12:21:46+0000", "method": "cashtocode", "sum": { "amount": 100, "currency": "EUR" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "day_of_birth": "12-12-1992", "first_name": "John", "last_name": "Doe", "country": "AT", "ip_address": "12.1.20.1" }, "merchant_account_id": 4473, "operation": { "id": 2000000018, "type": "sale", "status": "decline", "date": "2019-06-27T12:21:46+0000", "created_date": "2019-06-27T12:19:40+0000", "request_id": "cf3d4fd91294c9ecbc125a81f011e4", "sum_initial": { "amount": 100, "currency": "EUR" }, "sum_converted": { "amount": 100, "currency": "EUR" }, "provider": { "id": 4473, "payment_id": "", "auth_code": "" }, "code": "20000", "message": "General decline" }, "signature": "xZFu7a5GH/wrX3QlcAbFq2aqgsvz1AZdjK2YTazmnkqclwfwB/o4uuCKUz7Tfw==" } }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода CashtoCode доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.