Инструкция по интеграции кнопки «Купить в рассрочку» или «Купить в кредит» на сайт

Как подготовиться к интеграции кнопки на сайт?

Следуйте этой инструкции:

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

    В карточке товара. Вставьте кнопку рядом с другой кнопкой — «Купить».

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

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

  3. Определитесь, нужно ли вам автоподтверждение. Эта функция подойдет магазинам, которые всегда готовы выдать товар: им не нужно проверять наличие на складе и сверяться с системой учета. Остальным можно выбрать ручное подтверждение через личный кабинет агента или с помощью API.

    Автоподтверждение можно включить в личном кабинете руководителя: перейдите в «Кредитование в магазинах» → выберите компанию → «Редактировать». Поставьте галочку в блоке «Автоподтверждение интернет-заказов». Чтобы выключить автоподтверждение, просто уберите галочку.

Готово! Можно переходить к интеграции. Перед этим этапом заранее почитайте об уведомлениях в интеграции.

Как добавить кнопку на сайт?

Установите кнопку с помощью скрипта и протестируйте, подключите npm‑пакет, задайте стили кнопок и начните продажи.

Тестирование:

  1. Прежде чем начинать продажи в рассрочку или кредит, проверьте работу сервиса на вашем сайте. Используйте tinkoff.createDemo — метод создания демонстрационных заявок. Демонстрационные заявки показывают весь процесс работы с брокером. Какие методы скрипта используют для интеграции кнопки

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

    Пример тестовой интеграции кнопки

    <!doctype html>

    <html>

        <head>

            <meta charset="UTF-8">

            <script src="https://forma.tinkoff.ru/static/onlineScript.js"></script>

        </head>

        <body>

            <button

                type="button"

                class="TINKOFF_BTN_YELLOW"

                onclick="tinkoff.createDemo({

                shopId: 'SHOP_ID',

                showcaseId: 'SHOWCASE_ID',

                demoFlow: 'sms',

                items: [

                    {name: 'iPhone 11′, price: 100000, quantity: 1},

                    {name: 'Чехол', price: 500, quantity: 1}

                ],

                sum: 100500

            })"

            ></button>

        </body>

    </html>

    Вы сможете протестировать разные варианты. Для этого используйте параметр demoFlow из метода CreateDemo:

    • sms — подписание покупателем кредитных документов с помощью СМС;
    • appointment — подписание покупателем документов на встрече с представителем банка;
    • reject — отказ покупателю в рассрочке или кредите. Для создания тестовой заявки используйте shopID, showcaseID и promocode, которые получили на этапе подготовки.

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

  2. Установите пакет npm i @tcb‑web/create-credit -S.
      Пример использования

      import tinkoff from '@/';

      tinkoff.create ({

          shopId: 'SHOP_ID',

          showcaseId: 'SHOWCASE_ID',

          items: [

              {name: 'iPhone 11′, price: 100000, quantity: 1},

              {name: 'Чехол', price: 500, quantity: 1}

          ],

          sum: 100500

      });

  3. Настройте стили кнопок.
      Вид
      КлассОписание
      TINKOFF_BTN_YELLOW Желтая кнопка. По умолчанию среднего размера (TINKOFF_SIZE_M).

      Высота кнопок в px: XL — 60, L — 56, M — 44, S — 32.

      Ширина определяется контентом автоматически.

      Текст внутри по умолчанию: «Купить в кредит». Вставьте ваш текст, если нужно

      Класс
      TINKOFF_BTN_YELLOW
      Описание
      Желтая кнопка. По умолчанию среднего размера (TINKOFF_SIZE_M).

      Высота кнопок в px: XL — 60, L — 56, M — 44, S — 32.

      Ширина определяется контентом автоматически.

      Текст внутри по умолчанию: «Купить в кредит». Вставьте ваш текст, если нужно

      Размер
      КлассОписание
      TINKOFF_SIZE_SМаленький размер кнопки
      TINKOFF_SIZE_MСредний размер кнопки. Установлен по умолчанию
      TINKOFF_SIZE_LБольшой размер кнопки
      TINKOFF_SIZE_XLСамый большой размер кнопки
      Класс
      TINKOFF_SIZE_S
      Описание
      Маленький размер кнопки
      Класс
      TINKOFF_SIZE_M
      Описание
      Средний размер кнопки. Установлен по умолчанию
      Класс
      TINKOFF_SIZE_L
      Описание
      Большой размер кнопки
      Класс
      TINKOFF_SIZE_XL
      Описание
      Самый большой размер кнопки
  4. Настройте события заявки. Если заявка открывается в айфрейме или модальном окне на странице, можно узнавать о ее состоянии через подписку на события.
      События заявки
      СобытиеОписание
      tinkoff.constants.SUCCESSЗаявка подписана
      tinkoff.constants.APPROVEDЗаявка одобрена
      tinkoff.constants.APPOINTEDПокупатель назначил встречу для подписания документов
      tinkoff.constants.REJECTПо заявке отказано
      tinkoff.constants.CANCELПокупатель отменил заявку
      Событие
      tinkoff.constants.SUCCESS
      Описание
      Заявка подписана
      Событие
      tinkoff.constants.APPROVED
      Описание
      Заявка одобрена
      Событие
      tinkoff.constants.APPOINTED
      Описание
      Покупатель назначил встречу для подписания документов
      Событие
      tinkoff.constants.REJECT
      Описание
      По заявке отказано
      Событие
      tinkoff.constants.CANCEL
      Описание
      Покупатель отменил заявку
      Технические события
      СобытиеОписание
      tinkoff.constants.READYЗаявка успешно открылась
      tinkoff.constants.ERROR_RESUMEПри загрузке заявки внутри айфрейма произошла ошибка
      tinkoff.constants.SCROLL_TOPЗаявку нужно проскроллить вверх
      tinkoff.constants.RECALCULATE_HEIGHTПроизошло изменение высоты формы. Значение высоты находится внутри message.data.height
      tinkoff.constants.KEEP_ALIVEПокупатель работает с заявкой. Отправляется не чаще раза в минуту
      Событие
      tinkoff.constants.READY
      Описание
      Заявка успешно открылась
      Событие
      tinkoff.constants.ERROR_RESUME
      Описание
      При загрузке заявки внутри айфрейма произошла ошибка
      Событие
      tinkoff.constants.SCROLL_TOP
      Описание
      Заявку нужно проскроллить вверх
      Событие
      tinkoff.constants.RECALCULATE_HEIGHT
      Описание
      Произошло изменение высоты формы. Значение высоты находится внутри message.data.height
      Событие
      tinkoff.constants.KEEP_ALIVE
      Описание
      Покупатель работает с заявкой. Отправляется не чаще раза в минуту

Интеграция и старт продаж:

  1. Замените метод tinkoff.createDemo на tinkoff.create. Такие заявки отправятся в банк. Какие методы скрипта используют для интеграции кнопки
  2. Расскажите своим покупателям о новом способе оплаты — в рассрочку или кредит — любым удобным для вас способом.

После старта продаж переходите к работе с заявкой.

Как работать с заявкой?

Используйте эту инструкцию:

  1. Покупатель оформляет заказ и по кнопке «Купить в кредит» переходит к заявке на рассрочку или кредит.
  2. Банк в течение двух минут принимает решение и сообщает о нем покупателю в форме заявки. Решение по заявке также придет покупателю по СМС или эл. почте, если он указал адрес при оформлении.
  3. В личном кабинете агента статус заявки меняется на «Одобрено» в случае положительного решения или «Отказано банком» в случае отрицательного. На адрес эл. почты, который указан в личном кабинете руководителя, придут нотификации approved или rejected. Какие нотификации используют для интеграции
  4. Если заявку одобрили, покупатель подписывает договор доступным способом: по СМС или на встрече с представителем.
  5. Банк сообщит вам о подписании договора по эл. почте и в личном кабинете агента.
  6. Если у вас включено автоподтверждение, после подписания договора банк переведет деньги на счет магазина автоматически. Подтверждение или отмена заявки недоступны с включенным автоподтверждением.

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

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

Как выглядит схема работы с заявкой

Какие методы скрипта используют для интеграции кнопки?

Всего их четыре.

    tinkoff.create — создание заявки

    Описание

    Метод для создания заявки. Принимает два объекта: первый — параметры заявки, второй — способ отображения. В случае view = 'iframe' метод возвращает промис с инстансом айфрейма, который содержит destroy для его удаления.

    Параметры

    НазваниеОписаниеТипОбязательный
    shopIdИдентификатор магазинаstring(50)Да
    showcaseIdИдентификатор витрины (сайта)string(50)Нет
    sumОбщая сумма заказаnumberДа
    itemsСписок товаров

    array

    Структура
    Да
    orderNumberИдентификатор заказа в системе партнераstring(64)Нет
    promoCodeИдентификатор кредитного продукта(кредит/рассрочка)string(256)Нет
    webhookURLСсылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витриныstringНет
    successURLСсылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    failURLСсылка для возврата в случае неуспешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    returnURLСсылка для возврата в случае отмены заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    useReturnLinksФлаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка "Вернуться в магазин". При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценарияbooleanНет
    valuesДанные покупателя для предзаполнения формыobjectНет
    values.contactКонтактobjectНет
    values.contact.fioФИО покупателяobjectНет
    values.contact.fio.lastNameФамилия покупателяstringНет
    values.contact.fio.firstNameИмя покупателяstringНет
    values.contact.fio.middleNameОтчество покупателяstringНет
    values.contact.mobilePhoneТелефон покупателя. Подходит строка с номером телефона в любом формате.stringНет
    values.contact.emailEmail покупателяstringНет
    shopId
    Описание
    Идентификатор магазина
    Тип
    string(50)
    Обязательный
    Да
    showcaseId
    Описание
    Идентификатор витрины (сайта)
    Тип
    string(50)
    Обязательный
    Нет
    sum
    Описание
    Общая сумма заказа
    Тип
    number
    Обязательный
    Да
    items
    Описание
    Общая сумма заказа
    Тип
    Обязательный
    Да
    orderNumber
    Описание
    Идентификатор заказа в системе партнера
    Тип
    string(64)
    Обязательный
    Нет
    promoCode
    Описание
    Идентификатор кредитного продукта (кредит/рассрочка)
    Тип
    string
    Обязательный
    Нет
    webhookURL
    Описание
    Ссылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витрины
    Тип
    string
    Обязательный
    Нет
    successURL
    Описание
    Ссылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадать
    Тип
    string
    Обязательный
    Нет
    failURL
    Описание
    URL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    returnURL
    Описание
    URL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    useReturnLinks
    Описание
    Флаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка «Вернуться в магазин». При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценария
    Тип
    boolean
    Обязательный
    Нет
    values
    Описание
    Данные покупателя для предзаполнения формы
    Тип
    object
    Обязательный
    Нет
    values.contact
    Описание
    Контакт
    Тип
    object
    Обязательный
    Нет
    values.contact.fio
    Описание
    ФИО покупателя
    Тип
    object
    Обязательный
    Нет
    values.contact.fio.lastName
    Описание
    Фамилия покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.firstName
    Описание
    Имя покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.middleName
    Описание
    Отчество покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.mobilePhone
    Описание
    Телефон покупателя: 10 цифр, без +7
    Тип
    string
    Обязательный
    Нет
    values.contact.email
    Описание
    Email покупателя
    Тип
    string
    Обязательный
    Нет

    Items

    НазваниеОписаниеТипОбязательный
    nameНазвание товарной позицииstring(255)Да
    quantityКоличество единиц товара в позиции

    integer

    int32
    Да
    priceЦена одной единицы товараnumberДа
    categoryКатегория товараstring(255)Нет
    vendorCodeАртикулstring(64)Нет
    name
    Описание
    Название товарной позиции
    Тип
    string(255)
    Обязательный
    Да
    quantity
    Описание
    Количество единиц товара в позиции
    Тип
    integer
    int32
    Обязательный
    Да
    price
    Описание
    Цена одной единицы товара
    Тип
    number
    Обязательный
    Да
    category
    Описание
    Категория товара
    Тип
    string(255)
    Обязательный
    Нет
    vendorCode
    Описание
    Артикул
    Тип
    string(64)
    Обязательный
    Нет

    Второй параметр — способ отображения.

    Необязателен. Если не указать, то форма откроется в модальном окне.

    НазваниеОписаниеТипОбязательный
    view В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')

    enum

    newTab, self, modal, iframe
    Да
    targetИдентификатор элемента, в который будет встроен iframe. Используется в document.querySelectorstring Нет

    обязательный, если view = 'iframe'

    view
    Описание
    В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')
    Тип
    enum
    newTab, self, modal, iframe
    Обязательный
    Да
    target
    Описание
    Идентификатор элемента, в который будет встроен iframe. Используется в document.querySelector
    Тип
    string
    Обязательный
    Да
    обязательный, если view = 'iframe'
    tinkoff.createDemo — создание демозаявки

    Метод для создания демонстрационной версии заявки. Принимает два объекта: первый — параметры заявки, второй — способ отображения. В случае view = 'iframe' метод возвращает промис с инстансом айфрейма, который содержит destroy для его удаления.

    Параметры

    НазваниеОписаниеТипОбязательный
    shopIdИдентификатор магазинаstring(50)Да
    showcaseIdИдентификатор витрины (сайта)string(50)Нет
    sumОбщая сумма заказаnumberДа
    itemsСписок товаров

    array

    Структура
    Да
    orderNumberИдентификатор заказа в системе партнераstring(64)Нет
    promoCodeИдентификатор кредитного продукта(кредит/рассрочка)string(256)Нет
    webhookURLСсылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витриныstringНет
    successURLСсылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    failURLСсылка для возврата в случае неуспешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    returnURLСсылка для возврата в случае отмены заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    useReturnLinksФлаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка "Вернуться в магазин". При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценарияbooleanНет
    valuesДанные покупателя для предзаполнения формыobjectНет
    values.contactКонтактobjectНет
    values.contact.fioФИО покупателяobjectНет
    values.contact.fio.lastNameФамилия покупателяstringНет
    values.contact.fio.firstNameИмя покупателяstringНет
    values.contact.fio.middleNameОтчество покупателяstringНет
    values.contact.mobilePhoneТелефон покупателя. Подходит строка с номером телефона в любом формате.stringНет
    values.contact.emailEmail покупателяstringНет
    demoFlowДоступные флоу для демо заявки

    enum

    sms, appointment, reject, appointment-reject
    Нет
    initialStageИдентификатор начального состояния заявки. Схема заявки

    enum

    appointment, filling, wait‑offer, offers‑all, wait‑offers‑all, eastern-express-issued, eastern-express‑sms, mts‑appointment, mts‑issued, kvk‑issued, canceled, rejected, kvk‑signing‑sms, wait‑offer-timeout
    Нет
    shopId
    Описание
    Идентификатор магазина
    Тип
    string(50)
    Обязательный
    Да
    showcaseId
    Описание
    Идентификатор витрины (сайта)
    Тип
    string(50)
    Обязательный
    Нет
    sum
    Описание
    Общая сумма заказа
    Тип
    number
    Обязательный
    Да
    items
    Описание
    Общая сумма заказа
    Тип
    Обязательный
    Да
    orderNumber
    Описание
    Идентификатор заказа в системе партнера
    Тип
    string(64)
    Обязательный
    Нет
    promoCode
    Описание
    Идентификатор кредитного продукта (кредит/рассрочка)
    Тип
    string
    Обязательный
    Нет
    webhookURL
    Описание
    Ссылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витрины
    Тип
    string
    Обязательный
    Нет
    successURL
    Описание
    Ссылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадать
    Тип
    string
    Обязательный
    Нет
    failURL
    Описание
    URL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    returnURL
    Описание
    URL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    useReturnLinks
    Описание
    Флаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка «Вернуться в магазин». При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценария
    Тип
    boolean
    Обязательный
    Нет
    values
    Описание
    Данные покупателя для предзаполнения формы
    Тип
    object
    Обязательный
    Нет
    values.contact
    Описание
    Контакт
    Тип
    object
    Обязательный
    Нет
    values.contact.fio
    Описание
    ФИО покупателя
    Тип
    object
    Обязательный
    Нет
    values.contact.fio.lastName
    Описание
    Фамилия покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.firstName
    Описание
    Имя покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.middleName
    Описание
    Отчество покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.mobilePhone
    Описание
    Телефон покупателя: 10 цифр, без +7
    Тип
    string
    Обязательный
    Нет
    values.contact.email
    Описание
    Email покупателя
    Тип
    string
    Обязательный
    Нет

    Items

    НазваниеОписаниеТипОбязательный
    nameНазвание товарной позицииstring(255)Да
    quantityКоличество единиц товара в позиции

    integer

    int32
    Да
    priceЦена одной единицы товараnumberДа
    categoryКатегория товараstring(255)Нет
    vendorCodeАртикулstring(64)Нет
    name
    Описание
    Название товарной позиции
    Тип
    string(255)
    Обязательный
    Да
    quantity
    Описание
    Количество единиц товара в позиции
    Тип
    integer
    int32
    Обязательный
    Да
    price
    Описание
    Цена одной единицы товара
    Тип
    number
    Обязательный
    Да
    category
    Описание
    Категория товара
    Тип
    string(255)
    Обязательный
    Нет
    vendorCode
    Описание
    Артикул
    Тип
    string(64)
    Обязательный
    Нет

    Второй параметр — способ отображения.

    Необязателен. Если не указать, то форма откроется в модальном окне.

    НазваниеОписаниеТипОбязательный
    view В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')

    enum

    newTab, self, modal, iframe
    Да
    targetИдентификатор элемента, в который будет встроен iframe. Используется в document.querySelectorstring

    Нет

    обязательный, если view = 'iframe'
    view
    Описание
    В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')
    Тип
    enum
    newTab, self, modal, iframe
    Обязательный
    Да
    target
    Описание
    Идентификатор элемента, в который будет встроен iframe. Используется в document.querySelector
    Тип
    string
    Обязательный
    Да
    обязательный, если view = 'iframe'
    tinkoff.createLink — создание ссылки на заявку

    Метод для генерации ссылки на заявку. Принимает один объект — параметры заявки. Возвращает промис со ссылкой.

    Параметры

    НазваниеОписаниеТипОбязательный
    shopIdИдентификатор магазинаstring(50)Да
    showcaseIdИдентификатор витрины (сайта)string(50)Нет
    sumОбщая сумма заказаnumberДа
    itemsСписок товаров

    array

    Структура
    Да
    orderNumberИдентификатор заказа в системе партнераstring(64)Нет
    promoCodeИдентификатор кредитного продукта(кредит/рассрочка)string(256)Нет
    webhookURLСсылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витриныstringНет
    successURLСсылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    failURLСсылка для возврата в случае неуспешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    returnURLСсылка для возврата в случае отмены заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    useReturnLinksФлаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка "Вернуться в магазин". При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценарияbooleanНет
    valuesДанные покупателя для предзаполнения формыobjectНет
    values.contactКонтактobjectНет
    values.contact.fioФИО покупателяobjectНет
    values.contact.fio.lastNameФамилия покупателяstringНет
    values.contact.fio.firstNameИмя покупателяstringНет
    values.contact.fio.middleNameОтчество покупателяstringНет
    values.contact.mobilePhoneТелефон покупателя. Подходит строка с номером телефона в любом формате.stringНет
    values.contact.emailEmail покупателяstringНет
    shopId
    Описание
    Идентификатор магазина
    Тип
    string(50)
    Обязательный
    Да
    showcaseId
    Описание
    Идентификатор витрины (сайта)
    Тип
    string(50)
    Обязательный
    Нет
    sum
    Описание
    Общая сумма заказа
    Тип
    number
    Обязательный
    Да
    items
    Описание
    Общая сумма заказа
    Тип
    Обязательный
    Да
    orderNumber
    Описание
    Идентификатор заказа в системе партнера
    Тип
    string(64)
    Обязательный
    Нет
    promoCode
    Описание
    Идентификатор кредитного продукта (кредит/рассрочка)
    Тип
    string
    Обязательный
    Нет
    webhookURL
    Описание
    Ссылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витрины
    Тип
    string
    Обязательный
    Нет
    successURL
    Описание
    Ссылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадать
    Тип
    string
    Обязательный
    Нет
    failURL
    Описание
    URL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    returnURL
    Описание
    URL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    useReturnLinks
    Описание
    Флаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка «Вернуться в магазин». При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценария
    Тип
    boolean
    Обязательный
    Нет
    values
    Описание
    Данные покупателя для предзаполнения формы
    Тип
    object
    Обязательный
    Нет
    values.contact
    Описание
    Контакт
    Тип
    object
    Обязательный
    Нет
    values.contact.fio
    Описание
    ФИО покупателя
    Тип
    object
    Обязательный
    Нет
    values.contact.fio.lastName
    Описание
    Фамилия покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.firstName
    Описание
    Имя покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.middleName
    Описание
    Отчество покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.mobilePhone
    Описание
    Телефон покупателя: 10 цифр, без +7
    Тип
    string
    Обязательный
    Нет
    values.contact.email
    Описание
    Email покупателя
    Тип
    string
    Обязательный
    Нет
    demoFlow
    Описание
    Доступные флоу для демо заявки
    Тип
    enum
    sms, appointment, reject, appointment-reject
    Обязательный
    Нет
    initialStage
    Описание
    Идентификатор начального состояния заявки.
    Схема заявки
    Тип
    enum
    appointment, filling, wait‑offer, offers‑all, wait‑offers‑all, eastern-express-issued, eastern-express‑sms, mts‑appointment, mts‑issued, kvk‑issued, canceled, rejected, kvk‑signing‑sms, wait‑offer-timeout
    Обязательный
    Нет

    Items

    НазваниеОписаниеТипОбязательный
    nameНазвание товарной позицииstring(255)Да
    quantityКоличество единиц товара в позиции

    integer

    int32
    Да
    priceЦена одной единицы товараnumberДа
    categoryКатегория товараstring(255)Нет
    vendorCodeАртикулstring(64)Нет
    name
    Описание
    Название товарной позиции
    Тип
    string(255)
    Обязательный
    Да
    quantity
    Описание
    Количество единиц товара в позиции
    Тип
    integer
    int32
    Обязательный
    Да
    price
    Описание
    Цена одной единицы товара
    Тип
    number
    Обязательный
    Да
    category
    Описание
    Категория товара
    Тип
    string(255)
    Обязательный
    Нет
    vendorCode
    Описание
    Артикул
    Тип
    string(64)
    Обязательный
    Нет

    Второй параметр — способ отображения.

    Необязателен. Если не указать, то форма откроется в модальном окне.

    НазваниеОписаниеТипОбязательный
    view В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')

    enum

    newTab, self, modal, iframe
    Да
    targetИдентификатор элемента, в который будет встроен iframe. Используется в document.querySelectorstring

    Нет

    обязательный, если view = 'iframe'
    view
    Описание
    В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')
    Тип
    enum
    newTab, self, modal, iframe
    Обязательный
    Да
    target
    Описание
    Идентификатор элемента, в который будет встроен iframe. Используется в document.querySelector
    Тип
    string
    Обязательный
    Да
    обязательный, если view = 'iframe'
    tinkoff.createDemoLink — создание ссылки на демозаявку

    Метод для генерации ссылки на демонстрационную заявку. Принимает один объект — параметры заявки. Возвращает промис со ссылкой.

    Параметры

    НазваниеОписаниеТипОбязательный
    shopIdИдентификатор магазинаstring(50)Да
    showcaseIdИдентификатор витрины (сайта)string(50)Нет
    sumОбщая сумма заказаnumberДа
    itemsСписок товаров

    array

    Структура
    Да
    orderNumberИдентификатор заказа в системе партнераstring(64)Нет
    promoCodeИдентификатор кредитного продукта(кредит/рассрочка)string(256)Нет
    webhookURLСсылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витриныstringНет
    successURLСсылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    failURLСсылка для возврата в случае неуспешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    returnURLСсылка для возврата в случае отмены заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадатьstringНет
    useReturnLinksФлаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка "Вернуться в магазин". При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценарияbooleanНет
    valuesДанные покупателя для предзаполнения формыobjectНет
    values.contactКонтактobjectНет
    values.contact.fioФИО покупателяobjectНет
    values.contact.fio.lastNameФамилия покупателяstringНет
    values.contact.fio.firstNameИмя покупателяstringНет
    values.contact.fio.middleNameОтчество покупателяstringНет
    values.contact.mobilePhoneТелефон покупателя. Подходит строка с номером телефона в любом формате.stringНет
    values.contact.emailEmail покупателяstringНет
    demoFlowДоступные флоу для демо заявки

    enum

    sms, appointment, reject, appointment-reject
    Нет
    initialStageИдентификатор начального состояния заявки. Схема заявки

    enum

    appointment, filling, wait‑offer, offers‑all, wait‑offers‑all, eastern-express-issued, eastern-express‑sms, mts‑appointment, mts‑issued, kvk‑issued, canceled, rejected, kvk‑signing‑sms, wait‑offer-timeout
    Нет
    shopId
    Описание
    Идентификатор магазина
    Тип
    string(50)
    Обязательный
    Да
    showcaseId
    Описание
    Идентификатор витрины (сайта)
    Тип
    string(50)
    Обязательный
    Нет
    sum
    Описание
    Общая сумма заказа
    Тип
    number
    Обязательный
    Да
    items
    Описание
    Общая сумма заказа
    Тип
    Обязательный
    Да
    orderNumber
    Описание
    Идентификатор заказа в системе партнера
    Тип
    string(64)
    Обязательный
    Нет
    promoCode
    Описание
    Идентификатор кредитного продукта (кредит/рассрочка)
    Тип
    string
    Обязательный
    Нет
    webhookURL
    Описание
    Ссылка для отправки вебхуков, если не указана, то будет использована ссылка из настроек витрины
    Тип
    string
    Обязательный
    Нет
    successURL
    Описание
    Ссылка для возврата в случае успешного завершения заявки. Если не указана, то будет использована ссылка из настроек витрины. Нельзя указывать ссылки для возврата, если в настройках точки не указан сайт. Домены из настроек и домены в запросе должны совпадать
    Тип
    string
    Обязательный
    Нет
    failURL
    Описание
    URL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    returnURL
    Описание
    URL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазина
    Тип
    string
    Обязательный
    Нет
    useReturnLinks
    Описание
    Флаг, который указывает, что на финальных экранах в айфрейме и модальном окне будет показана кнопка «Вернуться в магазин». При нажатии на эту кнопку, скрипт инициирует редирект пользователя на одну из возвратных ссылок в зависимости от сценария
    Тип
    boolean
    Обязательный
    Нет
    values
    Описание
    Данные покупателя для предзаполнения формы
    Тип
    object
    Обязательный
    Нет
    values.contact
    Описание
    Контакт
    Тип
    object
    Обязательный
    Нет
    values.contact.fio
    Описание
    ФИО покупателя
    Тип
    object
    Обязательный
    Нет
    values.contact.fio.lastName
    Описание
    Фамилия покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.firstName
    Описание
    Имя покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.fio.middleName
    Описание
    Отчество покупателя
    Тип
    string
    Обязательный
    Нет
    values.contact.mobilePhone
    Описание
    Телефон покупателя: 10 цифр, без +7
    Тип
    string
    Обязательный
    Нет
    values.contact.email
    Описание
    Email покупателя
    Тип
    string
    Обязательный
    Нет
    demoFlow
    Описание
    Доступные флоу для демо заявки
    Тип
    enum
    sms, appointment, reject, appointment-reject
    Обязательный
    Нет
    initialStage
    Описание
    Идентификатор начального состояния заявки.
    Схема заявки
    Тип
    enum
    appointment, filling, wait‑offer, offers‑all, wait‑offers‑all, eastern-express-issued, eastern-express‑sms, mts‑appointment, mts‑issued, kvk‑issued, canceled, rejected, kvk‑signing‑sms, wait‑offer-timeout
    Обязательный
    Нет

    Items

    НазваниеОписаниеТипОбязательный
    nameНазвание товарной позицииstring(255)Да
    quantityКоличество единиц товара в позиции

    integer

    int32
    Да
    priceЦена одной единицы товараnumberДа
    categoryКатегория товараstring(255)Нет
    vendorCodeАртикулstring(64)Нет
    name
    Описание
    Название товарной позиции
    Тип
    string(255)
    Обязательный
    Да
    quantity
    Описание
    Количество единиц товара в позиции
    Тип
    integer
    int32
    Обязательный
    Да
    price
    Описание
    Цена одной единицы товара
    Тип
    number
    Обязательный
    Да
    category
    Описание
    Категория товара
    Тип
    string(255)
    Обязательный
    Нет
    vendorCode
    Описание
    Артикул
    Тип
    string(64)
    Обязательный
    Нет

    Второй параметр — способ отображения.

    Необязателен. Если не указать, то форма откроется в модальном окне.

    НазваниеОписаниеТипОбязательный
    view В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')

    enum

    newTab, self, modal, iframe
    Да
    targetИдентификатор элемента, в который будет встроен iframe. Используется в document.querySelectorstring

    Нет

    обязательный, если view = 'iframe'
    view
    Описание
    В каком виде отображать:
    1. в модальном окне ('modal')
    2. инлайн на странице ('iframe')
    3. открыть в новой вкладке ('newTab')
    4. открыть в этой же вкладке ('self')
    Тип
    enum
    newTab, self, modal, iframe
    Обязательный
    Да
    target
    Описание
    Идентификатор элемента, в который будет встроен iframe. Используется в document.querySelector
    Тип
    string
    Обязательный
    Да
    обязательный, если view = 'iframe'
Получилось найти ответ?

Другие статьи по этой теме

  • Инструкция для интеграции по API
  • Как начать продавать в рассрочку или кредит по ссылке и QR‑коду
  • Как интегрировать модуль «Битрикс»
  • Как подключить оплату в рассрочку и кредит на GetCourse
  • Справочная информация

Вас может заинтересовать

Посмотреть все темы