Платежный виджет

Платежный виджет — всплывающая форма для ввода реквизитов карты и e-mail адреса плательщика. Виджет автоматически определяет тип платежной системы: Visa, MasterCard, Maestro, а также банк-эмитент карты и показывает соответствующие логотипы. Форма оптимизирована для использования в любых браузерах и мобильных устройствах. Внутри виджета открывается iframe, который гарантирует безопасность передачи карточных данных и не требует от ТСП сертификации для использования.

Платежный виджет CloudPayments
Установка

Для установки виджета необходимо прописать на сайте скрипт в раздел head

Для появления платежной формы, зарегистрировать функцию для вызова методов charge или auth

и прописать вызов функции на событие, например, нажатие кнопки «Оплатить».

Параметры

Вызов функции charge или функции auth определяет схему проведения оплаты: charge для одностадийной, auth — для двухстадийной.

Параметр Формат Применение Описание
publicId String Обязательный Идентификатор сайта, находится в ЛК.
description String Обязательный Описание назначения оплаты в произвольном формате
amount Float Обязательный Сумма оплаты
currency String Обязательный Валюта: KZT/RUB/USD/EUR/GBP (см. справочник)
invoiceId String Необязательный Номер заказа или счета
accountId String Обязательный для создания подписки Идентификатор пользователя
email String Необязательный E-mail адрес пользователя
requireEmail bool Необязательный Требовать указания e-mail адреса пользователя в виджете
data Json Необязательный Любые другие данные, которые будут связаны с транзакцией.
Мы зарезервировали названия следующих параметров и отображаем их содержимое в реестре операций, выгружаемом в Личном Кабинете: name, firstName, middleName, lastName, nick, phone, address, comment, birthDate.


Также можно определить поведение формы в случае успешной или неуспешной оплаты следующими параметрами:
Параметр Формат Применение Описание
onSuccess Function или String Необязательный Указывается либо функция, либо адрес страницы сайта. В случае указания функции, она будет вызвана после успешного завершения оплаты. В случае адреса — пользователь будет направлен на указанную страницу.
onFail Function или String Необязательный Указывается либо функция, либо адрес страницы сайта. В случае указания функции, она будет вызвана после неуспешного завершения платежа. В случае адреса — пользователь будет направлен на указанную страницу.
Локализация

По умолчанию мы отображаем виджет на русском языке и временной зоной Алматы. Для вызова виджета, локализованного для других языков, передайте в параметрах инициализации виджета параметр language.

Список поддерживаемых языков:

Язык Часовой пояс Код
Русский MSK ru-RU
Английский CET en-US
Азербайджанский AZT az
Русский ALMT kk
Рекуррентные платежи

После успешного завершения оплаты, виджет может автоматически создавать подписку на рекуррентные платежи. Для это нужно добавить несколько параметров запуска:

Параметр Формат Применение Описание
Interval String Обязательный Интервал. Возможные значения: Day, Week, Month.
Period Int Обязательный Период. В комбинации с интервалом, 1 Month значит раз в месяц, а 2 Week — раз в две недели.
MaxPeriods Int Необязательный Максимальное количество платежей в подписке. По умолчанию без ограничений.
Amount Numeric Необязательный Сумма регулярного платежа. По умолчанию совпадает с суммой первого (установочного) платежа.
StartDate DateTime Необязательный Дата и время первого регулярного платежа. По умолчанию запуск произойдет через указанный интервал и период, например через месяц.


Параметры для запуска регулярных платежей необходимо добавить в объект data.cloudPayments.recurrent по примеру ниже:


Обратите внимание, что подписка будет создана только при указании параметра accountId, который может быть e-mail адресом, номером телефона или любым другим идентификатором плательщика.


Больше примеров создания рекуррентных платежей из виджета вы можете найти в разделе "Сценарии интеграции".


Для отмены рекуррентных платежей используйте возможности личного кабинета, API или предоставьте покупателю ссылку на сайт системы — https://my.cloudpayments.ru/unsubscribe, где он самостоятельно сможет найти и отменить свои подписки.

Мобильный виджет

Скрипт автоматически определяет устройство пользователя и запускает наиболее подходящий вариант виджета: обычный либо оптимизированный для мобильных устройств. Для удобства покупателей, мобильная версия виджета открывается в новом окне и занимает весь экран.

Платежный виджет CloudPayments

Все параметры и функции обычного и мобильного виджетов являются идентичными.
Для предотвращения блокировки нового окна при запуске виджета в асинхронном режиме, либо в результате вызова ajax функции, мобильный виджет может показывать промежуточную кнопку "Перейти к оплате" перед открытием. Если вы запускаете виджет напрямую после действия пользователя (клик по кнопке или ссылке), вы можете отключить промежуточную кнопку параметром startWithButton.