.. meta:: :description: Настройка размещённых платёжных форм Payneteasy: брендинг, цветовая схема, логотип, язык и параметры макета для форм Sale, Preauth и проверки учётной записи. .. _forms_customization_reference: Forms Customization ###################################### .. role:: ex .. role:: code .. _payment_page_display_logic_reference: Платёж Page Display Logic ==================================================== .. uml:: :align: center skinparam ConditionEndStyle hline : (1) Initiate transaction; if ((2) Additional Payer input required?) then (yes) : (3) return input form; : (4) submit form; else (no) endif if ((5) External form required?) then (yes) : (6) request external form from the payment provider; : (7) redirect to external form; : (8) submit form on payment provider side; else (no) endif : (9) show wait form; : (10) process transaction; : (11) show finish form or redirect \nto Connecting Party website; | (1) Транзакции могут инициироваться API-запросами, пакетной загрузкой или через виртуальный терминал в UI. Для каждого метода оплаты предусмотрена собственная логика отображения платёжной страницы. .. note:: Payment Cashier может содержать несколько транзакций, инициированных в рамках одного платёжного сеанса, поскольку для Плательщика может быть доступно несколько способов оплаты. Когда Плательщик выбирает вкладку оплаты, инициируется соответствующая вспомогательная транзакция. См. :ref:`Настройка страницы Payment Cashier`. | (3) Для способа оплаты банковской картой форма отображается на стороне Платёжного Шлюза и может быть настроена. См. :ref:`Настройка страницы оплаты`. Для некоторых других способов оплаты на стороне Платёжного Шлюза могут быть дополнительные формы. За подробностями обратитесь в службу поддержки Payneteasy. | (7) Некоторые методы оплаты требуют перенаправления плательщика на собственную форму. Эта форма не размещается Платёжным Шлюзом и не может быть настроена. | (9) Пока транзакция не достигнет финального статуса, Платёжный Шлюз отображает :ref:`Wait Form` для Плательщика. | (11) После достижения транзакцией окончательного статуса Платёжный Шлюз показывает плательщику :ref:`Finish Form` или выполняет :ref:`перенаправление` на сайт Присоединяющейся стороны. .. _payment_page_customization_reference: Payment Page Customization ==================================================== Payment Page Example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: html

Order #$!MERCHANT_ORDER_ID - $!ORDERDESCRIPTION

Total amount: $!AMOUNT $!CURRENCY to $!MERCHANT

.. note:: Описанный ниже код позволяет передавать данные карты-получателя в транзакциях типа :ref:`Transfer`: .. code-block:: html

Destination card number:

Payment Page Autofill ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Если Присоединяющаяся сторона хочет использовать автозаполнение в платёжной форме, некоторые атрибуты элементов :code:`` :code:`` :code:`` должны быть жёстко заданы следующим образом: .. code-block:: html Credit Card NumberThe 13-19 digits on the front of your card Если необходимо использовать автозаполнение в форме transfer, определённые атрибуты элементов должны быть жёстко заданы следующим образом: .. code-block:: html #if ($INPUT_SOURCE_CARD_CARDHOLDER)

Card printed name:

#end #if ($INPUT_SOURCE_CARD_CVV2)

Card security code (CVV2/CVC2):

#end #end #if ($INPUT_DESTINATION_CARD) #if($!DESTINATIONCARDNO)

Destination card number:

#end #end Payneteasy имеет шаблон формы оплаты по умолчанию, поддерживающий автозаполнение. Если Присоединяющаяся сторона хочет добавить дополнительные поля для автозаполнения, для именования ссылок следует использовать эту `спецификацию `_. Payment Page Template Macros ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :widths: 30, 10, 30 :header-rows: 1 :class: longtable * - Макрос имени поля - Field Value Macro - Описание * - :code:`${APPLE_PAY}` - n/a - Кнопка покупки Apple Pay будет доступна, если используется этот макрос. Недоступно для транзакций Transfer. * - :code:`${GOOGLE_PAY}` - n/a - Кнопка покупки Google Pay будет доступна, если используется этот макрос. Недоступно для транзакций Transfer. * - :code:`${CARDNO}` - :code:`${CARDNOVALUE}` - Номер кредитной карты плательщика. * - :code:`${EXPMONTH}` - n/a - Месяц окончания срока действия банковской карты. * - :code:`${EXPYEAR}` - n/a - Год окончания срока действия банковской карты. * - :code:`${CVV2}` - :code:`${CVV2VALUE}` - Код безопасности карты. Пример: :ex:`432` * - :code:`${CARDHOLDER}` - :code:`${CARDHOLDER_VALUE}` - Карта printed название. * - :code:`${MERCHANT}` - n/a - End point display название. * - :code:`${SKIN_VERSION}` - n/a - Описание: CSS skin version. * - :code:`${ORDERDESCRIPTION}` - n/a - Описание заказа. * - :code:`${CUSTOMER_FIRST_NAME}` - n/a - Имя плательщика, отправленное Присоединяющейся стороной через входные параметры. * - :code:`${CUSTOMER_LAST_NAME}` - n/a - Фамилия плательщика, отправленная Присоединяющейся стороной через входные параметры. * - :code:`${CUSTOMER_EMAIL}` - n/a - Адрес электронной почты плательщика, отправленный Присоединяющейся стороной через входные параметры. * - :code:`${DESTINATIONCARDNO}` - n/a - Номер кредитной карты получателя. Доступно для транзакций Transfer. * - :code:`${DESTINATION_CARD_TYPE}` - n/a - Тип карты получателя. Доступно для транзакций Transfer. * - :code:`${DESTINATION_LAST_FOUR_DIGITS}` - n/a - Последние четыре цифры карты получателя. Доступно для транзакций Transfer. * - :code:`${AMOUNT}` - n/a - Сумма. * - :code:`${CURRENCY}` - n/a - Currency. * - :code:`${DESTINATION_PURPOSE}` - n/a - Назначение, отправленное Присоединяющейся стороной через входные параметры. * - :code:`${PAYNET_ORDER_ID}` - n/a - Идентификатор заказа Payneteasy. * - :code:`${MERCHANT_ORDER_ID}` - n/a - Идентификатор заказа Присоединяющейся Стороны. * - :code:`${refresh_interval}` - n/a - Интервал обновления, рекомендуемый системой. * - :code:`${uuid}` - n/a - Internal. * - :code:`${INTERNAL_SECTION}` - n/a - Внутренний для интеграции iFrame. * - :code:`${CUSTOMER_IP_COUNTRY_ISO_CODE}` - n/a - Страна плательщика, определённая по IP-адресу. * - :code:`${PREFERRED_LANGUAGE}` - n/a - Язык Плательщика, переданный Присоединяющейся стороной через входные параметры. Недоступно для Account Verification. * - :code:`${BROWSER_LANGUAGE}` - n/a - Язык плательщика, определённый настройками браузера. * - :code:`${CUSTOMER_LANGUAGE}` - n/a - Язык Плательщика, переданный Присоединяющейся стороной через входные параметры или определяемый настройками браузера, если первый не задан. * - :code:`${MERCHANT_FORM_DATA}` - n/a - Параметры, отправленные в API-параметре :ex:`MERCHANT_FORM_DATA`, разбираются на макросы с тем же именем; параметр кодируется в URL, например :ex:`testparam%3Dtest1%26mynewparam%3Dtest2`, и разбирается в форме на макросы :ex:`$MFD_testparam = test1` и :ex:`$MFD_mynewparam = test2`. Символы имени параметра: [a-zA-Z0-9], символы значения параметра: [a-zA-Z0-9], управляющие символы: [=&], максимальный размер — 2 МБ. Недоступно для Account Verification. Например, этот параметр можно использовать для отображения платёжной формы в светлом/тёмном режиме в зависимости от значения, переданного Присоединяющейся стороной (например, передайте :code:`merchant_form_data=theme%3Ddark` в запросе, и заполнитель макроса :ex:`$MFD_theme` в платёжной форме изменится на :ex:`dark`). * - :code:`${MIN_AMOUNT}` - n/a - Этот макрос имеет значение, указанное в параметре :code:`minimum-transaction-amount` исходного запроса. Его можно использовать для проверки суммы транзакции перед отправкой платёжной формы. Обратитесь к менеджеру поддержки, чтобы включить эту функцию. * - :code:`${MAX_AMOUNT}` - n/a - Этот макрос имеет значение, указанное в параметре :code:`maximum-transaction-amount` исходного запроса. Его можно использовать для проверки суммы транзакции перед отправкой платёжной формы. Обратитесь к менеджеру поддержки, чтобы включить эту функцию. * - :code:`${CUSTOMER_ZIP_CODE}` - n/a - Генерирует почтовый индекс (ZIP), если он не был получен от Плательщика. Недоступно для Account Verification. .. _prefilled_cardholder_data_in_payment_page: Prefilled Cardholder Data in Payment Page ================================================================================== Данные держателя карты Плательщика, использованные для обработки предыдущей транзакции, можно токенизировать для будущего использования запросом к :ref:`/api/v2/create-card-ref/`. Полученный токен :code:`cardrefid` затем можно передавать в следующих запросах к соответствующему API. При отправке этого параметра все поля ввода данных держателя карты будут неизменяемыми и предварительно заполненными на странице оплаты. CVV не токенизируется и должен быть предоставлен Плательщиком на этой странице оплаты. Ниже приведён пример настройки формы для работы с предварительно заполненными данными держателя карты на странице оплаты. .. note:: Эта функция доступна только для типов транзакций :ref:`Sale` и :ref:`Preauth` и не может использоваться в :ref:`платёжной кассе`. Prefilled Cardholder Data Payment Page Example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: html

Order #$!MERCHANT_ORDER_ID - $!ORDERDESCRIPTION

Total amount: $!AMOUNT $!CURRENCY to $!MERCHANT

Card Holder: ${CARDHOLDER}

Card Number: $!CARD_BIN ...... $!CARD_LAST4DIGITS

Exp year: $!EXPYEAR_VALUE

Exp month: $!EXPMONTH_VALUE

Prefilled Cardholder Data Payment Page Macros ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :widths: 30, 10, 30 :header-rows: 1 :class: longtable * - Макрос имени поля - Field Value Macro - Описание * - :code:`${CARDHOLDER}` - n/a - Имя на карте плательщика. * - :code:`${CARD_BIN}` - n/a - Описание: Full card number. * - :code:`${CARD_LAST4DIGITS}` - n/a - Последние 4 цифры карты. * - :code:`${EXPMONTH_VALUE}` - n/a - Значение месяца истечения срока действия карты. * - :code:`${EXPYEAR_VALUE}` - n/a - Значение года истечения срока действия карты. * - :code:`${CVV2}` - n/a - Описание: CVV2 card value. .. _wait_page_customization_reference: Wait Page Customization ===================================================================== Wait Page Template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Страница ожидания — форма, на которой плательщик остаётся до достижения транзакцией окончательного статуса. .. highlight:: html ::

Order #$!MERCHANT_ORDER_ID - $!ORDERDESCRIPTION

Total amount: $!AMOUNT $!CURRENCY to $!MERCHANT

Please wait, your payment is being processed, remaining seconds. .. note:: Описанный ниже код не относится к :ref:`Account Verification`: .. highlight:: html ::

Total amount: $!AMOUNT $!CURRENCY to $!MERCHANT

Wait Page Template Macros ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :widths: 30, 10, 30 :header-rows: 1 :class: longtable * - Макрос имени поля - Field Value Macro - Описание * - :code:`$!refresh_interval` - n/a - Интервал обновления, рекомендуемый системой. * - :code:`$!MERCHANT_ORDER_ID` - n/a - Идентификатор заказа Присоединяющейся Стороны. * - :code:`$!ORDERDESCRIPTION` - n/a - Описание заказа. * - :code:`$!AMOUNT` - n/a - Сумма. Недоступно для Account verification. * - :code:`$!CURRENCY` - n/a - Валюта. Недоступно для Account verification. * - :code:`$!MERCHANT` - n/a - End point display название. * - :code:`$!uuid` - n/a - Internal. * - :code:`$!{INTERNAL_SECTION}` - n/a - Внутренний для интеграции iFrame. * - :code:`${SKIN_VERSION}` - n/a - Описание: CSS skin version. * - :code:`${PAYNET_ORDER_ID}` - n/a - Идентификатор заказа Payneteasy. * - :code:`${CUSTOMER_IP_COUNTRY_ISO_CODE}` - n/a - Страна плательщика, определённая по IP-адресу. * - :code:`${PREFERRED_LANGUAGE}` - n/a - Язык плательщика, отправленный Присоединяющейся стороной через входные параметры. * - :code:`${BROWSER_LANGUAGE}` - n/a - Язык плательщика, определённый настройками браузера. * - :code:`${CUSTOMER_LANGUAGE}` - n/a - Язык Плательщика, переданный Присоединяющейся стороной через входные параметры или определяемый настройками браузера, если первый не задан. .. _finish_page_customization_reference: Finish Page Customization =========================================================================== Finish Page Template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Форма, на которой плательщику показывается :ref:`окончательный статус` его запроса. .. highlight:: html ::

Processing of the payment has finished

Order Invoice: $!{MERCHANT_ORDER_ID}

Order ID: $!{PAYNET_ORDER_ID}

Status: $!{STATUS}

#if($ERROR_MESSAGE)

Error: $!{ERROR_MESSAGE}

#end Finish Page Macros ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :widths: 30, 10, 30 :header-rows: 1 :class: longtable * - Макрос имени поля - Field Value Macro - Описание * - :code:`${STATUS}` - n/a - Order статус. * - :code:`${PAYNET_ORDER_ID}` - n/a - Описание: System order id. * - :code:`${MERCHANT_ORDER_ID}` - n/a - Идентификатор заказа Присоединяющейся Стороны. * - :code:`${ERROR_MESSAGE}` - n/a - Содержит причину отклонения или сведения об ошибке. * - :code:`${SKIN_VERSION}` - n/a - Описание: CSS skin version. * - :code:`${CUSTOMER_IP_COUNTRY_ISO_CODE}` - n/a - Страна плательщика, определённая по IP-адресу. * - :code:`${PREFERRED_LANGUAGE}` - n/a - Язык плательщика, отправленный Присоединяющейся стороной через входные параметры. * - :code:`${BROWSER_LANGUAGE}` - n/a - Язык плательщика, определённый настройками браузера. * - :code:`${CUSTOMER_LANGUAGE}` - n/a - Язык Плательщика, переданный Присоединяющейся стороной через входные параметры или определяемый настройками браузера, если первый не задан. * - :code:`${AMOUNT}` - n/a - Сумма. Недоступно для Account verification. * - :code:`${CURRENCY}` - n/a - Валюта. Недоступно для Account verification. * - :code:`${DESCRIPTION}` - n/a - Описание транзакции. Недоступно для Account verification. * - :code:`${DATE}` - n/a - Дата транзакции. Недоступно для Account verification. * - :code:`${PAYNET_PROCESSING_DATE}` - n/a - Дата обработки Payneteasy. Недоступно для Account verification. * - :code:`${RRN}` - n/a - Номер ссылки на получение. Недоступно для Account verification. * - :code:`${AUTH_CODE}` - n/a - Код авторизации. Недоступно для Account verification. * - :code:`${CARD_TYPE}` - n/a - Тип карты. Недоступно для Account verification. * - :code:`${LAST_FOUR_DIGITS}` - n/a - Последние четыре цифры карты. Недоступно для Account verification. * - :code:`${CUSTOMER_REDIRECT_URL}` - n/a - URL, на который держатель карты будет перенаправлен после завершения транзакции. .. _payment_cashier_page_customization_reference: Payment Cashier Page Customization ==================================================================== .. note:: Эта страница относится только к интеграции :ref:`Payment Cashier`. Parallel Form Template Sample ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Parallel Form — это форма для выбора Плательщиком одного из доступных способов оплаты для выполнения транзакции. .. code-block:: guess

#if (!$HAS_PARALLEL_FORM_PAYMENT_METHODS) #end #if ($HAS_PARALLEL_FORM_PAYMENT_METHODS)

$!{paymentMethod.name}

#foreach ($paymentMethod in $PARALLEL_FORM_PAYMENT_METHODS)

1) style="display: none;"#end> ${MERCHANT}

#end #end #if ($HAS_PARALLEL_FORM_PAYMENT_METHODS) #foreach ($paymentMethod in $PARALLEL_FORM_PAYMENT_METHODS) #if ($paymentMethod.iframe)

1) style="display: none;"#end>

#end #end #end

Подробнее см. :ref:`Country Codes` и :ref:`Language Codes`. Parallel Form Macros ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :widths: 30, 10, 30 :header-rows: 1 :class: longtable * - Макрос имени поля - Field Value Macro - Описание * - :code:`$!CUSTOMER_IP_COUNTRY_ISO_CODE` - n/a - Страна плательщика, определённая по IP-адресу. * - :code:`$!CUSTOMER_COUNTRY_CODE` - n/a - Страна выставления счёта клиента, переданная во входящем API-запросе. * - :code:`$CUSTOMER_LANGUAGE` - n/a - Язык Плательщика, переданный Присоединяющейся стороной через входные параметры или определяемый настройками браузера, если первый не задан. * - :code:`$HAS_PARALLEL_FORM_PAYMENT_METHODS` - n/a - Определяет доступность параллельных методов оплаты формы. * - :code:`$paymentMethod` - n/a - Объект метода оплаты. * - :code:`$PARALLEL_FORM_PAYMENT_METHODS` - n/a - Массив с доступными параллельными методами оплаты формы. * - :code:`$!{paymentMethod.identifier}` - n/a - Идентификатор метода оплаты. * - :code:`$velocityCount` - n/a - Порядковый номер метода оплаты. * - :code:`$paymentMethod.iframe` - n/a - Iframe метода оплаты. * - :code:`$!{paymentMethod.name}` - n/a - Описание: Payment method name. * - :code:`${MERCHANT}` - n/a - End point display название. * - :code:`$!{paymentMethod.countries}` - n/a - Страны, установленные для этого метода оплаты. * - :code:`$$!paymentMethod.initSessionUrl` - n/a - URL для инициализации сессии метода оплаты. * - :code:`$!WAIT_FORM_URL` - n/a - Описание: Waiting form URL. * - :code:`$p` - n/a - Параметр формы ожидания. * - :code:`$WAIT_FORM_PARAMETERS` - n/a - Массив параметров формы ожидания. * - :code:`$p.key` - n/a - Ключ параметра формы ожидания. * - :code:`$!p.value` - n/a - Значение параметра формы ожидания. * - :code:`$!{INTERNAL_SECTION}` - n/a - Внутренний для интеграции iFrame. Parallel Form Scripts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Следующие скрипты Parallel Form необходимы для её работы. Первый скрипт следует добавить в тег :code:`` html-документа: .. highlight:: html :: Второй скрипт следует добавить в HTML-код перед закрывающим тегом :code:``. .. highlight:: html :: Если необходимо определить страну биллинга Плательщика по данным, переданным через API, используется :code:`$!CUSTOMER_COUNTRY_CODE`. Если необходимо определить страну биллинга Плательщика по IP-адресу из браузера Плательщика, используйте :code:`$!CUSTOMER_IP_COUNTRY_ISO_CODE`; страна биллинга также изменится в соответствии с IP. Основной набор по стране выставления счёта: .. highlight:: html ::