Cash-in
Обзор
Cash-in — платежный метод, который позволяет пользователям совершать оплаты наличными средствами через терминалы и банкоматы, поддерживающие внесение наличных. Проведение оплат реализовано через Payment Page и Gate.
Характеристика
Тип платёжного метода | Платежи наличными через терминалы оплаты |
---|---|
Регионы использования | RU |
Валюты платежей | RUB |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | По согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием Cash-in задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также терминалы оплаты Cash-in.
Основные операции
Интерфейсы | Суммы, RUB | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | |
Оплаты | + | – | + | – | 1,00 | – |
Сценарии использования
Проведение оплат с использованием метода Cash-in выполняется с получением пользователем через Payment Page или в веб-сервисе мерчанта кода для оплаты в одном из терминалов или банкоматов.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения оплат, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Cash-in со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Cash-in можно сделать предварительно выбранным на Payment Page (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает оплату наличными через терминалы Cash-in.
- Пользователю отображается форма для ввода номера телефона для получения кода оплаты.
- Пользователь вводит номер телефона на Payment Page.
- Запрос на проведение оплаты методом Cash-in поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис терминалов Cash-in.
- На стороне сервиса терминалов Cash-in выполняется обработка запроса на оплату.
- От сервиса Cash-in к платёжной платформе передаётся сгенерированная ссылка, которая содержит код и инструкцию для оплаты.
- Ссылка с кодом и инструкцией передаётся на Payment Page.
- Пользователю отображается ссылка с кодом и инструкцией для оплаты.
- Пользователь совершает оплату по инструкции, используя код в одном из доступных терминалов или банкоматов Cash-in.
- На стороне сервиса терминалов Cash-in выполняется обработка платежа.
- Пользователю отображается результат платежа на терминале Cash-in.
- От сервиса Cash-in к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
Информация о формате запросов и параметрах вызова Payment Page при работе с Cash-in, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Cash-in необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах.
- customer_id — идентификатор пользователя в рамках проекта.
- Валютой платежа может быть только RUB.
- Дополнительно должен использоваться параметр customer_phone — номер телефона пользователя.
- Для предварительного выбора метода Cash-in необходимо указывать код платёжного метода в параметре force_payment_method —
cash-in
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Cash-in должен содержать идентификаторы проекта и платежа, телефон пользователя, а также валюту и сумму платежа и подпись:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 10000, payment_currency: 'RUB', project_id: 35, customer_phone: "89123456789", customer_id: 'customer121', signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода Cash-in используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 1100
от пользователя fav_customer
была успешно проведена оплата в размере 100,00 RUB
.
Рис.: Пример оповещения о проведенной оплаты
{ "project_id": 1100, "payment": { "id": "yandex_cash", "type": "purchase", "status": "success", "date": "2018-07-18T08:10:39+0000", "method": "cash-in", "sum": { "amount": 10000, "currency": "RUB" }, "description": "TEST_1531899099620" }, "customer": { "id": "fav_customer" }, "operation": { "id": 13383000000701, "type": "sale", "status": "success", "date": "2018-07-18T08:10:39+0000", "created_date": "2018-07-18T08:02:00+0000", "request_id": "d079593b8a108002b", "sum_initial": { "amount": 10000, "currency": "RUB" }, "sum_converted": { "amount": 10000, "currency": "RUB" }, "provider": { "id": 1068, "payment_id": "2000002913475", "date": "2018-07-18T08:10:37+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "6QdVNs5xjDf2kCEZnCGiBSzX+9pHdonOnMlrsxhYRE77EjoiCze6i6EwZbpUPrPFQ==" }
В следующем примере оплата была отклонена из-за истечения времени ожидания.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 1100, "payment": { "id": "5c90bb0385e71413a7ecfdd2", "type": "purchase", "status": "decline", "date": "2019-03-20T09:48:56+0000", "method": "cash-in", "sum": { "amount": 500, "currency": "RUB" }, "description": "test payment" }, "customer": { "id": "5c90b3c63cb3d13d03b928b9" }, "operation": { "id": 36150000000595, "type": "sale", "status": "decline", "date": "2019-03-20T09:48:56+0000", "created_date": "2019-03-19T09:48:56+0000", "request_id": "1e993a7850a680caa1023d5434adf2522", "sum_initial": { "amount": 500, "currency": "RUB" }, "sum_converted": { "amount": 500, "currency": "RUB" }, "provider": { "id": 1068, "payment_id": "", "auth_code": "" }, "code": "20602", "message": "Time-out" }, "signature": "qTxNQ+9CpNm9dvIHDPLGuoS+8mi4wGNBy8GSpxqH6owP15wTPhY+htebODVS4X4CQ==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Cash-in со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление пользователя на сайт сервиса Cash-in.
- Принять оповещение о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату наличными методом Cash-in.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис терминалов Cash-in.
- На стороне сервиса Cash-in выполняется обработка запроса на оплату.
- От сервиса Cash-in к платёжной платформе передаются данные для перенаправления пользователя.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в объекте redirect_data.
- Пользователь перенаправляется в сервис Cash-in.
- Пользователь вводит необходимые данные для получения кода и инструкции для оплаты наличными в терминале.
- Пользователю отображаются сгенерированные код оплаты и инструкция.
- Пользователь совершает оплату в одном из доступных терминалов или банкоматов Cash-in по коду, следуя инструкции.
- На стороне сервиса Cash-in выполняется обработка платежа.
- Пользователю отображается результат платежа на терминале Cash-in.
- От сервиса Cash-in к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
Информация о формате запросов и параметрах инициализации оплат методом Cash-in через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Cash-in необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/cash/yandex/sale
, отправляемый методом POST. Этот запрос относится к группе запросов для получения оплат от пользователей через Cash-in терминалы: /v2/payment/cash/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор в рамках проекта,
- ip_address — используемый IP-адрес;
- payment — объект, содержащий сведения о платеже:
- amount — сумма,
- currency — валюта платежа в формате ISO-4217 alpha-3.
- general — объект, содержащий основные сведения:
- Валютой платежа может быть только RUB.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Cash-in должен содержать идентификаторы проекта и платежа, подпись, IP-адрес пользователя, валюту и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 35, "payment_id": "Payment 12", "signature": "2tlMuYxLW9Yu6RETr8pdCfmi0UPE8euD+o4EVPjLyfbOQ+9ajAteg5lPk96Q==" }, "customer": { "ip_address": "1.1.1.1", "id": "123" }, "payment": { "amount": 10000, "currency": "RUB" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Cash-in необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": {
"method": "POST",
"body": {
"shopId": 187706,
"scid": "561690",
"sum": "100.00",
"customerNumber": "87.245.207.226",
"orderNumber": 1338,
"paymentType": "GP",
"payment_system_code": "CashPaymentViaYandexRUB",
"shopArticleId": 523830,
"shopDefaultURL": "",
"shopSuccessURL": "https://site.com/process/complete-redirect?wsid=t81n72g5d",
"shopFailURL": "https://site.com/process/complete-redirect?wsid=t81n72g5d",
"cps_email": ""
},
"encrypted": [],
"url": "https://demomoney.yandex.ru/eshop.xml"
}
Формат оповещений
Для оповещений о результатах оплат с применением метода Cash-in используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 1100
от пользователя fav_customer
была успешно проведена оплата в размере 100,00 RUB
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 1100, "payment": { "id": "yandex_cash", "type": "purchase", "status": "success", "date": "2018-07-18T08:10:39+0000", "method": "cash-in", "sum": { "amount": 10000, "currency": "RUB" }, "description": "TEST_1531899099620" }, "customer": { "id": "fav_customer" }, "operation": { "id": 13383000000701, "type": "sale", "status": "success", "date": "2018-07-18T08:10:39+0000", "created_date": "2018-07-18T08:02:00+0000", "request_id": "d079593b8a108002b", "sum_initial": { "amount": 10000, "currency": "RUB" }, "sum_converted": { "amount": 10000, "currency": "RUB" }, "provider": { "id": 1068, "payment_id": "2000002913475", "date": "2018-07-18T08:10:37+0000", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "6QdVNs5xjDf2kCEZnCGiBSzX+9pHdonOnMlrsxhYRE77EjoiCze6i6EwZbpUPrPFQ==" }
В следующем примере оплата была отклонена из-за истечения времени ожидания.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 1100, "payment": { "id": "5c90bb0385e71413a7ecfdd2", "type": "purchase", "status": "decline", "date": "2019-03-20T09:48:56+0000", "method": "cash-in", "sum": { "amount": 500, "currency": "RUB" }, "description": "test payment" }, "customer": { "id": "5c90b3c63cb3d13d03b928b9" }, "operation": { "id": 36150000000595, "type": "sale", "status": "decline", "date": "2019-03-20T09:48:56+0000", "created_date": "2019-03-19T09:48:56+0000", "request_id": "1e993a7850a680caa1023d5434adf2522", "sum_initial": { "amount": 500, "currency": "RUB" }, "sum_converted": { "amount": 500, "currency": "RUB" }, "provider": { "id": 1068, "payment_id": "", "auth_code": "" }, "code": "20602", "message": "Time-out" }, "signature": "qTxNQ+9CpNm9dvIHDPLGuoS+8mi4wGNBy8GSpxqH6owP15wTPhY+htebODVS4X4CQ==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Тестирование
Общая информация
Для метода Cash-in доступно тестирование оплат через Payment Page и Gate.
Тестирование может выполняться в рамках тестового проекта, и для подключения и отключения этой функциональности необходимо обращаться к специалистам технической поддержки ECommPay support@ecommpay.com.
При проведении тестовых платежей следует учитывать, что в запросах должен указываться идентификатор тестового проекта, а интерфейсы эмулятора платёжных форм Payment Page и Cash-in могут отличаться от рабочих.

Статусы тестовых платежей
При тестировании оплат их итоговые статусы определяются исходя из сумм, указанных в запросах:
decline
— при указании суммы40000
или40400
,success
— при указании любой другой суммы;
Оплаты через Payment Page
Для проведения тестовой оплаты через Payment Page необходимо:
- Отправить в платёжную платформу корректный тестовый запрос на открытие Payment Page.
- Если в запросе не был указан метод
cash-in
— выбрать его на странице эмулятора. - Щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы).
- Принять оповещение с информацией о результате оплаты.
Если при переходе на страницу эмулятора платёжной формы Cash-in кнопка Success или Decline не щёлкнута в течение 30 минут, то со стороны платёжной платформы отправляется оповещение о переводе платежа в статус decline
(независимо от суммы, указанной в запросе).
Подробная информация о проведении оплат с использованием метода Cash-in через Payment Page представлена в пункте Оплаты через Payment Page.
Оплаты через Gate
Для проведения тестовой оплаты через Gate необходимо:
- Отправить в платёжную платформу корректный тестовый запрос на оплату.
- Принять оповещение с данными для перенаправления.
- Перейти по полученному URL и щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы) — на странице эмулятора.
- Принять оповещение с информацией о результате оплаты.
Если при переходе на страницу эмулятора платёжной формы Cash-in кнопка Success или Decline не щёлкнута в течение 30 минут, то со стороны платёжной платформы отправляется оповещение о переводе платежа в статус decline
(независимо от суммы, указанной в запросе).
Подробная информация о проведении оплат с использованием метода Cash-in через Gate представлена в пункте Оплаты через Gate.
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Cash-in доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.