Параметры вызова платёжной формы

Табл. 1. Параметры вызова Payment Page
Параметр	Обязательность	Тип	Описание	Пример
account_token	Нет	string	Токен банковской карты. При передаче токена в этом параметре виджет открывается с предвыбранной картой. Notice: Применяется в режимах Purchase и Card Verify. Дополнительные сведения см. в Проведение оплат по токенам
addendum_data	Нет	string	Этот параметр используется для передачи расширенной информации о бронировании, например номер брони, имена гостей отелей или путешественников. Параметр поддерживается только для компаний, работающих в туристической отрасли. Расширенная информация должна представляться в параметре строкой, закодированной с применением алгоритма Base64. Подробнее о формировании значения параметра addendum_data см. Использование «длинной записи»
avs_post_code	Нет	string	Почтовый индекс пользователя, переданный для выполнения проверки AVS	WS13 6LG
avs_street_address	Нет	string	Адрес пользователя, переданный для выполнения проверки AVS	4 Breadmarket Street
baseUrl	Нет	string	Базовый адрес вызова платёжной формы (в случаях, когда его актуально указывать в явном виде)
best_before	Нет	string	Дата и время срока действия платежа. По истечении срока действия платежа пользователь перенаправляется на страницу с сообщением о том, что время возможности проведения платежа истекло. Параметр передается в формате `YYYY-MM-DDThh:mm:ss±hh`	2020-04-26T13:50:37+00:00
billing_address	Настраивается	string	Улица платежного адреса пользователя	33 Store Street
billing_city	Настраивается	string	Город платежного адреса пользователя	Londont
billing_country	Настраивается	string	Страна платежного адреса пользователя в формате ISO 3166-1 alpha-2	GB
billing_postal	Настраивается	string	Почтовый индекс платежного адреса пользователя	BR1 1AA
billing_region	Настраивается	string	Регион или штат платежного адреса пользователя	Greater London
billing_region_code	Нет	string	Код штата, провинции или региона страны в формате ISO 3166-2; при указании значения этого параметра также необходимо указать значение параметра `billing_country`	DOR
booking_info	Нет	string	Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией о бронировании услуг (подробнее)
card_holder	Нет	string	Имя держателя карты, как указано на карте. При передаче параметра значение сразу отображается и доступно для редактирования на платежной форме	CARD HOLDER
card_operation_type	Нет	string	Тип операции в случае проведения оплаты с помощью банковской карты. Возможные значения: sale: оплата с прямым списанием средств auth: оплата с холдированием средств Дополнительные сведения см. в Проведение оплат и Блокировка средств	sale
close_on_missclick	Нет	integer	Параметр, определяющий поведение виджета, открытого в модальном окне, при щелчке за пределами области отображения виджета: 0 — не закрывать виджет по щелчку за его пределами. Это значение по умолчанию. 1 — закрыть виджет при щелчке мышью за его пределами. Подробнее см. Открытие в модальном окне При работе с Payment Page без использования библиотеки `merchant.js` в этом параметре может указываться булево значение.	1
css_modal_wrap	Нет	string	Дополнительный CSS класс оболочки для модального окна. Дополнительные сведения см. в Открытие в модальном окне	modal-popup
customer_address	Настраивается	string	Адрес пользователя. Подробнее см. в Сбор данных о пользователях	Main Street, 12
customer_account_info	Нет	string	Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией об учётной записи пользователя на стороне веб-сервиса и о контактных данных пользователя. Подробнее см. в статье Аутентификация 3‑D Secure
customer_account_number	Нет	string	Номер кошелька или аккаунта пользователя в платежной системе, также может быть номер телефона (указывается с кодом страны и без знака +) или адрес электронной почты пользователя, на который зарегистрирован аккаунт	example@mail.com
customer_birthplace	Настраивается	string	Место рождения пользователя	London
customer_city	Настраивается	string	Город адреса пользователя	London
customer_country	Настраивается	string	Страна адреса пользователя в формате ISO 3166-1 alpha-2	GB
customer_day_of_birth	Настраивается	string	Дата рождения пользователя, ДД-ММ-ГГГГ	12-12-1990
customer_email	Настраивается	string	Адрес электронной почты пользователя. Необходимо передавать для оплат с прямым использованием платёжных карт, если не указан номер телефона и не используется возможность указания таких сведений самим пользователем (подробнее)	smith@gmail.com
customer_first_name	Настраивается	string	Имя пользователя	Инна
customer_id	Обязательно для Card Tokenize, Purchase	string	Уникальный идентификатор пользователя в вашем проекте. Передаваемые в параметре или объекте `customer` данные отображаются в карточке платежа в Dashboard	customer_341
customer_last_name	Настраивается	string	Фамилия пользователя	Smith
customer_middle_name	Настраивается	string	Отчество пользователя	Mary
customer_mpi_result	Нет	string	Cтрока, полученная в результате кодирования с применением алгоритма Base64, с данными о предыдущей аутентификации пользователя. Подробнее см. в статье Аутентификация 3‑D Secure
customer_phone	Настраивается	string	Номер телефона пользователя. В общем случае должен быть полным, с кодом страны, хотя в отдельных случаях (в том числе для карточных платежей) допустимо указание и без кода страны. Технически номер должен содержать не менее 4 и не более 24 цифр, при этом, если такое допускается в рамках используемого проекта и платёжного метода, в записи номера могут использоваться знаки пунктуации и специальные символы (подобные случаи, как правило, оговариваются отдельно). Необходимо передавать для оплат с прямым использованием платёжных карт, если не указан адрес электронной почты и не используется возможность указания таких сведений самим пользователем (подробнее)	443031237300
customer_security_code	Нет	string	Секретный код счета или кошелька пользователя для подтверждения платежа	852923
customer_shipping	Нет	string	Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией о доставке товара или услуги пользователю. Подробнее см. в статье Аутентификация 3‑D Secure
customer_ssn	Настраивается	integer	Последние 4 цифры номера социального страхования гражданина США	1234
customer_state	Настраивается	string	Штат адреса пользователя	Greater London
customer_street	Нет	string	Улица адреса пользователя	Main
customer_zip	Настраивается	string	Почтовый индекс пользователя	305000
debt_account	Нет	string	Номер счета для получения средств с карты пользователя с целью погашения задолженности. Допустимы буквы латинского алфавита и цифры, длина не более 10 символов	an9876170i
force_acs_new_window	Нет	integer	Форсированный режим отображения страницы ACS в новом окне, игнорируя настройки Payment Page `1`: открытие в отдельной вкладке `0` или параметр отсутствует: открытие заданным способом При работе с Payment Page без использования библиотеки `merchant.js` в этом параметре может указываться булево значение.	1
force_payment_method	Нет	string	Идентификатор платежного метода, который откроется по умолчанию без возможности выбора другого. Список идентификаторов приведен в Коды платёжных методов	card
`force_payment_group`	Нет	string	Идентификатор группы платёжных методов, элементами которой должен ограничиваться выбор метода в платёжной форме. При указании этого идентификатора в Payment Page отображаются кнопки выбора только тех методов, которые входят в указанную группу и доступны в рамках используемого проекта. Вместе с тем, при указании этого идентификатора в одном запросе с кодом конкретного метода в параметре `force_payment_method` платёжная форма открывается для проведения оплаты указанным методом, без учёта выбранной группы. В настоящее время с помощью этого параметра применим выбор группы методов Open Banking — с помощью идентификатора `openbanking`.	openbanking
force_payment_method_subtype	Нет	string	Идентификатор типа банковской карты, который откроется по умолчанию без возможности выбора другого, при `force_payment_method=card`. Также относится к отображению сохраненных карт пользователя. Доступные значения см. в Коды брендов платёжных карт	visa
hide	Нет	string	Идентификатор платежного метода, который будет скрыт от пользователя на Payment Page. Если необходимо скрыть несколько методов – идентификаторы передаются через запятую. Список идентификаторов приведен в Коды платёжных методов	card, cup-card
identify_doc_number	Нет	string	Номер документа, подтверждающего личность пользователя	6543234567
interface_type	Нет	string	Строка, содержащая информацию об источнике запроса на проведение платежа. Данные собираются в JSON-объект. Доступное значение для параметра id: 7 – Payment Page в режиме iframe	interface_type: {"id":7}
language_code	Рекомендовано	string	Язык, на котором сгенерированная платежная страница будет открыта пользователю. Язык передается в формате ISO 639-1 alpha-2. Если этот параметр не передается, то по умолчанию платежная платформа определяет язык по IP-адресу пользователя	ru
`merchant_callback_url`	Нет	string	Адрес доставки оповещений о выполнении целевого действия. Может быть актуален в случаях, когда требуется изменить адрес доставки для этого целевого действия (подробнее)
merchant_data	Нет	string	Параметр для передачи дополнительной информации о проводимой оплате (например, сведений о предоставляемых услугах). Данные передаются в виде JSON-объекта (подробнее)
merchant_fail_enabled	Нет	integer	Параметр, отвечающий за возможность возврата пользователя в проект при отклоненной оплате. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	1
merchant_fail_redirect_mode	Нет	string	Режим открытия страницы проекта во время возврата пользователя в проект после отклоненного платежа. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	iframe
merchant_fail_url	Нет	string	URL-адрес страницы для возврата пользователя в проект при отклоненной оплате по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	http://example.com
merchant_return_enabled	Нет	integer	Параметр, отвечающий за возможность возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	1
merchant_return_redirect_mode	Нет	string	Режим открытия страницы проекта во время возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	iframe
merchant_return_url	Нет	string	URL-адрес страницы для возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	http://example.com
merchant_success_enabled	Нет	integer	Параметр, отвечающий за возможность возврата пользователя в проект после совершенного платежа. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	1
merchant_success_redirect_mode	Нет	string	Режим открытия страницы проекта во время возврата пользователя после совершенного платежа. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	iframe
merchant_success_url	Нет	string	URL-адрес страницы для возврата пользователя в проект при проведенной оплате по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису	http://example.com
mode	Обязательно для всех режимов, кроме Purchase	string	Режим работы Payment Page. Доступные значения: purchase: режим Purchase. Используется по умолчанию card_tokenize: режим Card Tokenize card_verify: режим Card Verify	card_tokenize
moto_type	Нет	integer	Признак проведения Mail Order/Telephone Order (MO/TO) платежа. Доступные значения: 1: оплата MO 2: оплата TO	2
payment_amount	Обязательно для Purchase, Card Verify	integer	Сумма платежа в дробных единицах валюты. Ограничения: для режимов Purchase, Card Tokenize: "minimum": 1, "maximum": 10000000000000 для режима Card Verify: "minimum": 0, "maximum": 0	10000
payment_currency	Обязательно для Purchase, Card Verify	string	Валюта платежа в формате ISO 4217 alpha-3	USD
payment_description	Рекомендовано	string	Описание платежа	Заказ 3178
payment_extra_param	Нет	string	Параметр, содержащий особые условия обработки платежей. Дополнительные сведения об этой возможности уточняйте у вашего курирующего менеджера
payment_id	Обязательно для Purchase, Card Verify	string	Идентификатор платежа, уникальный в рамках используемого проекта и при этом регистронезависимый. Может содержать до 255 произвольных символов.	order_314
payment_merchant_risk	Нет	string	Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией о деталях покупки пользователя и о предпочтительном для мерчанта варианте аутентификации. Подробнее см. разделе Аутентификация 3‑D Secure
payment_methods_options	Нет	string	Строка, содержащая специфичные параметры отображения выбора платежного метода или платежной страницы. Данные собираются в JSON-объект. Подробнее в разделе Методы в описании платёжных методов о проведении платежей через банки юго-восточной Азии
project_id	Да	integer	Уникальный идентификатор проекта в Payment Page	133
receipt_data	Нет	string	Строка, содержащая в закодированном виде данные для отправки электронного товарного чека пользователю. Данные собираются в JSON-объект и кодируются в Base64. Подробнее см. в Отправка чеков и оповещений пользователям
recurring	Нет	string	Строка, содержащая сведения о повторяемой оплате — в виде объекта JSON, если для вызова платёжной формы используется JavaScript-библиотека ecommpay, или в виде строки, полученной в результате кодирования URL-encoding, если платёжная форма вызывается иным способом. Подробнее — в статье Регистрация повторяемых оплат
recurring_register	Нет	integer	Указатель того, необходимо ли регистрировать данную оплату как повторяемую, с допустимыми значениями `0` и `1`. При работе с Payment Page без использования библиотеки `merchant.js` в этом параметре может указываться булево значение.	1
redirect	Нет	integer	Параметр, включающий открытие сгенерированной платежной страницы в отдельной вкладке 1: открытие в отдельной вкладке 0 или не передан: открытие заданным способом Подробнее см. в Открытие в виде отдельной HTML-страницы При работе с Payment Page без использования библиотеки `merchant.js` в этом параметре может указываться булево значение.	1
redirect_fail_mode	Нет	string	Режим перенаправления пользователя при отклоненной оплате: iframe. Используется по умолчанию parent_page blank_page. В браузере пользователя должна быть отключена блокировка всплывающих окон	parent_page
redirect_fail_url	Нет	string	URL-адрес страницы для перенаправления пользователя в проект в случае отклоненной оплаты. Перенаправление происходит автоматически без дополнительных действий от пользователя. Если используется режим blank_page – страница с результатом отображается в отдельной вкладке, в других режимах – не отображается	http://merchant.site.com
redirect_on_mobile	Нет	integer	Параметр, включающий открытие платежной страницы в отдельной вкладке на мобильных устройствах 1: открытие в отдельной вкладке 0 или не передан: открытие заданным способом Подробнее см. в Открытие в виде отдельной HTML-страницы При работе с Payment Page без использования библиотеки `merchant.js` в этом параметре может указываться булево значение.	1
redirect_success_mode	Нет	string	Режим перенаправления пользователя при проведенной оплате: iframe. Используется по умолчанию parent_page blank_page. В браузере пользователя должна быть отключена блокировка всплывающих окон	parent_page
redirect_success_url	Нет	string	URL-адрес страницы для перенаправления пользователя в проект в случае проведенной оплаты. Перенаправление происходит автоматически без дополнительных действий от пользователя. Если используется режим blank_page – страница с результатом отображается в отдельной вкладке, в других режимах – не отображается	http://merchant.site.com
redirect_return_url	Нет	string	URL-адрес страницы для перенаправления пользователя в проект со страницы оплаты на стороне внешнего провайдера по нажатии на кнопку возврата на любом шаге проведения платежа. О возможности подключения данной функциональности уточняйте у курирующего менеджера	http://merchant.site.com
redirect_tokenize_mode	Нет	string	Режим перенаправления пользователя при успешной токенизации в режиме Card Tokenize iframe. Используется по умолчанию parent_page	parent_page
redirect_tokenize_url	Нет	string	URL-адрес страницы для перенаправления пользователя в ваш проект в случае успешной токенизации в режиме Card Tokenize
region_code	Нет	string	Страна пользователя в формате ISO 3166 alpha-2. По умолчанию определяется по IP-адресу пользователя	ru
signature	Да	string	Подпись, передаваемая в объекте или ссылке на открытие платежной страницы. Подробнее см. в Работа с подписью к данным
style_id	Нет	integer	Идентификатор стиля оформления Payment Page, который может быть использован дополнительным к используемому по умолчанию при работе с платёжной формой 5-го поколения (подробнее)	6123
target_element	Нет	string	Элемент, в который встраивается iframe Payment Page в веб-странице проекта. Подробнее см. в Открытие в элементе iframe HTML-страницы	pay_button_id
terminal_id	Нет	integer	Идентификатор терминала со стилем оформления Payment Page, который может быть использован дополнительным к используемому по умолчанию при работе с формой 4-го и более ранних поколений (подробнее)	54

account_token

Нет

string

Токен банковской карты. При передаче токена в этом параметре виджет открывается с предвыбранной картой.

Notice: Применяется в режимах Purchase и Card Verify.

Дополнительные сведения см. в Проведение оплат по токенам

addendum_data

Нет

string

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

Расширенная информация должна представляться в параметре строкой, закодированной с применением алгоритма Base64. Подробнее о формировании значения параметра addendum_data см. Использование «длинной записи»

avs_post_code

Нет

string

Почтовый индекс пользователя, переданный для выполнения проверки AVS

WS13 6LG

avs_street_address

Нет

string

Адрес пользователя, переданный для выполнения проверки AVS

4 Breadmarket Street

baseUrl

Нет

string

Базовый адрес вызова платёжной формы (в случаях, когда его актуально указывать в явном виде)

best_before

Нет

string

Дата и время срока действия платежа. По истечении срока действия платежа пользователь перенаправляется на страницу с сообщением о том, что время возможности проведения платежа истекло. Параметр передается в формате YYYY-MM-DDThh:mm:ss±hh

2020-04-26T13:50:37+00:00

billing_address

Настраивается

string

Улица платежного адреса пользователя

33 Store Street

billing_city

Настраивается

string

Город платежного адреса пользователя

Londont

billing_country

Настраивается

string

Страна платежного адреса пользователя в формате ISO 3166-1 alpha-2

GB

billing_postal

Настраивается

string

Почтовый индекс платежного адреса пользователя

BR1 1AA

billing_region

Настраивается

string

Регион или штат платежного адреса пользователя

Greater London

billing_region_code

Нет

string

Код штата, провинции или региона страны в формате ISO 3166-2; при указании значения этого параметра также необходимо указать значение параметра billing_country

DOR

booking_info

Нет

string

Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией о бронировании услуг (подробнее)

card_holder

Нет

string

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

CARD HOLDER

card_operation_type

Нет

string

Тип операции в случае проведения оплаты с помощью банковской карты. Возможные значения:

sale: оплата с прямым списанием средств
auth: оплата с холдированием средств

Дополнительные сведения см. в Проведение оплат и Блокировка средств

sale

close_on_missclick

Нет

integer

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

0 — не закрывать виджет по щелчку за его пределами. Это значение по умолчанию.
1 — закрыть виджет при щелчке мышью за его пределами.

Подробнее см. Открытие в модальном окне

При работе с Payment Page без использования библиотеки merchant.js в этом параметре может указываться булево значение.

1

css_modal_wrap

Нет

string

Дополнительный CSS класс оболочки для модального окна. Дополнительные сведения см. в Открытие в модальном окне

modal-popup

customer_address

Настраивается

string

Адрес пользователя. Подробнее см. в Сбор данных о пользователях

Main Street, 12

customer_account_info

Нет

string

Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией об учётной записи пользователя на стороне веб-сервиса и о контактных данных пользователя. Подробнее см. в статье Аутентификация 3‑D Secure

customer_account_number

Нет

string

Номер кошелька или аккаунта пользователя в платежной системе, также может быть номер телефона (указывается с кодом страны и без знака +) или адрес электронной почты пользователя, на который зарегистрирован аккаунт

example@mail.com

customer_birthplace

Настраивается

string

Место рождения пользователя

London

customer_city

Настраивается

string

Город адреса пользователя

London

customer_country

Настраивается

string

Страна адреса пользователя в формате ISO 3166-1 alpha-2

GB

customer_day_of_birth

Настраивается

string

Дата рождения пользователя, ДД-ММ-ГГГГ

12-12-1990

customer_email

Настраивается

string

Адрес электронной почты пользователя.

Необходимо передавать для оплат с прямым использованием платёжных карт, если не указан номер телефона и не используется возможность указания таких сведений самим пользователем (подробнее)

smith@gmail.com

customer_first_name

Настраивается

string

Имя пользователя

Инна

customer_id

Обязательно для Card Tokenize, Purchase

string

Уникальный идентификатор пользователя в вашем проекте. Передаваемые в параметре или объекте customer данные отображаются в карточке платежа в Dashboard

customer_341

customer_last_name

Настраивается

string

Фамилия пользователя

Smith

customer_middle_name

Настраивается

string

Отчество пользователя

Mary

customer_mpi_result

Нет

string

Cтрока, полученная в результате кодирования с применением алгоритма Base64, с данными о предыдущей аутентификации пользователя. Подробнее см. в статье Аутентификация 3‑D Secure

customer_phone

Настраивается

string

Номер телефона пользователя.
В общем случае должен быть полным, с кодом страны, хотя в отдельных случаях (в том числе для карточных платежей) допустимо указание и без кода страны.
Технически номер должен содержать не менее 4 и не более 24 цифр, при этом, если такое допускается в рамках используемого проекта и платёжного метода, в записи номера могут использоваться знаки пунктуации и специальные символы (подобные случаи, как правило, оговариваются отдельно). Необходимо передавать для оплат с прямым использованием платёжных карт, если не указан адрес электронной почты и не используется возможность указания таких сведений самим пользователем (подробнее)

443031237300

customer_security_code

Нет

string

Секретный код счета или кошелька пользователя для подтверждения платежа

852923

customer_shipping

Нет

string

Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией о доставке товара или услуги пользователю. Подробнее см. в статье Аутентификация 3‑D Secure

customer_ssn

Настраивается

integer

Последние 4 цифры номера социального страхования гражданина США

1234

customer_state

Настраивается

string

Штат адреса пользователя

Greater London

customer_street

Нет

string

Улица адреса пользователя

Main

customer_zip

Настраивается

string

Почтовый индекс пользователя

305000

debt_account

Нет

string

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

an9876170i

force_acs_new_window

Нет

integer

Форсированный режим отображения страницы ACS в новом окне, игнорируя настройки Payment Page

1: открытие в отдельной вкладке
0 или параметр отсутствует: открытие заданным способом

При работе с Payment Page без использования библиотеки merchant.js в этом параметре может указываться булево значение.

1

force_payment_method

Нет

string

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

card

force_payment_group

Нет

string

Идентификатор группы платёжных методов, элементами которой должен ограничиваться выбор метода в платёжной форме. При указании этого идентификатора в Payment Page отображаются кнопки выбора только тех методов, которые входят в указанную группу и доступны в рамках используемого проекта. Вместе с тем, при указании этого идентификатора в одном запросе с кодом конкретного метода в параметре force_payment_method платёжная форма открывается для проведения оплаты указанным методом, без учёта выбранной группы.

В настоящее время с помощью этого параметра применим выбор группы методов Open Banking — с помощью идентификатора openbanking.

openbanking

force_payment_method_subtype

Нет

string

Идентификатор типа банковской карты, который откроется по умолчанию без возможности выбора другого, при force_payment_method=card. Также относится к отображению сохраненных карт пользователя. Доступные значения см. в Коды брендов платёжных карт

visa

hide

Нет

string

Идентификатор платежного метода, который будет скрыт от пользователя на Payment Page. Если необходимо скрыть несколько методов – идентификаторы передаются через запятую. Список идентификаторов приведен в Коды платёжных методов

card, cup-card

identify_doc_number

Нет

string

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

6543234567

interface_type

Нет

string

Строка, содержащая информацию об источнике запроса на проведение платежа. Данные собираются в JSON-объект. Доступное значение для параметра id: 7 – Payment Page в режиме iframe

interface_type: {"id":7}

language_code

Рекомендовано

string

Язык, на котором сгенерированная платежная страница будет открыта пользователю. Язык передается в формате ISO 639-1 alpha-2. Если этот параметр не передается, то по умолчанию платежная платформа определяет язык по IP-адресу пользователя

ru

merchant_callback_url

Нет

string

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

merchant_data

Нет

string

Параметр для передачи дополнительной информации о проводимой оплате (например, сведений о предоставляемых услугах). Данные передаются в виде JSON-объекта (подробнее)

merchant_fail_enabled

Нет

integer

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

1

merchant_fail_redirect_mode

Нет

string

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

iframe

merchant_fail_url

Нет

string

URL-адрес страницы для возврата пользователя в проект при отклоненной оплате по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису

http://example.com

merchant_return_enabled

Нет

integer

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

1

merchant_return_redirect_mode

Нет

string

Режим открытия страницы проекта во время возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису

iframe

merchant_return_url

Нет

string

URL-адрес страницы для возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису

http://example.com

merchant_success_enabled

Нет

integer

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

1

merchant_success_redirect_mode

Нет

string

Режим открытия страницы проекта во время возврата пользователя после совершенного платежа. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису

iframe

merchant_success_url

Нет

string

URL-адрес страницы для возврата пользователя в проект при проведенной оплате по нажатии на кнопку возврата. Подробнее см. в разделе Способы возвращения пользователей к веб-сервису

http://example.com

mode

Обязательно для всех режимов, кроме Purchase

string

Режим работы Payment Page. Доступные значения:

purchase: режим Purchase. Используется по умолчанию
card_tokenize: режим Card Tokenize
card_verify: режим Card Verify

card_tokenize

moto_type

Нет

integer

Признак проведения Mail Order/Telephone Order (MO/TO) платежа. Доступные значения:

1: оплата MO
2: оплата TO

2

payment_amount

Обязательно для Purchase, Card Verify

integer

Сумма платежа в дробных единицах валюты. Ограничения:

для режимов Purchase, Card Tokenize:
- "minimum": 1,
- "maximum": 10000000000000
для режима Card Verify:
- "minimum": 0,
- "maximum": 0

10000

payment_currency

Обязательно для Purchase, Card Verify

string

Валюта платежа в формате ISO 4217 alpha-3

USD

payment_description

Рекомендовано

string

Описание платежа

Заказ 3178

payment_extra_param

Нет

string

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

payment_id

Обязательно для Purchase, Card Verify

string

Идентификатор платежа, уникальный в рамках используемого проекта и при этом регистронезависимый. Может содержать до 255 произвольных символов.

order_314

payment_merchant_risk

Нет

string

Строка, полученная в результате кодирования с применением алгоритма Base64, с информацией о деталях покупки пользователя и о предпочтительном для мерчанта варианте аутентификации. Подробнее см. разделе Аутентификация 3‑D Secure

payment_methods_options

Нет

string

Строка, содержащая специфичные параметры отображения выбора платежного метода или платежной страницы. Данные собираются в JSON-объект. Подробнее в разделе Методы в описании платёжных методов о проведении платежей через банки юго-восточной Азии

project_id

Да

integer

Уникальный идентификатор проекта в Payment Page

133

receipt_data

Нет

string

Строка, содержащая в закодированном виде данные для отправки электронного товарного чека пользователю. Данные собираются в JSON-объект и кодируются в Base64. Подробнее см. в Отправка чеков и оповещений пользователям

recurring

Нет

string

Строка, содержащая сведения о повторяемой оплате — в виде объекта JSON, если для вызова платёжной формы используется JavaScript-библиотека ecommpay, или в виде строки, полученной в результате кодирования URL-encoding, если платёжная форма вызывается иным способом. Подробнее — в статье Регистрация повторяемых оплат

recurring_register

Нет

integer

Указатель того, необходимо ли регистрировать данную оплату как повторяемую, с допустимыми значениями 0 и 1.

При работе с Payment Page без использования библиотеки merchant.js в этом параметре может указываться булево значение.

1

redirect

Нет

integer

Параметр, включающий открытие сгенерированной платежной страницы в отдельной вкладке

1: открытие в отдельной вкладке
0 или не передан: открытие заданным способом

Подробнее см. в Открытие в виде отдельной HTML-страницы

При работе с Payment Page без использования библиотеки merchant.js в этом параметре может указываться булево значение.

1

redirect_fail_mode

Нет

string

Режим перенаправления пользователя при отклоненной оплате:

iframe. Используется по умолчанию
parent_page
blank_page. В браузере пользователя должна быть отключена блокировка всплывающих окон

parent_page

redirect_fail_url

Нет

string

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

http://merchant.site.com

redirect_on_mobile

Нет

integer

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

1: открытие в отдельной вкладке
0 или не передан: открытие заданным способом

Подробнее см. в Открытие в виде отдельной HTML-страницы

При работе с Payment Page без использования библиотеки merchant.js в этом параметре может указываться булево значение.

1

redirect_success_mode

Нет

string

Режим перенаправления пользователя при проведенной оплате:

iframe. Используется по умолчанию
parent_page
blank_page. В браузере пользователя должна быть отключена блокировка всплывающих окон

parent_page

redirect_success_url

Нет

string

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

http://merchant.site.com

redirect_return_url

Нет

string

URL-адрес страницы для перенаправления пользователя в проект со страницы оплаты на стороне внешнего провайдера по нажатии на кнопку возврата на любом шаге проведения платежа. О возможности подключения данной функциональности уточняйте у курирующего менеджера

http://merchant.site.com

redirect_tokenize_mode

Нет

string

Режим перенаправления пользователя при успешной токенизации в режиме Card Tokenize

iframe. Используется по умолчанию
parent_page

parent_page

redirect_tokenize_url

Нет

string

URL-адрес страницы для перенаправления пользователя в ваш проект в случае успешной токенизации в режиме Card Tokenize

region_code

Нет

string

Страна пользователя в формате ISO 3166 alpha-2. По умолчанию определяется по IP-адресу пользователя

ru

signature

Да

string

Подпись, передаваемая в объекте или ссылке на открытие платежной страницы. Подробнее см. в Работа с подписью к данным

style_id

Нет

integer

Идентификатор стиля оформления Payment Page, который может быть использован дополнительным к используемому по умолчанию при работе с платёжной формой 5-го поколения (подробнее)

6123

target_element

Нет

string

Элемент, в который встраивается iframe Payment Page в веб-странице проекта. Подробнее см. в Открытие в элементе iframe HTML-страницы

pay_button_id

terminal_id

Нет

integer

Идентификатор терминала со стилем оформления Payment Page, который может быть использован дополнительным к используемому по умолчанию при работе с формой 4-го и более ранних поколений (подробнее)

54