«Тинькофф»
Обзор
«Тинькофф» — платёжный метод, который позволяет проводить платежи через интернет-банкинг Тинькофф. Проведение оплат реализовано через Payment Page и Gate, проведение возвратов — через Gate.
Характеристика
Тип платёжного метода | интернет-банкинг |
---|---|
Регионы использования | RU |
Валюты платежей | RUB |
Конвертация валют | – |
Оплаты | + |
Выплаты | – |
Оплаты по сохранённым данным | – |
Полные возвраты | + |
Частичные возвраты | + |
Опротестования | – |
Особенности | – |
Организация и стоимость подключения | по согласованию с курирующим менеджером ecommpay |
Схема работы
В проведении отдельного платежа с использованием «Тинькофф» задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ecommpay, а также технические средства «Тинькофф».
Основные операции
Интерфейсы | Суммы, RUB | |||||
---|---|---|---|---|---|---|
Payment Page | CMS Plug-ins | Gate | Dashboard | минимум | максимум | |
Оплаты | + | – | + | – | 1,00 | 600 000,00 |
Полные возвраты | – | – | + | – | – | – |
Частичные возвраты | – | – | + | – | – | – |
Сценарии использования
Проведение оплат с использованием метода «Тинькофф» выполняется с перенаправлением пользователей к сервису «Тинькофф», проведение возвратов — с уведомлением пользователей через веб-сервис мерчанта.
Рис.: Оплата через Payment Page
Рис.: Оплата через Gate
Рис.: Возврат через Gate
Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.
Оплаты через Payment Page
Общая информация
Для оплаты через Payment Page с использованием метода «Тинькофф» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате оплаты. При этом метод «Тинькофф» можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжных методов). Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Payment Page
- Пользователь на стороне веб-сервиса инициирует оплату.
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Payment Page.
- Запрос на проведение оплаты поступает в платёжную платформу.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- Осуществляется генерация Payment Page согласно настройкам проекта и параметрам вызова.
- Пользователю отображается сгенерированная платёжная форма.
- Пользователь выбирает для оплаты метод «Тинькофф».
- Запрос на проведение оплаты через «Тинькофф» поступает в платёжную платформу.
- Выполняются дальнейшая обработка запроса и его отправка в сервис «Тинькофф».
- На стороне «Тинькофф» выполняется обработка запроса на оплату.
- От сервиса «Тинькофф» к платёжной платформе передаются данные для перенаправления пользователя в сервис «Тинькофф».
- Данные для перенаправления пользователя передаются к Payment Page.
- Пользователь перенаправляется в сервис «Тинькофф».
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса «Тинькофф» выполняется обработка платежа.
- Результат оплаты отображается пользователю в сервисе «Тинькофф».
- Пользователь перенаправляется к Payment Page.
- От сервиса «Тинькофф» к платёжной платформе направляется результат оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От платёжной платформы к Payment Page направляется результат проведения оплаты.
- Результат оплаты отображается пользователю на Payment Page.
Информация о формате запросов и параметрах вызова Payment Page при работе с «Тинькофф», а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.
Формат запросов
При формировании запросов на открытие платёжной формы с применением метода «Тинькофф» необходимо учитывать следующее:
- Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
- project_id — идентификатор проекта, полученный от ecommpay при интеграции;
- payment_id — идентификатор платежа, уникальный в рамках проекта;
- payment_currency — валюта платежа в формате ISO-4217 alpha-3;
- payment_amount — сумма платежа в минорных единицах;
- customer_id — идентификатор пользователя в рамках проекта.
- Валютой платежа может быть только RUB.
- Для предварительного выбора метода «Тинькофф» необходимо указывать код платёжного метода в параметре force_payment_method —
tinkoff-online-banking
. - Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры вызова платёжной формы.
- После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.
Таким образом, корректный запрос на открытие платёжной формы с применением метода «Тинькофф» должен содержать идентификаторы проекта, пользователя и платежа, а также валюту и сумму платежа и подпись:
EPayWidget.run( { payment_id: 'X03936', payment_amount: 10000, payment_currency: 'RUB', project_id: 35, customer_id: 'customer1', signature: "kUi2x9dKHAVNU0FYUkDJrOcZzUCwX6R\/ekpZhkIQg==" } )
Формат оповещений
Для оповещений о результатах оплат с применением метода «Тинькофф» используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 386
была успешно проведена оплата в размере 1,00 RUB
.
Рис.: Пример оповещения о проведении оплаты
{ "project_id": 386, "payment": { "id": "ORDER_105300_49747792", "type": "purchase", "status": "success", "date": "2021-03-18T07:53:06+0000", "method": "tinkoff", "sum": { "amount": 100, "currency": "RUB" }, "description": "" }, "operation": { "id": 926, "type": "sale", "status": "success", "date": "2021-03-18T07:53:06+0000", "created_date": "2021-03-18T07:53:00+0000", "request_id": "714bf268610dabe6123b742cd8e832fc21fd244a-00000001", "sum_initial": { "amount": 100, "currency": "RUB" }, "sum_converted": { "amount": 100, "currency": "RUB" }, "code": "0", "message": "Success", "provider": { "id": 2990, "payment_id": "2b8c54fb289325fea609113d4cbcd0f3", "auth_code": "", "endpoint_id": "tinkoff_bank", "date": "2021-03-18T07:53:06+0000" } }, "signature": "LptHv8D05q9MY8KaFb4A/J...gTfc9r9y+b/WYFknBbPmGg==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 386, "payment": { "id": "ORDER_63707024", "type": "purchase", "status": "decline", "date": "2021-03-18T07:55:10+0000", "method": "tinkoff", "sum": { "amount": 11900, "currency": "RUB" }, "description": "" }, "operation": { "id": 927, "type": "sale", "status": "decline", "date": "2021-03-18T07:55:10+0000", "created_date": "2021-03-18T07:55:08+0000", "request_id": "e5865da3bcfd01b13bbffba7099a66a1de340a6f8-00000001", "sum_initial": { "amount": 11900, "currency": "RUB" }, "sum_converted": { "amount": 11900, "currency": "RUB" }, "code": "20000", "message": "General decline", "provider": { "id": 2990, "payment_id": "73c8eb57ac3be280b206f44a031319d8", "auth_code": "", "endpoint_id": "tinkoff_bank", "date": "2021-03-18T07:55:09+0000" } }, "signature": "8TN1v/PGvbSESGkX/+wQJC...w3MdDYtQ/qGq61PQxCl711rhTkv1g==" }
Дополнительные материалы
Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:
Оплаты через Gate
Общая информация
Для оплаты через Gate с использованием метода «Тинькофф» со стороны веб-сервиса необходимо:
- Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay.
- Осуществить перенаправление в сервис «Тинькофф».
- Принять оповещение от платежной платформы ecommpay о результате оплаты.
Полная схема проведения оплаты представлена далее.
Рис.: Проведение оплаты через Gate
- Пользователь на стороне веб-сервиса инициирует оплату через «Тинькофф».
- От веб-сервиса на заданный URL ecommpay передаётся запрос на проведение оплаты через Gate.
- Запрос на проведение оплаты поступает в платёжную платформу ecommpay.
- Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
- От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
- В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис «Тинькофф».
- На стороне «Тинькофф» выполняется обработка запроса на оплату.
- От сервиса «Тинькофф» к платёжной платформе передаются данные для перенаправления пользователя на сайт «Тинькофф».
- От платёжной платформы к веб-сервису направляется оповещение с данными для перенаправления пользователя в «Тинькофф» в объекте redirect_data.
- Пользователь перенаправляется в сервис «Тинькофф».
- Пользователь выполняет необходимые действия для оплаты.
- На стороне сервиса «Тинькофф» выполняется обработка платежа.
- Пользователю отображается результат оплаты.
- Пользователь перенаправляется к веб-сервису.
- От сервиса «Тинькофф» к платёжной платформе направляется уведомление о результате оплаты.
- От платёжной платформы к веб-сервису направляется оповещение о результате оплаты.
- От веб-сервиса пользователю направляется результат оплаты.
Информация о формате запросов и параметрах инициации оплат методом «Тинькофф» через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на оплаты с применением метода «Тинькофф» необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/tinkoff/sale
, отправляемый методом POST. Этот запрос относится к группе запросов для интернет-банкинга /v2/payment/online-banking/{payment_method}/sale. - В запросе должны использоваться следующие объекты и параметры:
- general — основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа,
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- customer — сведения о пользователе:
- id — идентификатор пользователя в рамках проекта,
- ip_address — используемый IP-адрес;
- payment — сведения о платеже:
- amount — сумма в дробных единицах валюты,
- currency — валюта платежа в формате ISO-4217 alpha-3.
- general — основные сведения:
- Валютой платежа может быть только RUB.
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на оплату с применением метода «Тинькофф» должен содержать идентификаторы проекта, пользователя и платежа, подпись, и IP-адрес пользователя, валюту и сумму платежа:
Рис.: Пример запроса на оплату
{ "general": { "project_id": 35, "payment_id": "Payment 12", "signature": "2tlMuYxLW9Yu6RETr8pdCfbOQ+9ajAteg5lPk96Q==" }, "customer": { "ip_address": "1.1.1.1", "id": "customer1" }, "payment": { "amount": 10000, "currency": "RUB" } }
Форматы данных для перенаправления пользователей
Для перенаправления пользователя от веб-сервиса на сайт сервиса «Тинькофф» необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.
Далее приведён фрагмент оповещения, содержащего данные для перенаправления.
"redirect_data": { "method": "GET", "body": {...}, "url": "http://example.com/example/a/acs/29d7454b70adad712aa5b536d449c7f7" }
Формат оповещений
Для оповещений о результатах оплат с применением метода «Тинькофф» используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 386
была успешно проведена оплата в размере 1,00 RUB
.
Рис.: Пример оповещения о проведенной оплате
{ "project_id": 386, "payment": { "id": "ORDER_105300_49747792", "type": "purchase", "status": "success", "date": "2021-03-18T07:53:06+0000", "method": "tinkoff", "sum": { "amount": 100, "currency": "RUB" }, "description": "" }, "operation": { "id": 926, "type": "sale", "status": "success", "date": "2021-03-18T07:53:06+0000", "created_date": "2021-03-18T07:53:00+0000", "request_id": "714bf268610dabe6123b742cd8e832fc21fd244a-00000001", "sum_initial": { "amount": 100, "currency": "RUB" }, "sum_converted": { "amount": 100, "currency": "RUB" }, "code": "0", "message": "Success", "provider": { "id": 2990, "payment_id": "2b8c54fb289325fea609113d4cbcd0f3", "auth_code": "", "endpoint_id": "tinkoff_bank", "date": "2021-03-18T07:53:06+0000" } }, "signature": "LptHv8D05q9MY8KaFb4A/J...gTfc9r9y+b/WYFknBbPmGg==" }
В следующем примере оплата была отклонена.
Рис.: Пример оповещения об отказе в проведении оплаты
{ "project_id": 386, "payment": { "id": "ORDER_63707024", "type": "purchase", "status": "decline", "date": "2021-03-18T07:55:10+0000", "method": "tinkoff", "sum": { "amount": 11900, "currency": "RUB" }, "description": "" }, "operation": { "id": 927, "type": "sale", "status": "decline", "date": "2021-03-18T07:55:10+0000", "created_date": "2021-03-18T07:55:08+0000", "request_id": "e5865da3bcfd01b13bbffba7099a66a1de340a6f8-00000001", "sum_initial": { "amount": 11900, "currency": "RUB" }, "sum_converted": { "amount": 11900, "currency": "RUB" }, "code": "20000", "message": "General decline", "provider": { "id": 2990, "payment_id": "73c8eb57ac3be280b206f44a031319d8", "auth_code": "", "endpoint_id": "tinkoff_bank", "date": "2021-03-18T07:55:09+0000" } }, "signature": "8TN1v/PGvbSESGkX/+wQJC...w3MdDYtQ/qGq61PQxCl711rhTkv1g==" }
Дополнительные материалы
Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:
Возвраты через Gate
Общая информация
«Тинькофф» поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода «Тинькофф» со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ecommpay и принять оповещение о результате. Полная схема проведения возврата представлена далее.
Рис.: Проведение возврата через Gate
- Пользователь запрашивает возврат средств в веб-сервисе.
- От веб-сервиса мерчанта на заданный URL ecommpay передаётся запрос на проведение возврата через Gate.
- Gate перенаправляет запрос в платёжную платформу ecommpay для дальнейшей обработки.
- На стороне платёжной платформы ecommpay выполняются необходимые проверка и первичная обработка запроса.
- От платёжной платформы в веб-сервис передается ответ с результатом первичной обработки запроса. Подробнее см. в разделе Формат ответа.
- Обработанный запрос передается в сервис «Тинькофф».
- На стороне «Тинькофф» выполняется обработка платежа.
- От «Тинькофф» к платёжной платформе ecommpay направляется оповещение о результате.
- От платёжной платформы ecommpay к веб-сервису направляется оповещение о результате.
- Пользователь получает от веб-сервиса информацию о поступлении запрошенных средств.
Информация о формате запросов и параметрах инициирования возвратов методом «Тинькофф» через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API см. в разделе Работа с API.
Формат запросов
При работе с запросами на возврат с применением метода «Тинькофф» необходимо учитывать следующее:
- Должен использоваться запрос
/v2/payment/online-banking/tinkoff/refund
, отправляемый методом POST. Этот запрос относится к группе запросов для интернет-банкинга /v2/payment/online-banking/{payment_method}/refund. - В запросе должны использоваться следующие объекты и параметры:
- general — объект, содержащий основные сведения:
- project_id — идентификатор проекта,
- payment_id — идентификатор платежа;
- signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
- payment — объект, содержащий сведения о возврате:
- amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате);
- currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате);
- description — комментарий или описание возврата.
- general — объект, содержащий основные сведения:
- Дополнительно могут использоваться все параметры, указанные в спецификации.
Таким образом, корректный запрос на возврат с применением метода «Тинькофф» должен содержать идентификаторы проекта и платежа, подпись, описание возврата:
Рис.: Пример запроса на возврат
{ "general": { "project_id": 239, "payment_id": "refund_02", "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg==" }, "payment": { "amount": 10000, "currency": "RUB", "description": "refund_02" } }
Формат оповещений
Для оповещений о результатах возврата с применением метода «Тинькофф» используется стандартный формат, описание которого представлено в разделе Оповещения.
В следующем примере оповещение свидетельствует о том, что в рамках проекта 386
для пользователя был успешно проведён возврат в размере 1,00 RUB
.
Рис.: Пример оповещения о проведении возврата
{
"project_id": 386,
"payment": {
"id": "ORDER_78028507",
"type": "purchase",
"status": "refunded",
"date": "2021-03-18T07:56:14+0000",
"method": "tinkoff",
"sum": {
"amount": 0,
"currency": "RUB"
},
"description": ""
},
"operation": {
"id": 929,
"type": "refund",
"status": "success",
"date": "2021-03-18T07:56:14+0000",
"created_date": "2021-03-18T07:56:13+0000",
"request_id": "881f8e135923d239046db018ce7efd44abfb8d25-00000001",
"sum_initial": {
"amount": 100,
"currency": "RUB"
},
"sum_converted": {
"amount": 100,
"currency": "RUB"
},
"code": "0",
"message": "Success",
"provider": {
"id": 2990,
"payment_id": "4ee45ac499e58ff04ce4b22e755bc45c",
"auth_code": "",
"date": "2021-03-18T07:56:13+0000"
}
},
"signature": "x4/yXU/Ii4TD8a5Oon2kI+h1/...pyPVbprQshEqsaeorJSpZObBQ=="
}
В следующем примере возврат был отклонён.
Рис.: Пример оповещения об отказе в проведении возврата
{ "project_id": 386, "payment": { "id": "ORDER_105757_66943154", "type": "purchase", "status": "success", "date": "2021-03-18T07:58:06+0000", "method": "tinkoff", "sum": { "amount": 31500, "currency": "RUB" }, "description": "" }, "operation": { "id": 931, "type": "refund", "status": "decline", "date": "2021-03-18T07:58:06+0000", "created_date": "2021-03-18T07:58:05+0000", "request_id": "76a486d4ff02c763cdf6623a55159bb51baf96-00000001", "sum_initial": { "amount": 31500, "currency": "RUB" }, "sum_converted": { "amount": 31500, "currency": "RUB" }, "code": "20000", "message": "General decline", "provider": { "id": 2990, "payment_id": "435010f132ec0f26883ca15ca28acefd", "auth_code": "" } }, "signature": "vz+xV90xccM49uNen3YG7Ht...j92ffMJ4vwpalWVJoRH4YoA==" }
Дополнительные материалы
Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:
Тестирование
Общая информация
Для метода «Тинькофф» доступно тестирование оплат через Gate, а также возвратов через Gate.
Тестирование может выполняться в рамках тестового проекта, и для подключения и отключения этой функциональности необходимо обращаться к специалистам технической поддержки ecommpay support@ecommpay.com.
При проведении тестовых платежей следует учитывать, что в запросах должен указываться идентификатор тестового проекта, в качестве валюты может использоваться только RUB, а интерфейс эмулятора «Тинькофф» может отличаться от рабочего.
Статусы тестовых платежей
При тестировании оплат их итоговые статусы определяются исходя из сумм, указанных в запросах:
decline
— при указании суммы40000
или40400
,success
— при указании любой другой суммы;
При тестировании возвратов их итоговые статусы определяются исходя из сумм, указанных в запросах:
decline
— при указании суммы50000
или50500
,success
— при указании любой другой суммы.
Оплаты через Gate
Для проведения тестовой оплаты через Gate необходимо:
- Отправить в платёжную платформу корректный тестовый запрос на оплату.
- Принять оповещение с данными для перенаправления.
- Перейти по полученному URL и щёлкнуть кнопку Success или Decline (в зависимости от запрашиваемой суммы) — на странице эмулятора.
- Принять оповещение с информацией о результате оплаты.
Подробная информация о проведении оплат с использованием метода «Тинькофф» через Gate представлена в пункте Оплаты через Gate.
Возвраты через Gate
Для проведения тестового возврата через Gate необходимо отправить в платёжную платформу корректный тестовый запрос на возврат средств, полученных по ранее проведенной тестовой оплате, и принять оповещение с информацией о результате.
Следует учитывать, что выполнение тестового возврата на полную или частичную сумму возможно только в течение суток после проведения оплаты. Подробная информация о проведении возвратов с использованием метода «Тинькофф» через Gate представлена в пункте Возвраты через Gate.
Анализ результатов проведения платежей
Как и при работе с другими платёжными методами, которые предоставляет ecommpay, при использовании метода «Тинькофф» доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.
Всю необходимую информацию можно получать и анализировать средствами Dashboard, в том числе с помощью аналитических панелей в разделе Аналитика.
Также можно выгружать необходимую информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:
- Dashboard позволяет выгружать данные в формате CSV с помощью инструментов в разделе Отчёты. При этом можно выполнять разовые и периодические выгрузки информации на локальный компьютер.
- Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы к конечной точке /operations/get.
С любыми вопросами о возможностях анализа результатов можно обращаться в службу технической поддержки ecommpay.