Справка

Hosted Fields позволяют встроить поля ввода карты на ваш сайт или в приложение, полностью адаптируя их под дизайн системы. Они создают ощущение целостности интерфейса и исключают необходимость перенаправления клиента на внешнюю страницу оплаты. Это повышает удобство использования и конверсию.

Поля ввода для номера карты, даты истечения и CVC представляют собой iFrame. Мы даем возможность полностью кастомизировать их CSS и встроить на ваш сайт в виде единого фрейма.

Видеоинструкция

Настройка

<span class="u-richtext-counter">1</span> В разделе <span class="u-richtext-element">Настройки</span> → <span class="u-richtext-element">Интеграции</span> → <span class="u-richtext-element">Мои сайты</span> включите опцию Hosted Fields для нужной интеграции.

<span class="u-richtext-counter" id="domains">2</span> Нажмите кнопку <span class="u-richtext-element">Настройка Hosted Fields</span> и укажите домены, на которых будут использоваться Hosted Fields. Вводите каждый домен или поддомен с новой строки, без «https://», например: <span class="u-richtext-element">mysite.com</span>. Чтобы разрешить все поддомены, используйте маску со звёздочкой, например: <span class="u-richtext-element">*.mysite.com</span>.

При необходимости адаптируйте стили CSS для полей ввода.

<span class="u-richtext-counter">3</span> На странице оплаты вашего сайта разместите iFrame, задайте ему произвольный параметр <span class="u-richtext-element">id</span>, а в параметре <span class="u-richtext-element">src</span> укажите ссылку на оплату (payment_url), которую возвращает Allpay в ответ на запрос на создание платежа (см. раздел Payment request в документации API). Ссылки на оплату также можно генерировать через Allpay API Tester.‍

<span class="u-richtext-counter">4</span> На странице оплаты разместите следующий скрипт:

<script src="https://allpay.to/js/allpay-hf.js"></script>
    <script>
    let Allpay = new AllpayPayment(
        {
            iframeId: 'iframe_id',
            onSuccess: function() { alert('Payment success'); },
            onError: function(error_n, error_msg) { alert('Payment error: ' + error_n + ' (' + error_msg + ')'); }
        }
    );
    </script>

‍

В скрипте замените следующие параметры на ваши:

• <span class="u-richtext-element">iframeId</span> — значение id вашего iFrame.
• <span class="u-richtext-element">onSuccess</span> — обработчик успешного завершения платежа (что должно произойти после успешной оплаты).
• <span class="u-richtext-element">onError</span> — обработчик ошибки платежа. Используя шаблон в скрипте, вы можете выводить текст ошибки оплаты.

<span class="u-richtext-counter">5</span> Для запуска процесса выполните функцию <span class="u-richtext-element">Allpay.pay()</span>. Например, назначив ее для кнопки «Pay»:

<button onclick="Allpay.pay();">Pay</button>

‍

Рассрочка

Если при создании платежа вы включили для клиента опцию рассрочки, передав значение в параметре <span class="u-richtext-element">inst</span>, тогда во фрейме автоматически появится поле для выбора количества платежей.

Кнопки быстрой оплаты

Кнопки Apple Pay и Bit не будут отображаться в предпросмотре и во фрейме, если они не активированы в разделе <span class="u-richtext-element">Настройки</span> → <span class="u-richtext-element">Модули</span>.

Также кнопки не отображаются в тестовом режиме и в рабочем режиме для оплат с опциями рассрочки и подписки.

Кнопка Apple Pay

Чтобы кнопка Apple Pay работала корректно, задайте атрибут <span class="u-richtext-element">allow="payment *"</span> в теге <span class="u-richtext-element">iframe</span>. Пример:

<iframe id="myPaymentIframe" allow="payment *" src="..." >

Также на вашем сервере потребуется разместить сертификат Apple Pay. Чтобы получить его обратитесь в поддержку.

Встравание в mobile app (WebView)

Если вы встраиваете страницу оплаты в мобильное приложение с помощью WebView (android.webkit.WebView или WKWebView), некоторые способы оплаты могут работать некорректно. Например, Bit или подтверждение 3D Secure могут перенаправлять пользователя в платёжное приложение либо приложение банка с помощью специальных ссылок, таких как <span class="u-richtext-element">intent://</span>

В отличие от обычного браузера, WebView не всегда обрабатывает такие переходы автоматически. В результате пользователь может не перейти во внешнее приложение и не завершить оплату.

Рекомендуем открывать страницу оплаты через системную браузерную вкладку:

• Chrome Custom Tabs — на Android;
• SFSafariViewController — на iOS.

Эти компоненты работают аналогично обычному мобильному браузеру и лучше поддерживают переходы в платёжные и банковские приложения.

Если необходимо использовать WebView, обрабатывайте навигацию на стороне мобильного приложения:

• обычные ссылки <span class="u-richtext-element">http://</span> и <span class="u-richtext-element">https://</span> открывайте внутри WebView;
• ссылки с другими схемами передавайте операционной системе для открытия соответствующего приложения;
• если приложение не установлено, используйте предусмотренную ссылку для перехода в браузер, App Store или Google Play.

Эта особенность связана с обработкой внешних ссылок внутри WebView, а не с работой Hosted Fields.

По умолчанию сумма платежа в рассрочку зачисляется ежемесячными частями — в зависимости от количества платежей, выбранных клиентом при оплате.

Например, если сумма была разбита на 10 платежей, средства будут поступать по 1/10 суммы в течение 10 месяцев, по мере списания с карты клиента.

Однако бизнес может получить всю сумму сразу — вместе с первой выплатой. При этом у клиента сумма продолжит списываться частями по обычному графику рассрочки.

При использовании услуги «шерут никайон» (שירות ניכיון) кредитная компания выплачивает продавцу всю сумму сразу, удерживая дополнительную комиссию, а затем самостоятельно получает эти средства от клиента по частям.

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

Требования

Так как выплата полной суммы использует механизм кредитования, перед подключением услуги должны быть соблюдены три условия:

1. Возраст владельца бизнеса — не менее 21 полного года.
2. Использование Allpay не менее трёх месяцев.
3. Общий оборот за всё время не менее 15 000 ILS.

Эти критерии позволяют оценить платежную активность бизнеса и снизить риски chargeback — ситуаций, когда бизнес получает выплату на значительную сумму, а владелец карты заявляет о несанкционированном списании.

Подключение

Услуга активируется в разделе <span class="u-richtext-element">Настройки</span> ➙ <span class="u-richtext-element">Платежные модули</span> ➙ <span class="u-richtext-element">Рассрочка авансом</span>.

После запроса активации мы отправим документы на подпись. После утверждения кредитной компанией модуль будет включен. Проверка обычно занимает 5–7 рабочих дней.

Все платежи с рассрочкой, полученные после одобрения услуги, автоматически перейдут на механизм зачисления полной суммой.

Услуга не действует ретроактивно, то есть не применяется к платежам, проведенным до ее активации.

Отключение

Отключить модуль можно в том же разделе модулей. Отключение занимает 5-7 рабочих дней. После отключения вы получите е-мейл уведомление.

Повторная активировация модуля возможна только через 30 дней.

<span id="fee">Комиссия</span>

За ускоренную выплату кредитная компания взимает дополнительную комиссию. Размер комиссии и принцип ее расчета указан на странице тарифа.

В настройках модуля доступен переключатель <span class="u-richtext-element">Переложить комиссию на клиента</span> Если он включен и клиент выбирает разбивку на два или более платежа, на странице оплаты отображается размер дополнительной комиссии. Эта комиссия добавляется к исходной сумме платежа и списывается с клиента.

Для расчета используется формула gross-up. Ее суть в том, что комиссия рассчитывается от итоговой суммы, включающей исходную сумму платежа и саму комиссию. Нельзя просто рассчитать комиссию от исходной суммы и добавить ее сверху, поскольку после увеличения суммы размер комиссии также изменится.

Формула gross-up определяет такую итоговую сумму списания, чтобы после удержания комиссии бизнес получил ровно исходную сумму платежа:

Итоговая сумма = исходная сумма ÷ (1 − ставка комиссии)

Комиссия клиента = итоговая сумма − исходная сумма

Подписки — это рекуррентные (повторяющиеся) списания с карты клиента без необходимости повторного ввода данных карты. На иврите "ораат кева", что дословно переводится как "постоянное поручение".

Активируйте модуль подписок в разделе <span class="u-richtext-element">Настройки</span> --> <span class="u-richtext-element">Модули.</span>

Обзор модуля подписок

‍

Создание подписки

<span class="u-richtext-counter">1</span> При создании платежной ссылки разверните раздел «Дополнительно» и измените тип платежа на «Подписка».

<span class="u-richtext-counter">2</span> Укажите, когда подписка должна быть начата и завершена и нажмите на кнопку «Создать ссылку».

<span class="u-richtext-counter">3</span> Когда клиент оформит подписку по данной ссылке, она появится на главном экране в меню «Подписки».

Опции начала подписки

‍«Сразу» — первое списание произойдет в момент оформления подписки, а затем — в этот же день каждого месяца.

‍«День месяца» — первое списание произойдет в указанное число месяца и будет повторяться ежемесячно в этот день. Если указанное число совпадает с датой оформления подписки, списание произойдет сразу. Если выбрано 30 или 31 число, а в месяце его нет, списание пройдет в последний день месяца (например, в феврале — 28-го).‍

«Через N дней» — первое списание произойдет через указанное количество дней после оформления подписки и затем продолжится ежемесячно в этот же день.

‍«Дата» — первое списание пройдет в выбранную дату. Если указанная дата уже прошла, оформить подписку не получится.

Если первое списание отложено, при оформлении подписки не проверяется валидность карты, так как не уходит запрос в банк, выпустивший карту. Поэтому подписка может быть создана с неверными данными карты, а ошибка обнаружится только при первом списании. Чтобы проверить карту сразу, выберите вариант «Сразу».

Опции завершения подписки

«Бессрочно» — списания будут продолжаться, пока подписка не будет отменена через личный кабинет.

‍«После N списаний» — подписка завершится после указанного количества списаний. Например, для подписки на год установите 12.

‍«Дата» — списания будут продолжаться до выбранной даты. Если указана дата 15 августа 2030 года, а списания происходят 16-го числа каждого месяца, последнее списание пройдет 15 июля 2030 года, а в августе уже не случится.

Статусы подписок

<span class="u-richtext-element" style="background-color: rgba(68, 203, 138, 0.5)">Активна</span> — списания идут успешно.

<span class="u-richtext-element" style="background-color: rgba(113, 124, 144, 0.2)">Завершена</span> — все списания успешно прошли.

<span class="u-richtext-element" style="background-color: rgba(242, 201, 76, 0.8)">Отменена</span> — вы отменили списания по подписке.

<span class="u-richtext-element" style="background-color: rgba(221, 94, 94, 0.4)">Ошибка</span> — списание не удалось, система сделает ещё 6 попыток.

Отслеживание подписок

Списания по подпискам отражаются в двух разделах: 1) на главном экране платежей наряду с другими платежами; 2) в разделе «Подписки», где можно видеть график списаний по конкретной подписке.

Уведомления о списаниях по подпискам направляются по e-mail и в Telegram, как и для обычных платежей, если в разделе <span class="u-richtext-element">Настройки</span> ➙ <span class="u-richtext-element">Уведомления</span> активирована опция уведомлений.

Отмена подписки

В настройках нужной подписки выберите «Отменить подписку». Клиент получит е-мейл уведомление, что его подписка была отменена.

Нет возможности возобновить списания по отмененной подписке. Клиенту потребуется оформить подписку заново.

Ошибка списания

Очередное списание по подписке может не пройти если карта имеет недостаточный баланс или её кредитный лимит исчерпан, если истек срок действия карты или она была аннулирована.

В случае неудачного списания система сделает ещё 6 попыток — по одной в день. Если все попытки окажутся неудачными, то у подписки сохранится статус «Ошибка», а в истории списаний появится запись «Подписка остановлена». 

В меню управления такой подпиской появится опция «Повторить попытку списания», чтобы выполнить новое списание вручную. Перед попыткой такого списания рекомендуем уточнить у клиента, всё ли в порядке с картой.

Если при оформлении подписки с первым списанием «Сразу» первая попытка оплаты завершится ошибкой, например из-за недостатка средств на карте, подписка всё равно будет создана со статусом «Ошибка». После этого система автоматически запланирует повторную попытку списания.

Подписки не заменяют рассрочку

Так как рассрочка (ташлумим) работает только по израильским кредитным картам, некоторые клиенты используют подписки для получения оплаты от зарубежных клиентов с разбивкой на платежи.

Важно понимать, что в случае рассрочки вы гарантированно получите свои деньги, даже если на момент очередного списания баланс карты клиента будет недостаточным, тогда как в случае подписки списание не удастся.

Лайфхак: разовое списание с отложенной датой

Подписку можно использовать не только для регулярных платежей, но и для разового списания в будущем.

Для этого при создании подписки выберите опцию «Дата» или «Через N дней» и укажите, когда должно произойти первое списание. В настройках завершения выберите «После N списаний» и установите значение 1.

Клиент введёт данные карты сразу, а фактическое списание произойдёт в назначенную дату или через указанное количество дней. После единственного платежа подписка завершится автоматически — отменять её вручную не нужно.

Это удобно, например, для предзаказов, бронирований или отложенной оплаты услуг: вы фиксируете клиента и способ оплаты сейчас, а платёж проводите в нужный момент.

При этом работают все стандартные механизмы подписок: клиент получает уведомление об оформлении, а если списание в назначенный день не удастся, система выполнит ещё шесть попыток — по одной в день.

Токен — это зашифрованное представление банковской карты клиента, которое хранится в платежной системе.

Клиент вводит данные карты один раз, после чего они сохраняются в виде токена. В дальнейшем внешняя система использует этот токен для проведения новых списаний без повторного ввода данных карты. Сумма каждого списания может быть разной.

Для SaaS-сервисов API-эндпоинты Allpay для работы с токенами обеспечивают более гибкое управление биллингом, чем API подписок. Получив токен карты, ваша система может передавать его через API при каждом новом платеже, самостоятельно определяя сумму, дату и условия списания. Это позволяет менять тарифы и реализовывать собственные сценарии повторных платежей в соответствии с бизнес-моделью продукта.

Поэтому для построения биллинга в SaaS-продуктах мы рекомендуем использовать API-эндпоинты для работы с токенами.

Приведённые ниже рекомендации помогут создать простой и понятный интерфейс управления биллингом.

Согласие на будущие списания

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

Покажите стоимость, периодичность платежей, дату первого списания и условия отмены подписки. Если сумма может меняться, объясните, от чего она зависит.

Клиент должен явно подтвердить согласие на последующие автоматические списания.

Автоматические повторные попытки

Если платеж не прошёл, например из-за недостатка средств, настройте автоматические повторные попытки.

Рекомендуется делать 5–7 попыток, постепенно увеличивая интервал между ними.

Сообщите клиенту о неудачном списании и дайте ему возможность пополнить счёт или обновить карту до следующей попытки.

Повтор платежа вручную

Добавьте кнопку «Повторить платеж», чтобы клиент мог самостоятельно инициировать списание после устранения проблемы.

Кнопка должна оставаться доступной, пока платеж не будет успешно проведён или отменён.

Управление картами

Позвольте клиенту добавить новую карту, выбрать основную и удалить сохранённую карту.

В интерфейсе показывайте бренд и последние четыре цифры карты.

Сначала выполняйте списание с основной карты. Если платеж не прошёл, попробуйте списать средства с резервной. Это снижает риск приостановки сервиса.

История операций

Показывайте в истории все успешные и неудачные списания, а также возвраты.

Для каждой операции укажите сумму, дату и статус. Для возврата также покажите связанную с ним исходную транзакцию.

Простая отмена подписки

Кнопка отмены подписки должна быть заметной и доступной.

После отмены прекратите дальнейшие списания. Не удаляйте сохранённую карту автоматически, если клиент сам этого не запросил. Предоставьте отдельную возможность удалить её.

Понятная информация о тарифе

Покажите клиенту:

• название тарифа;
• стоимость подписки;
• налоги и комиссии;
• периодичность платежей;
• дату следующего списания;
• итоговую сумму.

Клиент должен понимать за что, когда и сколько он платит.

Уведомления

Сообщайте клиенту о важных событиях:

• предстоящем списании, если его сумма изменилась;
• успешном продлении;
• неудачном списании;
• изменении стоимости;
• возврате средств;
• отмене подписки.

Уведомления можно отправлять по электронной почте или другим доступным способом, а также показывать в интерфейсе.

Еженедельные (ускоренные) выплаты позволяют получать деньги чаще, чем при стандартном графике раз в месяц.

Схема работы

После того как клиент совершает платеж, он обрабатывается в течение 3–7 рабочих дней. Сразу после обработки платеж попадает на баланс выплат и становится доступным для перевода на счет.

Каждый понедельник выполняется автоматическая выплата доступных средств. Как правило, в течение трех рабочих дней деньги отражаются на вашем банковском счете.

Если нужно, вы можете не дожидаться понедельника и запросить выплату вручную.

Примеры

• Платеж совершен в воскресенье и обработан в четверг — он попадет в выплату в ближайший понедельник.
• Платеж совершен в пятницу и обработан во вторник. Понедельник, пришедшийся на период обработки, будет пропущен, и перевод произойдет в следующий понедельник, если вы не запросите выплату ранее вручную.

Требования

Перед подключением модуля должны быть соблюдены три условия:

1. Возраст владельца бизнеса — не менее 21 полного года.
2. Использование Allpay не менее трёх месяцев.
3. Общий оборот за это время не менее 15 000 ILS.

Эти критерии позволяют оценить платежную активность бизнеса и снизить риски chargeback — ситуаций, когда бизнес получает выплату на значительную сумму, а владелец карты заявляет о несанкционированном списании.

Действие модуля распространяется только на те платежи, которые были получены после его активации (не имеет обратной силы).

Подключение

Модуль активируется в разделе <span class="u-richtext-element">Настройки</span> ➙ <span class="u-richtext-element">Платежные модули</span> ➙ <span class="u-richtext-element">Еженедельные выплаты</span>

После запроса активации мы отправим документы на подпись. После утверждения кредитной организацией модуль будет включен. Проверка обычно занимает 5-7 рабочих дней.

После одобрения выплаты автоматически переключатся с ежемесячных на еженедельные.

Отключение

Отключить модуль можно в том же разделе модулей. Отключение занимает 5-7 рабочих дней. После отключения вы получите е-мейл уведомление.

Повторная активировация модуля возможна только через 30 дней.

Комиссии

Так как еженедельные выплаты считаются ускоренными, кредитная организация взимает дополнительную комиссию с каждого платежа.

Размер комиссии и принцип ее расчета указан на странице тарифа.

Комиссия начисляется даже если вы временно используете ручной режим выплат, так как ускоренная обработка уже выполнена и платеж доступен к выплате.

Чтобы перестать платить дополнительную комиссию и вернуться к стандартному ежемесячному графику, отключите модуль еженедельных выплат. Новые условия применяются только к платежам, совершенным после отключения.

Уведомления и документы

Уведомления о выплатах приходят на e-mail и в Телеграм, если эти опции включены в разделе <span class="u-richtext-element">Настройки</span> ➙ <span class="u-richtext-element">Уведомления.</span>

Каждого 11-го числа в истории выплат появляется разбивка по платежам за месяц и квитанция за комиссию, которую можно использовать для бухгалтерской отчетности.

Чтобы клиент мог выбирать количество товара на странице оплаты, в разделе <span class="u-richtext-element">Настройки</span> ➙ <span class="u-richtext-element">Платежные ссылки</span> активируйте опцию <span class="u-richtext-element">Управлять количеством</span>

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

Если минимальное количество единиц установить равным 0 (нулю), клиент сможет исключить этот товар из оплаты.

Общее оставшееся количество отображается на плитке платежной ссылки. Когда наличие исчерпано (равно нулю), платежная ссылка автоматически отключится.

Если общее количество не установлено (то есть клиент может выбрать любое количество товара без ограничения), то на платежной ссылке отображается символ бесконечности.

Одновременная покупка последнего товара

Когда несколько клиентов одновременно пытаются купить последний товар, покупка будет успешной у того, кто совершит оплату первым.

Например, если в наличии осталось 5 штук, и клиент А пытается купить все 5, а одновременно с ним клиент Б покупает 2 штуки и оплачивает первым, то клиент А увидит сообщение, что в наличии осталось только 3 штуки.

В свойствах отклоненных платежей можно увидеть название ошибки и понять причину.

Коды ошибок

Refusal by credit company. Please try a different card (20004)

Платёж не был одобрен банком, выпустившим карту. Для израильских карт это чаще всего связано с превышением кредитного лимита (мисгерет) или недостатком средств на счёте при оплате дебетовой картой. Для иностранных карт банк мог отклонить платёж, сочтя его подозрительным. В обоих случаях держателю карты следует обратиться в свой банк, чтобы уточнить причину отказа.

Payment is not approved for debit cards (20010)

Попытка осуществить платеж в рассрочку по дебетовой карте. Такие платежи возможны только по кредитным картам и только выпущенным в Израиле. Больше информации.

Verification failed, please try again (21017)

Владелец карты не прошёл проверку 3DS: не ввёл код из SMS, не подтвердил платёж в приложении банка или не завершил проверку другим способом, предусмотренным банком.

1. Откройте эту ссылку в браузере Safari: Allpay App
2. В меню браузера нажмите "Поделиться" (Share) и затем "Добавить на домашний экран" (Add to Home screen).
3. Сохраните.