Параметры открытия платежной страницы Payment Page

В этом разделе собраны все параметры, которые могут использоваться при вызове Payment Page. Для каждого параметра приведено описание, а также информация о его имени, типе и обязательности.

Все параметры делятся на три вида по их обязательности:

  • strictly required — параметр всегда обязателен
  • optional — параметр необязателен
  • required conditionally — обязательность параметра зависит от ситуации. Подробнее узнавайте в описании параметра.
Внимание: Протокол открытия платежной формы Payment Page запрещает использование в прямом виде символа "точка с запятой" (;) в значениях передаваемых параметров и в строке запроса.
Табл. 1. Параметры вызова Payment Page
Параметр Описание

account_token
string, optional

Токен банковской карты. При передаче токена в этом параметре виджет откроется с относящейся к этому токену картой в качестве уже выбранной карты.
Ограничение: Применяется в режимах Purchase и Card Verify.

Подробнее см. Оплата по токену

addendum_data
string, optional

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

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

baseUrl
string, required conditionally

Базовый URL-адрес Payment Page.

Параметр обязателен, если базовый домен Payment Page отличается от домена, в котором расположены библиотеки (по умолчанию это https://paymentpage.rocketpay.kz).

best_before
string, optional

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

Пример: 2020-04-26T13:50:37+00:00

billing_address
string, optional

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

Пример: Центральная ул., 20

billing_city
string, required conditionally

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

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

Пример: Дубна

billing_country
string, optional

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

Пример: RU

billing_postal
string, optional

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

Пример: 101000

billing_region
string, required conditionally

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

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

Пример: Московская область

billing_region_code
string, optional

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

Пример: MOS

card_holder
string, optional

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

Пример: JOHN DOW

card_operation_type
string, optional

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

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

.

Пример: sale

checkout_script
boolean, optional

Параметр, определяющий возможность проведения оплаты или проверки действительности карты по токену без ввода CVV/CVC/CID с использованием скрипта шифрования. Подробнее см. в разделе Скрипт шифрования карточных данных.

Пример: 1

close_on_missclick
boolean, optional

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

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

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

Пример: 1

css_modal_wrap
string, optional

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

Пример: modal-popup

customer_address
string, required conditionally

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

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

Пример: Центральная ул., 2

customer_birthplace
string, required conditionally

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

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

Пример: Курск

customer_city
string, required conditionally

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

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

Пример: Курск

customer_country
string, required conditionally

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

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

Пример: RU

customer_day_of_birth
string, required conditionally

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

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

Пример: 12-12-1990

customer_email
string, strictly required

Электронная почта пользователя.

Пример: johndoe@example.com

customer_first_name
string, strictly required

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

Пример: Инна

customer_id
string, strictly required

Уникальный идентификатор пользователя в вашем проекте.

Пример: customer_341

customer_last_name
string, strictly required

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

Пример: Малая

customer_middle_name
string, optional

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

Пример: Ивановна

customer_phone
string, required conditionally

Телефон пользователя. Должен включать код страны и содержать от 4 до 24 цифр без знаков пунктуации и специальных символов.

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

Пример: 74991234567

customer_ssn
integer, optional

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

Пример: 1234

customer_state
string, optional

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

Пример: Курская область

customer_street
string, optional

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

Пример: Центральная

customer_zip
string, required conditionally

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

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

Пример: 305000

debt_account
string, optional

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

Пример: an9876170i

descriptor
string, optional

Краткая информация, идентифицирующая мерчанта, который осуществил операцию. Максимальная длина — 13, допустимо использование букв латинского алфавита, цифр и следующих символов:# $ * ( ) - _ = + " ; : ? \ / , . ` ' ^.

Пример: Merchant_1

force_acs_new_window
boolean, optional

Форсированный режим отображения страницы ACS в новом окне, игнорируя настройки Payment Page. Возможные значения:
  • 1 — открытие в отдельной вкладке
  • параметр отсутствует: платежная форма Payment Page открывается, как определено в ее настройке

Пример: 1

force_payment_method_subtype
string, optional

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

Пример: visa

identify_doc_number
string, optional

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

Пример: 6543234567

identify_doc_type
string, optional

Вид документа, номер которого передается в параметре identify_doc_number.

Пример: CC

language_code
string, optional

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

Пример: ru

merchant_callback_url
string, optional

Параметр для передачи URL-адреса, на который платежная платформа будет отправлять оповещения в процессе обработки платежа.
Пример:
http://example.com/callback

merchant_success_callback_url
string, optional

URL-адрес, на который Rocketpay отправит callback-оповещение о результате платежа, если он будет успешно проведен

merchant_decline_callback_url
string, optional

URL-адрес, на который Rocketpay отправит callback-оповещение о результате платежа, если он будет отклонен

merchant_data
string, optional

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

merchant_fail_enabled
integer, optional

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

Пример: 1

merchant_fail_redirect_mode
string, optional

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

Пример: iframe

merchant_fail_url
string, optional

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

Пример: http://example.com

merchant_return_enabled
integer, optional

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

Пример: 1

merchant_return_redirect_mode
string, optional

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

Пример: iframe

merchant_return_url
string, optional

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

Пример: http://example.com

merchant_success_enabled
integer, optional

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

Пример: 1

merchant_success_redirect_mode
string, optional

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

Пример: iframe

merchant_success_url
string, optional

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

Пример: http://example.com

mode
string, strictly required

Режим работы Payment Page. Этот параметр можно не указывать, если предполагается использовать режим Purchase.

Возможные значения:

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

Пример: card_tokenize

payment_amount
integer, strictly required

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

В режимах Purchase и Card Tokenize на значение этого параметра накладываются ограничения:

  • минимально возможное значение — 1
  • максимально возможное значение 10000000000000

В режиме Card Verify допустимо только значение 0.

Пример: 10000

payment_currency
string, strictly required

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

Пример: USD

payment_description
string, optional

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

Пример: Заказ 3178

payment_extra_param
string, optional

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

payment_id
string, strictly required

Уникальный идентификатор платежа в вашем проекте.

Пример: Z4205

project_id
integer, strictly required

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

Пример: 133

receipt_data
string, optional

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

recurring
string, optional

Строка, содержащая в закодированном виде параметры регистрации и проведения COF-платежа. Данные собираются в JSON-объект и кодируются в URL-encoded. Структура JSON-объекта приведена в API, схема recurringinfo.

Подробнее см. в Регистрация повторяемой оплаты

recurring_register
boolean, optional

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

Пример: 1

redirect
boolean, optional

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

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

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

.

Пример: 1

redirect_fail_mode
string, optional

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

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

Пример: parent_page

redirect_fail_url
string, optional

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

Пример: http://merchant.site.com

redirect_on_mobile
boolean, optional

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

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

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

.

Пример: 1

redirect_success_mode
string, optional

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

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

Пример: parent_page

redirect_success_url
string, optional

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

Пример: http://merchant.example.com

redirect_return_url
string, optional

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

Пример: http://merchant.example.com

redirect_tokenize_mode
string, optional

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

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

Пример: parent_page

redirect_tokenize_url
string, optional

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

region_code
string, optional

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

Пример: ru

signature
string, strictly required

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

target_element
string, optional

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

Пример: pay_button_id

terminal_id
integer, optional

Уникальный идентификатор шаблона Payment Page, который требуется запустить, игнорируя региональные настройки и настройки A/B тестов.

Пример: 54