Параметры кнопки
При создании заявки вы можете настраивать передаваемые данные. В том числе передавать данные покупателя, если он вводил их ранее
Основные параметры
| Описание | Параметр |
|---|---|
| size enum, optional | Размеры кнопки S — маленький, 32px M — cредний, 56px L — большой, 112px. Установлено по умолчанию |
| subtext string, optional | Подтекст кнопки |
| shopId string(50), required | Идентификатор компании |
| showcaseId string(50), required | Идентификатор магазина |
| ui-data string, optional | Параметры отображения кнопки и заявки. Query-параметр в виде строки |
| payment-data string, required | Параметры заказа и заявки. Query-параметр в виде строки |
| promo-code-select string, optional | Параметры отображения выпадающего меню. Query-параметр в виде строки. В случае передачи этого параметра стандартный payment-data.promoCode будет проигнорирован |
Ui-data
| Описание | Параметр |
|---|---|
| view enum, required | Вид отображения newTab – открыть в новой вкладке self – открыть в этой же вкладке |
| productType enum, optional | Основной текст кнопки: credit — купить в кредит. Установлено по умолчанию installment — купить в рассрочку |
| useReturnLinks boolean, optional | Флаг, который указывает, что на финальных экранах будет показана кнопка «Вернуться в магазин» Установлено по умолчанию false |
Payment-data
| Описание | Параметр |
|---|---|
| sum number, required | Общая сумма заказа |
| items Items[], required | Список товаров Описано в таблице Items |
| orderNumber string(64), optional | Номер заказа в системе партнера. Обязательный, если используются вебхуки и методы API Commit, Cancel и Info |
| promoCode string(64), optional | Идентификатор продукта: кредит или рассрочка По умолчанию default |
| webhookURL string, optional | Ссылка для отправки вебхуков Ссылка на раздел вебхуков |
| successURL string, optional | Ссылка для возврата в случае успешного завершения заявки — подписания Ссылки возврата |
| failURL string, optional | Ссылка для возврата в случае неуспешного завершения заявки — отказа банка Ссылки возврата |
| returnURL string, optional | Ссылка для возврата в случае отмены заявки Ссылки возврата |
| values object, optional | Данные покупателя для предзаполнения формы |
| values.contact Contact, optional | Данные покупателя Описано в таблице Contact |
Object «Items»
| Описание | Параметр |
|---|---|
| name string(255), required | Название товарной позиции |
| quantity integer, required | Количество единиц товара указанной позиции |
| price number, required | Цена одной единицы товара |
| category string(255), optional | Категория товара |
| vendorCode string(64), optional | Артикул |
Object «Сontact»
| Описание | Параметр |
|---|---|
| values.contact.fio FIO, optional | ФИО покупателя Описано в таблице FIO |
| values.contact.mobilePhone string, optional | Телефон покупателя. Подходит строка с номером телефона РФ в любом формате |
| values.contact.email string, optional | E-mail покупателя |
Object «FIO»
| Описание | Параметр |
|---|---|
| values.contact.fio.lastName string, optional | Фамилия покупателя |
| values.contact.fio.firstName string, optional | Имя покупателя |
| values.contact.fio.middleName string, optional | Отчество покупателя |
Promo-code-select
| Описание | Параметр |
|---|---|
| items SelectItem[], required | Массив с описанием элементов меню |
Object «SelectItem»
| Описание | Параметр |
|---|---|
| text string(64), required | Текст элемента |
| value string(64), required | Значение промокода |