Interac Combined Pay-in
Обзор
Interac Combined Pay-in — канадский платёжный метод, который поддерживает проведение оплат с помощью банковских переводов и интернет-банкинга. Оплаты осуществляются через Payment Page и Gate.
Характеристика
Тип платёжного метода |
|
---|---|
Регионы использования | CA |
Валюты платежей | CAD |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | – |
Частичные возвраты | – |
Опротестования | – |
Особенности | необходимо использовать внутренний гид по стилю Interac Combined Pay-in при разработке отображаемой пользователю платежной страницы |
Организация и стоимость подключения | по согласованию с курирующим менеджером ECommPay |
Схема работы
В проведении отдельного платежа с использованием Interac Combined Pay-in задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства Interac.
Основные операции
Интерфейсы | Суммы, CAD | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard (Old Dashboard) | минимум | максимум | |
Оплаты | + | – | + | – | * | * |
* Максимальная сумма оплат для одного пользователя в день — 2 500,00 CAD.
Сценарии использования
Проведение оплат с использованием метода Interac Combined Pay-in выполняется с перенаправлением пользователей к сервису Interac.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода Interac Combined Pay-in со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Interac Combined Pay-in можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платежного метода). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает для оплаты метод Interac Combined Pay-in.
- Запрос на проведение оплаты через Interac Combined Pay-in поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис Interac.
- На стороне Interac выполняется обработка запроса на оплату.
- От сервиса Interac к платёжной платформе передаются данные для перенаправления пользователя в сервис Interac.
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис Interac.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Interac выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе Interac.
- Пользователь перенаправляется к Payment Page.
- От сервиса Interac к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с Interac Combined Pay-in, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода Interac Combined Pay-in необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах;
- customer_id — идентификатор пользователя уникальный в рамках проекта.
- Дополнительно рекомендуется указывать имя, фамилию, номер телефона и адрес электронной почты пользователя в параметрах customer_first_name, customer_last_name, customer_phone и customer_email. Если параметры отсутствуют в запросе, на Payment Page пользователю отображаются поля для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.
- Валютой платежа может быть только CAD.
- Для предварительного выбора метода Interac Combined Pay-in необходимо указывать код платёжного метода в параметре force_payment_method —
interac-cpi
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода Interac Combined Pay-in должен содержать идентификаторы проекта, пользователя и платежа, информацию о пользователе, а также валюту и сумму платежа и подпись:
EPayWidget.run( { payment_id: 'ID_183', payment_amount: 1000, payment_currency: 'CAD', project_id: 238, customer_id: 'customer1', customer_first_name: 'Jane', customer_last_name: 'Doe', customer_phone: '12345678', customer_email: 'jane@example.com', signature: "hlhydUV+SmGJYhm6G47NknsqVx2TdMZrnJ9V5Ly...==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода Interac Combined Pay-in используется стандартный формат, описание которого представлено в разделе Оповещения.
К особенностям метода Interac Combined Pay-in можно отнести то, что имя, фамилия, номер телефона, адрес электронной почты и IP-адрес пользователя, передаются в параметрах first_name
, last_name
, phone
, email
, ip_address
объекта customer_data
.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 8283
была успешно проведена оплата в размере 10,00 CAD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 8283, "payment": { "id": "EP4a54-1d00", "type": "purchase", "status": "success", "date": "2020-12-01T07:32:53+0000", "method": "OnlineBankingViaInteracCpi", "sum": { "amount": 1000, "currency": "CAD" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "first_name": "Jane", "last_name": "Doe", "phone": "1234567890", "email": "doe@example.com", "ip_address": "192.168.20.1" }, "fee": { "amount": 0, "currency": "CAD" }, "merchant_account_id": 8283, "operation": { "id": 50, "type": "sale", "status": "success", "date": "2020-12-01T07:32:53+0000", "created_date": "2020-12-01T07:32:39+0000", "request_id": "5318b90295e48d49e0087f353aceb6ad889589bd06ed64-00000001", "sum_initial": { "amount": 1000, "currency": "CAD" }, "sum_converted": { "amount": 1000, "currency": "CAD" }, "code": "0", "message": "Success", "provider": { "id": 8283, "payment_id": "50", "auth_code": "", "endpoint_id": "IDP" } }, "signature": "OpG9CTFTy5b81NzxYKZbyVNq8XJDOhjCwiym5z6Ig9gQwUWIs7Dpw==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 8283, "payment": { "id": "EP8399-a2e9", "type": "purchase", "status": "decline", "date": "2020-11-24T13:19:33+0000", "method": "OnlineBankingViaInteracCpi", "sum": { "amount": 10000, "currency": "CAD" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "first_name": "Jane", "last_name": "Doe", "phone": "1234567890", "email": "doe@example.com", "ip_address": "192.168.20.1" }, "fee": { "amount": 0, "currency": "CAD" }, "merchant_account_id": 8283, "operation": { "id": 58, "type": "sale", "status": "decline", "date": "2020-11-24T13:19:33+0000", "created_date": "2020-11-24T13:18:51+0000", "request_id": "dbc44e0f97e11bffff8eeaf51bef076e3363662d97d-00000001", "sum_initial": { "amount": 10000, "currency": "CAD" }, "sum_converted": { "amount": 10000, "currency": "CAD" }, "code": "20000", "message": "General decline", "provider": { "id": 8283, "payment_id": "58", "auth_code": "" } }, "signature": "SjrAIoboAsVeNF2r89BDBkIjZEXHNddUY9GaiWlbJfTIn0shkdDRg==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода Interac Combined Pay-in со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
- Осуществить перенаправление в сервис Interac.
- Принять оповещение от платежной платформы ECommPay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через Interac Combined Pay-in.
- От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ECommPay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис Interac.
- На стороне Interac выполняется обработка запроса на оплату.
- От сервиса Interac к платёжной платформе передаются данные для перенаправления пользователя на сайт Interac.
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в Interac в объекте redirect_data.
- Пользователь перенаправляется в сервис Interac.
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса Interac выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса Interac к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Необходимо использовать внутренний гид по стилю Interac Combined Pay-in при разработке отображаемой пользователю платежной страницы. На странице оплаты необходимо обеспечить отображение логотипа или товарного знака (например, текст “INTERAC Combined Pay-in”). При первом использовании слова INTERAC необходимо использовать обозначение ® в надстрочном тексте рядом со словом «INTERAC». Также на этой странице необходимо отобразить строку “® Trade-mark of Interac Corp. Used under license”. Логотипы и гид по стилю можно запросить у курирующего менеджера ECommPay.
Информация о формате запросов и параметрах инициации оплат методом Interac Combined Pay-in через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода Interac Combined Pay-in необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/interac-cpi/sale
, отправляемый методом POST. Этот запрос относится к группе запросов проведения платежей через интернет-банкинг /v2/payment/online-banking/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные идентификационные сведения запроса:
- project_id — идентификатор проекта, полученный от ECommPay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о платеже:
- amount — сумма платежа в минорных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3.
- customer — объект, содержащий сведения о пользователе:
- id — идентификатор, уникальный в рамках проекта,
- ip_address — IP-адрес пользователя;
- general — объект, содержащий основные идентификационные сведения запроса:
- Дополнительно рекомендуется указывать имя, фамилию, номер телефона и адрес электронной почты пользователя. Если параметры отсутствуют в запросе, список недостающих параметров отправляется в оповещении на уточнение. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.
Рекомендуется использовать следующие объекты и параметры:
- customer — объект, содержащий сведения о пользователе:
- first_name — имя,
- last_name — фамилия
- phone — номер телефона,
- email — адрес электронной почты;
- customer — объект, содержащий сведения о пользователе:
- Валютой платежа может быть только CAD.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода Interac Combined Pay-in должен содержать идентификаторы проекта, пользователя и платежа, подпись, информацию о пользователе, валюту и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 125, "payment_id": "ID_184", "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaMeSaRfBaNIipTv+AWoXW\/9MTO8yJA==" }, "customer": { "ip_address": "123.56.38.76", "first_name": "Jane", "last_name": "Doe", "phone": "12345678", "email": "jane@example.com", "id": "123" }, "payment": { "amount": 1000, "currency": "CAD" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса Interac Combined Pay-in необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
{ "type":"redirect", "code":"0", "redirect_data": { "body": [], "method": "POST", "url": "https://example.com/webflow?transaction=12345&token=eyJhbGciOiJI" } }
Формат оповещений
Для оповещений о результатах оплат с применением метода Interac Combined Pay-in используется стандартный формат, описание которого представлено в разделе Оповещения.
К особенностям метода Interac Combined Pay-in можно отнести то, что имя, фамилия, номер телефона, адрес электронной почты и IP-адрес пользователя, передаются в параметрах first_name
, last_name
, phone
, email
, ip_address
объекта customer_data
.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 239
была успешно проведена оплата в размере 10,00 CAD
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 8283, "payment": { "id": "EP4a54-1d00", "type": "purchase", "status": "success", "date": "2020-12-01T07:32:53+0000", "method": "OnlineBankingViaInteracCpi", "sum": { "amount": 1000, "currency": "CAD" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "first_name": "Jane", "last_name": "Doe", "phone": "1234567890", "email": "doe@example.com", "ip_address": "192.168.20.1" }, "fee": { "amount": 0, "currency": "CAD" }, "merchant_account_id": 8283, "operation": { "id": 50, "type": "sale", "status": "success", "date": "2020-12-01T07:32:53+0000", "created_date": "2020-12-01T07:32:39+0000", "request_id": "5318b90295e48d49e0087f353aceb6ad889589bd06ed64-00000001", "sum_initial": { "amount": 1000, "currency": "CAD" }, "sum_converted": { "amount": 1000, "currency": "CAD" }, "code": "0", "message": "Success", "provider": { "id": 8283, "payment_id": "50", "auth_code": "", "endpoint_id": "IDP" } }, "signature": "OpG9CTFTy5b81NzxYKZbyVNq8XJDOhjCwiym5z6Ig9gQwUWIs7Dpw==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 8283, "payment": { "id": "EP8399-a2e9", "type": "purchase", "status": "decline", "date": "2020-11-24T13:19:33+0000", "method": "OnlineBankingViaInteracCpi", "sum": { "amount": 10000, "currency": "CAD" }, "is_new_attempts_available": false, "attempts_timeout": 0, "description": "" }, "customer_data": { "first_name": "Jane", "last_name": "Doe", "phone": "1234567890", "email": "doe@example.com", "ip_address": "192.168.20.1" }, "fee": { "amount": 0, "currency": "CAD" }, "merchant_account_id": 8283, "operation": { "id": 58, "type": "sale", "status": "decline", "date": "2020-11-24T13:19:33+0000", "created_date": "2020-11-24T13:18:51+0000", "request_id": "dbc44e0f97e11bffff8eeaf51bef076e3363662d97d-00000001", "sum_initial": { "amount": 10000, "currency": "CAD" }, "sum_converted": { "amount": 10000, "currency": "CAD" }, "code": "20000", "message": "General decline", "provider": { "id": 8283, "payment_id": "58", "auth_code": "" } }, "signature": "SjrAIoboAsVeNF2r89BDBkIjZEXHNddUY9GaiWlbJfTIn0shkdDRg==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Interac Combined Pay-in доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.
Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.
С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.