Методы оплаты (paymethod)

paymethod

Результат: список элементов

Методы оплаты

Уровень доступа: admin

Параметр	Значение
id	Id
name	Наименование
module	Платежная система
currency_name	Валюта
projects	Провайдеры
companies	Компании
note	Комментарий
orderpriority	Сортировка
status	Состояние

Установка фильтра.

Функция: paymethod.filter

Переместить метод оплаты на одну позицию вверх

Функция: paymethod.up

Уровень доступа: admin

Создать

Функция: paymethod.add

Уровень доступа: admin

Переместить метод оплаты на одну позицию вниз

Функция: paymethod.down

Уровень доступа: admin

Включить

Функция: paymethod.resume

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.

Результат: успешное выполнение операции или сообщение об ошибке

Настройки метода оплаты

Функция: paymethod.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции paymethod)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции paymethod)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
name	Наименование метода оплаты
minamount	Минимальная сумма, на которую можно выписать платеж с помощью данного метода оплаты
maxamount	Максимальная сумма, на которую можно выписать платеж с помощью данного метода оплаты
commissionamount	Фиксированная часть комиссии, снимаемой с клиента при зачислении платежа
commissionpercent	Процентная часть комисcии, снимаемой с клиента при зачислении платежа
doctmpl	Шаблон печати счета. Если не указан используется настройка компании, на которую выставлен счет
numtmpl_payment	Шаблон номера счета. Шаблон формирования номера счета, можно использовать макросы {id} — код платежа и {num} — порядковый номер платежа, созданного с использованием метода оплаты. При отсутствии обоих макросов в шаблоне номера счета к шаблону будет добавлен макрос {num}
nextnum_payment	Следующий порядковый номер счета, созданного с использованием метода оплаты. Учитывается только при условии заполнения шаблона номера счета
payment_description	Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей
autoclearperiod	Период удаления неоплаченных платежей. Период в днях, по истечении которого со дня создания платежа он будет удален в случае неоплаты
orderpriority	Сортировка (в прямом порядке). Позволяет задать приоритет метода оплаты при сортировке
successpage	Страница возврата при успешном платеже. Страница, на которую будет перенаправлен плательщик при успешном платеже
failpage	Страница возврата при неудачном платеже. Страница, на которую будет перенаправлен плательщик при неудачном платеже
pendingpage	Страница возврата при платеже в обработке. Страница, на которую будет перенаправлен плательщик при платеже в статусе "обрабатывается"
note	Комментарий к методу оплаты
profiletype	Статус плательщика. Метод оплаты будет доступен для плательщиков с указанным статусом
accountgroup	Группы клиентов. Позволяет ограничить использование метода оплаты только клиентами из выбранных групп
deny_accountgroup	Запретить группам клиентов. Позволяет запретить использование метода оплаты клиентам из выбранных групп
language	Язык клиента. Если язык интерфейса у клиента соответствует одному из указанных, то метод оплаты будет доступен. Если не выбрать ни одного языка, то метод оплаты будет доступен на всех языках.
recurring	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить использование рекурентных платежей
successpage_recurring	Страница возврата при успешном автоплатеже. Страница, на которую будет перенаправлен плательщик при успешном автоплатеже
failpage_recurring	Страница возврата при неудачном автоплатеже. Страница, на которую будет перенаправлен плательщик при неудачном автоплатеже
pendingpage_recurring	Страница возврата при автоплатеже в обработке. Страница, на которую будет перенаправлен плательщик при автоплатеже в статусе "обрабатывается"
allowrefund	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить полный или частичный возврат платежей совершенных методом оплаты
description_markdown	Описание метода оплаты (markdown).
description	Описание метода оплаты клиент увидит на первом шаге при оплате услуги. Разрешено использование HTML.

Подключение метода оплаты к компаниям

Функция: paymethod.company

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
name	Наименование
status	Состояние

Включить

Функция: paymethod.company.resume

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.company.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paymethod.company.suspend

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.company.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: paymethod.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.

Результат: успешное выполнение операции или сообщение об ошибке

Подключение метода оплаты к провайдерам

Функция: paymethod.project

Результат: список элементов

Уровень доступа: admin

id — Id

name — Наименование

status — Состояние

Включить

Функция: paymethod.project.resume

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.project.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paymethod.project.suspend

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.project.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paymethod.suspend

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.

Результат: успешное выполнение операции или сообщение об ошибке