Параметры открытия платежной страницы Payment Page
В этом разделе собраны все параметры, которые могут использоваться при вызове Payment Page. Для каждого параметра приведено описание, а также информация о его имени, типе и обязательности.
Все параметры делятся на три вида по их обязательности:
- strictly required — параметр всегда обязателен
- optional — параметр необязателен
- required conditionally — обязательность параметра зависит от ситуации. Подробнее узнавайте в описании параметра.
Параметр | Описание |
---|---|
account_token |
Токен банковской карты. При передаче токена в этом параметре виджет откроется с относящейся к этому токену картой в качестве уже выбранной карты. Ограничение: Применяется в режимах Purchase и Card Verify.
Подробнее см. Оплата по токену |
addendum_data |
Этот параметр используется для передачи расширенной информации о бронировании, например номер брони, имена гостей отелей или путешественников. Параметр поддерживается только для компаний, работающих в туристической отрасли. Расширенная информация должна представляться в параметре строкой, закодированной с применением алгоритма Base64. Подробнее о формировании значения параметра addendum_data см. Длинная запись в Payment Page |
baseUrl |
Базовый URL-адрес Payment Page. Параметр обязателен, если базовый домен Payment Page отличается от домена, в котором расположены библиотеки (по умолчанию это https://paymentpage.rocketpay.kz). |
best_before |
Дата и время срока действия платежа. По истечении срока действия платежа пользователь перенаправляется на страницу с сообщением о том, что время возможности проведения платежа истекло. Параметр передается в формате YYYY-MM-DDThh:mm:ss±hh:mm .Пример: |
billing_address |
Улица платежного адреса пользователя. Пример: |
billing_city |
Город платежного адреса пользователя. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
billing_country |
Страна платежного адреса пользователя в формате ISO 3166-1 alpha-2. Пример: |
billing_postal |
Почтовый индекс платежного адреса пользователя. Пример: |
billing_region |
Регион или штат платежного адреса пользователя. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
billing_region_code |
Код штата, провинции или региона страны в формате ISO 3166-2; при указании значения этого параметра также необходимо указать значение параметра billing_country .Пример: |
card_holder |
Имя держателя карты, как указано на карте. При передаче параметра значение сразу отображается и доступно для редактирования на платежной форме. Пример: |
card_operation_type |
Тип операции в случае проведения оплаты с помощью банковской карты. Возможные значения:
Дополнительные сведения см. в Оплата с использованием Payment Page и Блокировка средств .Пример: |
checkout_script |
Параметр, определяющий возможность проведения оплаты или проверки действительности карты по токену без ввода CVV/CVC/CID с использованием скрипта шифрования. Подробнее см. в разделе Скрипт шифрования карточных данных. Пример: |
close_on_missclick |
Параметр, определяющий поведение виджета, открытого в модальном окне, при щелчке за пределами области отображения виджета:
Подробнее см. Открытие платежной страницы в модальном окне. Пример: |
css_modal_wrap |
Дополнительный CSS класс оболочки для модального окна. Дополнительные сведения см. в Открытие платежной страницы в модальном окне. Пример: |
customer_address |
Адрес пользователя. Подробнее см. в Сбор данных о пользователе. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
customer_birthplace |
Место рождения пользователя. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
customer_city |
Город адреса пользователя. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
customer_country |
Страна адреса пользователя в формате ISO 3166-1 alpha-2. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: RU |
customer_day_of_birth |
Дата рождения пользователя, ДД-ММ-ГГГГ. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
customer_email |
Электронная почта пользователя. Пример: |
customer_first_name |
Имя пользователя. Пример: |
customer_id |
Уникальный идентификатор пользователя в вашем проекте. Пример: |
customer_last_name |
Фамилия пользователя. Пример: |
customer_middle_name |
Отчество пользователя. Пример: |
customer_phone |
Телефон пользователя. Должен включать код страны и содержать от 4 до 24 цифр без знаков пунктуации и специальных символов. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
customer_ssn |
Последние 4 цифры номера социального страхования гражданина США. Пример: |
customer_state |
Штат адреса пользователя. Пример: |
customer_street |
Улица адреса пользователя. Пример: |
customer_zip |
Почтовый индекс пользователя. Обязательность параметра уточняйте у своего курирующего менеджера в Rocketpay. Пример: |
debt_account |
Номер счета для получения средств с карты пользователя с целью погашения задолженности. Допустимы буквы латинского алфавита и цифры, длина не более 10 символов. Пример: |
descriptor |
Краткая информация, идентифицирующая мерчанта, который осуществил операцию. Максимальная длина — 13, допустимо использование букв латинского алфавита, цифр и следующих символов:# $ * ( ) - _ = + " ; : ? \ / , . ` ' ^ .Пример: |
force_acs_new_window |
Форсированный режим отображения страницы ACS в новом окне, игнорируя настройки Payment Page. Возможные значения:
Пример: |
force_payment_method_subtype |
Идентификатор типа банковской карты, который откроется по умолчанию без возможности выбора другого, при force_payment_method=card . Также относится к отображению сохраненных карт пользователя. Возможные значения см. в Поддерживаемые типы платежных карт.Пример: |
identify_doc_number |
Номер документа, подтверждающего личность пользователя. Пример: |
identify_doc_type |
Вид документа, номер которого передается в параметре identify_doc_number. Пример: |
language_code |
Язык, на котором сгенерированная платежная страница будет открыта пользователю. Язык передается в формате ISO 639-1 alpha-2. Если этот параметр не передается, то по умолчанию платежная платформа определяет язык по IP-адресу пользователя. Прим.: Это необязательный параметр, но его настоятельно рекомендуется задавать.
Пример: |
merchant_callback_url |
Параметр для передачи URL-адреса, на который платежная платформа будет отправлять оповещения в процессе обработки платежа. Пример:
http://example.com/callback |
merchant_success_callback_url |
URL-адрес, на который Rocketpay отправит callback-оповещение о результате платежа, если он будет успешно проведен |
merchant_decline_callback_url |
URL-адрес, на который Rocketpay отправит callback-оповещение о результате платежа, если он будет отклонен |
merchant_data |
Параметр для передачи расширенной информации о проводимой оплате (например, данные о предоставляемых услугах). Данные можно передавать в любом виде, в том числе в виде JSON-объекта, закодированного с использованием алгоритма Base64 |
merchant_fail_enabled |
Параметр, отвечающий за возможность возврата пользователя в проект при отклоненной оплате. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_fail_redirect_mode |
Режим открытия страницы проекта во время возврата пользователя в проект после отклоненного платежа. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_fail_url |
URL-адрес страницы для возврата пользователя в проект при отклоненной оплате по нажатии на кнопку возврата. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_return_enabled |
Параметр, отвечающий за возможность возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_return_redirect_mode |
Режим открытия страницы проекта во время возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_return_url |
URL-адрес страницы для возврата пользователя в проект на любом шаге оплаты по нажатии на кнопку возврата. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_success_enabled |
Параметр, отвечающий за возможность возврата пользователя в проект после совершенного платежа. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_success_redirect_mode |
Режим открытия страницы проекта во время возврата пользователя после совершенного платежа. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
merchant_success_url |
URL-адрес страницы для возврата пользователя в проект при проведенной оплате по нажатии на кнопку возврата. Подробнее см. в разделе Способы возврата пользователя в проект после оплаты. Пример: |
mode |
Режим работы Payment Page. Этот параметр можно не указывать, если предполагается использовать режим Purchase. Возможные значения:
Пример: |
payment_amount |
Сумма платежа в дробных единицах валюты без десятичной точки и пробелов за исключением случаев, когда у валюты нет дробной части. Если у валюты нет дробных единиц (иначе говоря, количество разрядов дробных единиц равно нулю), то в этом параметре нужно указывать сумму в основных единицах валюты. Подробнее о разрядах дробных единиц у валют см. Коды валют
В режимах Purchase и Card Tokenize на значение этого параметра накладываются ограничения:
В режиме Card Verify допустимо только значение Пример: |
payment_currency |
Валюта платежа в формате ISO 4217 alpha-3. Пример: |
payment_description |
Описание платежа. Прим.: Это необязательный параметр, но его настоятельно рекомендуется задавать в запросе.
Пример: |
payment_extra_param |
Параметр, содержащий особые условия обработки платежей. Дополнительные сведения об этой возможности уточняйте у своего курирующего менеджера |
payment_id |
Уникальный идентификатор платежа в вашем проекте. Пример: |
project_id |
Уникальный идентификатор проекта в Payment Page. Пример: |
receipt_data |
Строка, содержащая в закодированном виде данные для отправки электронного товарного чека пользователю. Данные собираются в JSON-объект и кодируются в Base64. Подробнее см. в Отправка чеков пользователю |
recurring |
Строка, содержащая в закодированном виде параметры регистрации и проведения COF-платежа. Данные собираются в JSON-объект и кодируются в URL-encoded. Структура JSON-объекта приведена в API, схема recurringinfo. Подробнее см. в Регистрация повторяемой оплаты |
recurring_register |
Параметр, который показывает, будет ли данный платеж зарегистрирован как рекуррентный. Пример: |
redirect |
Параметр, включающий открытие сгенерированной платежной страницы в отдельной вкладке
Подробнее см. в Открытие платежной страницы в отдельной вкладке браузера .Пример: |
redirect_fail_mode |
Режим перенаправления пользователя при отклоненной оплате:
Пример: |
redirect_fail_url |
URL-адрес страницы для перенаправления пользователя в проект в случае отклоненной оплаты. Перенаправление происходит автоматически без дополнительных действий от пользователя. Если используется режим blank_page, то страница с результатом откроется в отдельной вкладке, в остальных режимах страница отображаться не будет. Пример: |
redirect_on_mobile |
Параметр, включающий открытие платежной страницы в отдельной вкладке на мобильных устройствах
Подробнее см. в Вызов платежной страницы командой .Пример: |
redirect_success_mode |
Режим перенаправления пользователя при проведенной оплате:
Пример: |
redirect_success_url |
URL-адрес страницы для перенаправления пользователя в проект в случае проведенной оплаты. Перенаправление происходит автоматически без дополнительных действий от пользователя. Если используется режим blank_page – страница с результатом отображается в отдельной вкладке, в других режимах – не отображается. Пример: |
redirect_return_url |
URL-адрес страницы для перенаправления пользователя в проект со страницы оплаты на стороне внешнего провайдера по нажатии на кнопку возврата на любом шаге проведения платежа. О возможности подключения данной функциональности уточняйте у курирующего менеджера. Пример: |
redirect_tokenize_mode |
Режим перенаправления пользователя при успешной токенизации в режиме Card Tokenize
Пример: |
redirect_tokenize_url |
URL-адрес страницы для перенаправления пользователя в ваш проект в случае успешной токенизации в режиме Card Tokenize |
region_code |
Страна пользователя в формате ISO 3166 alpha-2. По умолчанию определяется по IP-адресу пользователя. Пример: |
signature |
Подпись, передаваемая в объекте или ссылке на открытие платежной страницы. Подробнее см. в Подписывание и проверка подписи |
target_element |
Элемент, в который встраивается iframe Payment Page в веб-странице проекта. Подробнее см. Открытие платежной страницы, встроенной в веб-страницу. Пример: |
terminal_id |
Уникальный идентификатор шаблона Payment Page, который требуется запустить, игнорируя региональные настройки и настройки A/B тестов. Пример: |