HomeBank
Обзор
HomeBank — метод интернет-банкинга для проведения платежей между банковскими счетами. Для работы с этим методом доступно проведение выплат через Gate.
Характеристика
Тип платёжного метода | Интернет-банкинг |
---|---|
Регионы использования | Казахстан |
Валюты платежей | EUR, KZT, RUB, USD |
Конвертация валют | На стороне ECommPay |
Оплаты | – |
Выплаты | + |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | Выплата со стороны пользователя должна быть завершена в течение 24 часов с момента получения СМС с паролем |
Организация и стоимость подключения | По согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием метода HomeBank задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства сервиса HomeBank.
Основные операции
Интерфейсы | Суммы * | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | Минимум | Максимум | |
Выплаты | – | – | + | – | – | – |
* При сумме выплаты меньше 4 000,00 KZT сумма должна быть кратна 2 000,00 KZT, при сумме выплаты больше 4 000,00 KZT — кратна 1 000,00 KZT.
Сценарии использования
Проведение выплат с использованием метода HomeBank через запрос в веб-сервис мерчанта и получение наличных в банкомате.
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Выплаты через Gate
Общая информация
Для выплаты через Gate с использованием метода HomeBank со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.
Рис.: Проведение выплаты через Gate
- Пользователь на стороне веб-сервиса инициирует выплату через HomeBank.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
- Запрос на проведение выплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис HomeBank.
- На стороне HomeBank выполняется обработка платежа. Пользователю на указанный номер телефона отправляется СМС с паролем, по которому он сможет получить выплату наличными в банкомате в течение 24 часов.
- От HomeBank к платёжной платформе направляется оповещение о результате.
- От платёжной платформы к веб-сервису направляется оповещение о результате.
- От веб-сервиса пользователю направляется результат выплаты.
Информация о формате запросов и параметрах инициации выплат методом HomeBank через Gate, а также о формате оповещений о результатах выплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на выплаты с применением метода HomeBank необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/cash-out-kz/homebank/payout
, отправляемый методом POST. Данный запрос относится к группе /v2/payment/cash-out-kz/{payment_method}/payout. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- id — идентификатор в рамках проекта,
- phone — номер телефона,
- ip_address — используемый IP-адрес;
- payment — сведения о платеже:
- amount — сумма выплаты в минорных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3.
- general — основные сведения:
- Валютой платежа могут быть EUR, KZT, RUB, USD
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на выплату с применением метода HomeBank должен содержать идентификаторы проекта и платежа, подпись, данные пользователя, валюту и сумму платежа:
Рис.: Пример запроса на выплату
{ "general": { "project_id": 198, "payment_id": payment_id, "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipT...==" }, "payment": { "amount": 3000000, "currency": "KZT" }, "customer": { "ip_address": "1.1.1.1", "id": "12345", "phone": "79017525555" } }
Формат оповещений
Для оповещений о результатах выплат с применением метода HomeBank используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 238
для пользователя 444567
была успешно проведена выплата в размере 2 000,00 KZT
.
Рис.: Пример оповещения о проведенной выплате
"callbackBody": { "project_id": 238, "payment": { "id": "HomeBankPayout100001", "type": "payout", "status": "success", "date": "2018-09-28T12:04:40+0000", "method": "homebank-payout", "sum": { "amount": 200000, "currency": "KZT" }, "description": "" }, "customer": { "id": "444567", "phone": "7074544579" }, "operation": { "id": 4780000001432, "type": "payout", "status": "success", "date": "2018-09-28T12:04:40+0000", "created_date": "2018-09-28T06:04:34+0000", "request_id": "06a2b8c16cb5b", "sum_initial": { "amount": 200000, "currency": "KZT" }, "sum_converted": { "amount": 200000, "currency": "KZT" }, "provider": { "id": 1112, "payment_id": "14177704", "auth_code": "" }, "code": "0", "message": "Success" }, "signature": "L4FoMZQuq3sukV4IcSDoJWP9i/yJ3P6h7cwMuugDCZj8Q...==" }
В следующем примере выплата была отклонена, так как время выполнения выплаты истекло.
Рис.: Пример оповещения об отказе в проведении выплаты
"callbackBody": { "project_id": 238, "payment": { "id": "HomeBankPayout2222233", "type": "payout", "status": "decline", "date": "2018-09-25T12:11:37+0000", "method": "homebank-payout", "sum": { "amount": 200000, "currency": "KZT" }, "description": "" }, "customer": { "id": "11122233344425223344", "phone": "7074544579" }, "operation": { "id": 10628000001371, "type": "payout", "status": "decline", "date": "2018-09-25T12:11:37+0000", "created_date": "2018-09-25T06:11:33+0000", "request_id": "9641ae50a3df53ddb86239bb94fa7f36cb23f056-621b8db64c752f100b1f9401a08d6e9b25afd321", "sum_initial": { "amount": 200000, "currency": "KZT" }, "sum_converted": { "amount": 200000, "currency": "KZT" }, "provider": { "id": 1112, "payment_id": "14095141", "auth_code": "" }, "code": "20602", "message": "Time-out" }, "signature": "aJXdfMsj2Fpl2jnSoyRVslb8wN34GQh38Z4msJofEiHR4jlQnK16JGF3QyIY5gZMB7ZtXTtvzV6FILiRgQOnHg==" } }
Дополнительные материалы
Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода HomeBank доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.