Справочник параметров, методов и кодов ошибок
В этом справочнике описаны:
 
Описание параметров для инициализации виджета
Описание параметров, которые необходимо передать в экземпляр класса
YooMoneyCheckoutWidget
на странице оплаты для инициализации виджета.
ПараметрТипОбязательностьОписание
confirmation_tokenstringОбязательныйТокен ЮKassa для инициализации виджета. Чтобы получить токен, нужно создать платеж
return_urlstringОбязательныйАдрес страницы, на которую пользователь вернется после завершения оплаты. Адрес должен быть абсолютным (с указанием протокола и домена сайта). Пример:
https://example.com/orderid-1111
customizationobjectНеобязательныйНастройка платежной формы. Сейчас можно настроить способ отображения платежной формы, цветовую схему и отображение способов оплаты.
modalbooleanНеобязательный
Передается в 
customization
. Настройка способа отображения платежной формы. Возможные значения:
colorsobjectНеобязательный
Передается в 
customization
.
Настройка цветовой схемы. В объекте передаются цвета, которые нужно изменить в интерфейсе платежной формы.
payment_methodsarrayНеобязательный
Передается в 
customization
.
  • apple_pay
     — Apple Pay;
  • google_pay
     — Google Pay;
  • bank_card
     — банковская карта;
  • yoo_money
     — ЮMoney (кошелек, привязанные карты и баллы лояльности);
  • sberbank
     — СберБанк Онлайн/SberPay.
Одновременно можно передать только
bank_card
,
apple_pay
,
google_pay
или любую их комбинацию.
 
Описание параметров для настройки цветовой схемы
Описание всех параметров объекта
colors
, которые можно использовать для настройки цветовой схемы.
ПараметрТипОписаниеПо умолчанию
controlPrimarystringЦвет фона акцентных элементов: кнопка Заплатить, выбранные переключатели, опции, граница выбранного текстового поля. Рекомендуется использовать яркий цвет, привлекающий внимание
#FFCC00
(желтый)
controlPrimaryContentstring
Цвет текста в кнопке Заплатить и содержимого акцентных переключателей и опций (например, выставленный флажок). Рекомендуется использовать цвет, контрастный к 
controlPrimary
.
Если параметр не передан, цвет рассчитывается на основе
controlPrimary
#000000
(черный) или
#FFFFFF
(белый) — выбирается контрастный к 
controlPrimary
backgroundstringЦвет фона платежной формы, цвет сообщений об ошибках и подсказок, а также внешний вид кнопок Apple Pay, Google Pay и логотипов. Рекомендуется использовать цвет, близкий к цвету фона контейнера, в котором размещен виджет
#FFFFFF
(белый)
textstring
Цвет всех текстов на платежной форме, кроме текстов в кнопке Заплатить и во всплывающих подсказках.
Если параметр не передан, цвет рассчитывается на основе
background
Контрастный к 
background
borderstringЦвет границ и разделителей.
Если параметр не передан, цвет рассчитывается на основе
background
Контрастный к 
background
controlSecondarystringЦвет неакцентных элементов интерфейса.
Если параметр не передан, цвет рассчитывается на основе
background
Контрастный к 
background
 
Ошибки инициализации виджета
Если инициализация виджета закончилась неудачей, ЮKassa передаст в callback-функцию код ошибки.
Код ошибкиОписание
internal_service_errorПри создании платежа возникла ошибка. Повторите инициализацию виджета
invalid_combination_of_payment_methodsНедопустимое сочетание способов оплаты в 
payment_methods
объекта
customization
. Одновременно можно передавать только
apple_pay
,
google_pay
и 
bank_card
(любое их сочетание).
invalid_payment_methodsНекорректное значение
payment_methods
объекта
customization
. В массиве можно передать коды только тех способов оплаты, которые поддерживает виджет. Если отображаете несколько способов, их коды нужно перечислять через запятую.
invalid_return_urlНекорректный URL возврата. При инициализации виджета передайте в 
return_url
абсолютный URL страницы завершения оплаты, указав в нём протокол и домен вашего сайта
invalid_tokenНеверный токен. Для получения токена создайте платеж
no_payment_methods_to_displayОтсутствуют способы оплаты для отображения: например, вы не можете принимать платежи выбранным способом или выбранный способ оплаты нельзя сохранить для автоплатежей (если вы пытаетесь это сделать). При инициализации виджета передайте в 
payment_methods
другой способ оплаты
return_url_requiredURL возврата не передан. При инициализации виджета передайте
return_url
token_expiredИстек срок действия токена. Для получения нового токена создайте платеж
token_requiredТокен не передан. При инициализации виджета передайте
confirmation_token
 
Описание методов виджета
МетодТипОписание
render
(id?: string) => Promise<undefined>
Отображение платежной формы. Исполнение Promise говорит о полной загрузке платежной формы. Promise можно не использовать.
Если вы размещаете виджет на странице оплаты, в параметрах метода передайте значение атрибута
id
контейнера, в котором нужно разместить платежную форму. Если хотите отображать виджет во всплывающем окне, в параметрах метода ничего передавать не нужно.
destroy
() => void
Удаление инициализированного виджета.

Есть вопросы или замечания по документации?

Можем созвониться и обсудить их лично: мы поможем вам разобраться, а вы нам — понять, что тут нужно улучшить. Для этого оставьте свои контакты и выберите время.
Да, хочу обсудить
 
Что почитать еще
Справочник APIИнтеграция виджетаТиповые сценарии интеграции виджета