Создание Коннектора платежного шлюза

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

Чтобы создать Коннектор платежного шлюза, необходимо:

Войти в Панель управления Оператора на уровне корневого Реселлера.
На Панели навигации перейти в раздел Коннекторы платежных шлюзов (см. Навигация по Панели управления Оператора). Отобразится список Коннекторов (см. Просмотр списка Коннекторов платежных шлюзов).
На Панели инструментов нажать кнопку Создать. Отобразится страница Новый коннектор платежных шлюзов.
В поле Название ввести имя Коннектора, которое, в частности, будет отображаться при создании Способа оплаты (см. Создание Способа оплаты).
В поле URL коннектора ввести URL, на который платформа должна отправлять запросы при работе с платежным шлюзом. Пример: https://gateway.example.com
Если требуется, в поле Период обработки платежа ввести число минут, по истечении которых Платеж в статусе Обрабатывается должен вернуться в статус Ожидает оплаты, если от платежного шлюза для него не получен результат оплаты.
Платеж в статусе отличном от Обрабатывается не меняет статус по истечении таймера Период обработки платежа.
Если от платежного шлюза получен результат оплаты для Платежа уже после истечения таймера Период обработки платежа, Платеж в статусе Ожидает оплаты, ведет себя следующим образом:
- Если оплата прошла успешно, Платеж переходит в статус Завершен. Если Клиент успел инициировать повторную оплату по этому Платежу до перехода в статус Завершен:
  - Если повторная оплата прошла успешно, Платеж остается в статусе Завершен. Сумма повторной оплаты возвращается на Баланс клиента.
  - Если результат повторной оплаты отличен от успешного, Платеж остается в статусе Завершен. В карточке Платежа в Панели управления Клиента описание ошибки, полученное от платежного шлюза, не отображается.
- Если результат оплаты отличен от успешного, Платеж остается в статусе Ожидает оплаты. В карточке Платежа в Панели управления Клиента отображается описание ошибки, полученное от платежного шлюза.

В поле JSON схема указать спецификацию данных в формате JSON для описания настроек Коннектора. Значения настроек указываются позже при создании Способа оплаты (см. Создание Способа оплаты).

JSON-схема — это массив объектов, описывающий настройки Коннектора. Он содержит типы полей, требования к их значениям и порядок отображения соответствующих HTML-элементов (текстовое поле, флажок, список и т.д.) в группе Настройки коннектора на странице Способа оплаты с типом интеграции External Payment Gateway (см. Создание Способа оплаты).

В JSON-схеме поддерживаются следующие поля:

Название поля

Тип поля

Обязательный

Уникальный

Описание

type

String

Да

Нет

Тип HTML-элемента:

string — однострочное текстовое поле.
password — однострочное текстовое поле для ввода пароля. Вводимые символы маскируются.
text — многострочное текстовое поле.
select — список для выбора одного из значений, указанных в параметре options.
radio — группа кнопок-переключателей для выбора одного из значений, указанных в параметре options.
checkbox — группа флажков для выбора любых значений, указанных в параметре options..

key

String

Да

Ключ поля

label

String

Да

Подпись к HTML-элементу

hint

String

Нет

Текст подсказки, который отображается при наведении на иконку возле подписи к HTML-элементу. Иконка отображается, если поле hint непустое

required

Boolean

Да

Нет

Признак обязательности заполнения

default_value

String

Нет

Предустановленное по умолчанию значение. Для типов select, radio, checkbox значение поля должно совпадать с value одного из параметров options

options

Array of Objects

Нет

Массив объектов для формирования списка значений. Только Для типов select, radio, checkbox. Каждый объект состоит из следующих полей:

Название поля	Тип поля	Обязательный	Описание
value	String	Да	Значение элемента списка
name	String	Да	Отображаемое название элемента списка

priority

Number

Нет

Да

Приоритет отображения. Поля с меньшим значением priority отображаются выше

Пример JSON-схемы:

[
  {
    "type": "string",
    "key": "api_username",
    "label": "API Username",
    "hint": "Your PayPay Username",
    "required": true,
    "default_value": "",
    "options": [],
    "priority": 1
  },
  {
    "type": "password",
    "key": "api_password",
    "label": "API Password",
    "hint": "Your PayPay Password",
    "required": true,
    "default_value": "",
    "options": [],
    "priority": 2
  },
  {
    "type": "select",
    "key": "integration_type",
    "label": "Integration Type",
    "hint": "Your Integration Type",
    "required": true,
    "default_value": "type-1",
    "options": [
      {
        "value": "type-1",
        "name": "Type 1"
      },
      {
        "value": "type-2",
        "name": "Type 2"
      }
    ],
    "priority": 3
  }
]

Пример отображения настроек Коннектора согласно схеме:

Если требуется, в поле Static JSON указать статическую схему настроек Коннектора в формате JSON. Это общие настройки, которые используются для всех Способов оплаты при работе с платежным шлюзом (например, параметры авторизации).
Нажать кнопку Создать. Платформа выполнит валидацию JSON-схем:
- Если JSON-схема валидна, отобразится список с созданным Коннектором платежного шлюза.
- Если JSON-схема невалидна, отобразится сообщение с описанием проблемы.

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