> ## Documentation Index > Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt > Use this file to discover all available pages before exploring further. # Глоссарий: Платёжные шлюзы > Справочник клиента платёжного шлюза FreedomPay, схем его запросов и справочников значений. Справочник к странице [«Платёжные шлюзы»](/ru/logic/company-billing/gateways). ## Понятия | Понятие | Значение | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Клиент FreedomPay | Клиент платёжного шлюза FreedomPay: формирует подпись, инициирует платежи и рекуррентные списания по сохранённым картам, управляет картами и статусами платежей. | | Базовые поля подписи | Базовый набор полей со случайной солью и MD5-подписью, наследуемый всеми запросами FreedomPay. | ## Модели и поля ### Клиент FreedomPay *Клиент платёжного шлюза FreedomPay: формирует подпись, инициирует платежи и рекуррентные списания по сохранённым картам, управляет картами и статусами платежей. Инициализируется как синглтон из настроек платёжных вариантов; обмен ведётся XML-ответами.* **Настройки** | Поле | Тип | Описание | | ----------------------- | ----- | ------------------------------------------------ | | Адрес шлюза | текст | базовый URL API FreedomPay | | Идентификатор мерчанта | текст | ID магазина в FreedomPay | | Секретный ключ мерчанта | текст | используется для создания MD5-подписи запросов | | Секретный ключ выплат | текст | отдельный секрет для операций выплат | | Тестовый режим | флаг | 1 включает тестовый режим, иначе не задан | | Базовый URL сайта | текст | префикс, добавляемый к URL проверки и результата | **Методы** | Поле | Тип | Описание | | -------------------------------------- | ----- | ----------------------------------------------------------------- | | Отправка запроса | метод | POST на шлюз с JSON, разбор XML-ответа в словарь | | Создание подписи | метод | MD5-подпись из имени скрипта, отсортированных полей и секрета | | Инициация платежа | метод | создаёт обычный платёж (оплата подписки) с чеком и шаблоном формы | | Инициация платежа по сохранённой карте | метод | рекуррентное списание по токену карты | | Подтверждение оплаты по карте | метод | вызов оплаты по идентификатору платежа | | Прямое списание по карте | метод | вызов прямого списания по идентификатору платежа | | Привязка карты | метод | добавление карты в хранилище (с откатом на упрощённый способ) | | Список карт | метод | получение сохранённых карт пользователя | | Удаление карты | метод | удаление карты из хранилища по токену | | Статус платежа | метод | запрос статуса платежа | | Отмена платежа | метод | отмена незавершённого платежа | | Возврат платежа | метод | полный или частичный возврат средств | | Списание заблокированной суммы | метод | клиринг ранее авторизованного платежа | ### Базовые поля подписи *Базовый набор полей со случайной солью и MD5-подписью, наследуемый всеми запросами FreedomPay.* | Поле | Тип | Описание | | ------- | ----- | ----------------------------------------- | | Соль | текст | случайная строка для уникальности подписи | | Подпись | текст | MD5-подпись запроса | ### Данные инициации платежа *Полный набор параметров запроса на создание обычного платежа в FreedomPay. Наследует «Базовые поля подписи».* **Идентификация** | Поле | Тип | Описание | | ---------------------- | ----- | ------------------------------- | | Идентификатор мерчанта | текст | — | | Идентификатор заказа | текст | внутренний номер заказа/инвойса | **Деньги** | Поле | Тип | Описание | | ------------ | ------ | --------------------------------- | | Сумма | число | сумма платежа | | Валюта | связь | код валюты (см. «Валюта платежа») | | Позиции чека | список | состав фискального чека | **Параметры** | Поле | Тип | Описание | | ----------------------- | ------ | ---------------------------------------------------------------- | | Платёжная система | текст | — | | Описание | текст | назначение платежа | | Отложенный платёж | связь | флаг включения (см. «Флаг ВКЛ/ВЫКЛ») | | Язык | связь | язык платёжной формы (см. «Язык формы оплаты») | | Тестовый режим | связь | флаг включения (см. «Флаг ВКЛ/ВЫКЛ») | | Маршрут платежа | текст | — | | Параметры шаблона формы | список | настройки отображения формы (Apple/Google Pay, сохранение карты) | **Сроки** | Поле | Тип | Описание | | ------------------- | ----- | ------------------------------ | | Время жизни платежа | число | срок действия платёжной ссылки | **URL** | Поле | Тип | Описание | | -------------- | ----- | --------------------------------- | | URL проверки | текст | callback предварительной проверки | | URL результата | текст | callback итога платежа | | URL возврата | текст | — | | URL списания | текст | — | | URL успеха | текст | редирект при успешной оплате | | URL ошибки | текст | редирект при неудаче | | URL состояния | текст | — | | URL сайта | текст | — | **Методы запросов** | Поле | Тип | Описание | | ------------------- | ----- | ------------------------- | | Метод запроса | текст | по умолчанию POST | | Метод URL успеха | связь | см. «HTTP-метод callback» | | Метод URL ошибки | связь | см. «HTTP-метод callback» | | Метод URL состояния | связь | см. «HTTP-метод callback» | **Пользователь** | Поле | Тип | Описание | | -------------------- | ----- | ------------- | | Телефон пользователя | текст | — | | Email пользователя | текст | — | | IP пользователя | текст | IPv4 или IPv6 | **Рекуррент** | Поле | Тип | Описание | | ---------------- | ----- | ------------------------------------------------------- | | Старт рекуррента | связь | флаг начала рекуррентных списаний (см. «Флаг ВКЛ/ВЫКЛ») | | Срок рекуррента | число | срок действия рекуррентного профиля | ### Данные карты (привязка/список) *Параметры запросов привязки карты и получения списка сохранённых карт. Наследует «Базовые поля подписи».* | Поле | Тип | Описание | | -------------------------- | ----- | -------------------------------- | | Идентификатор мерчанта | текст | — | | Идентификатор пользователя | текст | — | | Ссылка callback | текст | URL уведомления о привязке карты | | Ссылка возврата | текст | URL возврата пользователя | ### Данные удаления карты *Параметры запроса удаления сохранённой карты из хранилища. Наследует «Базовые поля подписи».* | Поле | Тип | Описание | | -------------------------- | ----- | ------------------------------- | | Идентификатор мерчанта | текст | — | | Идентификатор пользователя | текст | — | | Токен карты | текст | идентификатор сохранённой карты | ### Данные прямого платежа по карте *Параметры инициации рекуррентного списания по сохранённой карте. Наследует «Базовые поля подписи».* | Поле | Тип | Описание | | -------------------------- | ------ | ------------------------------ | | Идентификатор мерчанта | текст | — | | Сумма | число | — | | Идентификатор заказа | текст | — | | Идентификатор пользователя | текст | — | | Токен карты | текст | сохранённая карта для списания | | Описание | текст | — | | URL проверки | текст | — | | URL результата | текст | — | | URL успеха | текст | — | | URL ошибки | текст | — | | Телефон пользователя | текст | — | | Email пользователя | текст | — | | Позиции чека | список | — | | Валюта | связь | см. «Валюта платежа» | ### Данные прямого списания *Параметры запроса прямого списания по идентификатору платежа. Наследует «Базовые поля подписи».* | Поле | Тип | Описание | | ---------------------- | ----- | -------- | | Идентификатор мерчанта | текст | — | | Идентификатор платежа | число | — | ### Позиция чека *Одна позиция фискального чека для карточного платежа. Отдельная структура, не наследует базовые поля подписи.* | Поле | Тип | Описание | | ------------ | ----- | -------- | | Наименование | текст | — | | Количество | число | — | | Тип налога | число | — | | Цена | число | — | ### Данные операции по платежу *Параметры запросов статуса, оплаты и отмены платежа по его идентификатору. Используется для запроса статуса, отмены и оплаты по карте.* | Поле | Тип | Описание | | ---------------------- | ----- | -------- | | Идентификатор мерчанта | текст | — | | Идентификатор платежа | число | — | ### Данные возврата платежа *Параметры запроса полного или частичного возврата средств. Наследует «Базовые поля подписи».* | Поле | Тип | Описание | | ---------------------- | ----- | ------------------------- | | Идентификатор мерчанта | текст | — | | Идентификатор платежа | число | — | | Сумма возврата | текст | 0 означает полный возврат | ### Данные клиринга платежа *Параметры запроса списания ранее заблокированной (авторизованной) суммы. Наследует «Базовые поля подписи».* | Поле | Тип | Описание | | ---------------------- | ----- | -------------------------- | | Идентификатор мерчанта | текст | — | | Идентификатор платежа | число | — | | Сумма клиринга | текст | 0 означает полное списание | ## Статусы и справочники ### Валюта платежа Поддерживаемые валюты платежей FreedomPay. * Тенге * Доллар США * Евро * Киргизский сом ### Флаг ВКЛ/ВЫКЛ Бинарный признак включения опции в запросах FreedomPay. * Включено * Выключено ### Язык формы оплаты Язык интерфейса платёжной формы FreedomPay. * Русский * Английский ### HTTP-метод callback Метод вызова URL уведомлений и редиректов FreedomPay. * GET * POST * XML ### Статус ответа шлюза Статус ответа FreedomPay на инициацию операции. * Успешно * Ошибка