id плательщика, от имени которого совершена оплата.
recipient
Положительное целое число
Нет
id компании-получателя платежа.
subaccountamount
Строка
Нет
Сумма, зачисляемая на счёт клиента.
paymethodamount
Строка
Нет
Сумма в валюте платёжной системы.
status
Строка (перечисление)
Нет
Статус платежа. Возможные значения:
1 — новый;
2 — оплачивается;
3 — обещанный платёж;
4 —зачислен;
5 — ожидает возврата;
6 — возвращён;
7 — мошеннический;
9 — отменён.
paymethod
Положительное целое число
Нет
id метода оплаты.
restrictrefund
Флаг
Нет
Запретить возврат средств с данного платежа. Возможные значения:
on — запретить;
off — разрешить.
info
Строка
Нет
Дополнительная информация о платеже, полученная от платёжной системы.
note
Строка
Нет
Комментарий сотрудника.
sok
Строка
Нет
Значение ok подтверждает сохранение изменений.
Удалить платежи
Функция: payment.delete
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Удалить в списке платежей.
Удаляет платежи. Поддерживает удаление нескольких платежей через запятую. Недоступно для платежей со статусами: "Обещанный платеж", "Зачислен", "Ожидает возврата", "Возвращен", "Мошеннический". Требуется подтверждение через параметр sok.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
Да
Один или несколько id платежей через запятую. Например, 123,456.
sok
Строка
Да
Значение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.
Зачислить платежи
Функция: payment.setpaid
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Зачислить в списке платежей.
Зачисляет выбранные платежи на лицевой счёт клиента. Недоступно для платежей со статусами: "Зачислен", "Возвращен", "Отменен", а также если установлен флаг возврата. Требуется подтверждение через параметр sok.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
Да
Один или несколько id платежей через запятую.
sok
Строка
Да
Значение ok подтверждает выполнение операции.
Вернуть средства по платежу
Функция: payment.refund
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Возврат в списке платежей.
Позволяет вернуть все или часть средств, зачисленных на счёт клиента выбранным платежом. Доступна только для зачисленных платежей при поддержке данной функции методом оплаты. Требуется подтверждение через параметр sok.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
id платежа, по которому необходимо выполнить возврат.
amount
Строка
Нет
Сумма возврата. Если не указана, возвращается полная сумма платежа.
sok
Строка
Да
Значение ok подтверждает выполнение операции.
Отправить документ по платежу
Функция: payment.docflow.send
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Отправить счёт в списке платежей.
Отправляет документ в формате PDF по email.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
id платежа, документ по которому необходимо отправить.
method
Строка (перечисление)
Нет
Способ отправки документов клиентам. Возможные значения:
email — по email.
sok
Строка
Да
Значение ok подтверждает выполнение операции.
Печать платежей
Функция: payment.print
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Печать в списке платежей.
Возвращает готовую печатную форму выбранных платежей с реквизитами, суммами и налоговыми данными.
Уровень доступа: admin, user
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
Да
Один или несколько id платежей через запятую.
Скачать платежи в формате PDF
Функция: payment.print.pdf
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Скачать в списке платежей.
Возвращает PDF-документ с детализацией выбранных платежей.
Уровень доступа: admin, user
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
Да
Один или несколько id платежей через запятую.
Показать содержание счёта
Функция: payment.orderinfo
Результат: список элементов
В веб-интерфейсе платформы: раздел Платежи → кнопка Подробно в списке платежей.
Возвращает детализацию позиций счёта, привязанного к платежу.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
id платежа, для которого необходимо показать содержание счёта.
Показать распределение расходов по платежу
Функция: payment.expense
Результат: список элементов
В веб-интерфейсе платформы: раздел Платежи → кнопка Расходы в списке платежей.
Возвращает список расходов, привязанных к платежу. Доступно только для платежей со статусами: "Обещанный платеж", "Зачислен".
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
id платежа, для которого необходимо показать распределение расходов.
Создать счёт-фактуру по платежу
Функция: payment.invoice_create
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Счет-фактура в списке платежей.
Создаёт счёт-фактуру для выбранного платежа. Доступно только если для платежа разрешено создание счёта-фактуры. Требуется подтверждение через параметр sok.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
Да
Один или несколько id платежей через запятую.
sok
Строка
Да
Значение ok подтверждает выполнение операции.
Показать историю изменений платежа
Функция: payment.history
Результат: список элементов
В веб-интерфейсе платформы: раздел Платежи → кнопка История в списке платежей.
Возвращает хронологию событий, связанных с изменением параметров платежа.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
id платежа, для которого необходимо показать историю изменений.
Написать запрос по платежу
Функция: ticket.write.payment
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Запрос в списке платежей.
Создаёт запрос в службу поддержки, привязанный к выбранному платежу.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Строка (список)
Да
Один или несколько id платежей через запятую.
subject
Строка
Нет
Тема запроса.
message
Строка
Нет
Текст сообщения запроса.
Установить фильтр по платежам клиента
Функция: payment.setfilter
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка По клиенту в списке платежей.
Устанавливает фильтр по клиенту для списка платежей. Условия фильтра сохраняются и применяются ко всем последующим вызовам payment до изменения или сброса фильтра.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
account
Положительное целое число
Нет
id клиента для фильтрации списка.
reset
Флаг
Нет
Значение on сбрасывает все установленные фильтры.
Применить расширенный фильтр
Функция: payment.filter
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Фильтр в списке платежей.
Применяет расширенные условия фильтрации к списку платежей. Поддерживает фильтрацию по номеру, датам, суммам, статусам, методам оплаты и другим параметрам.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
id
Положительное целое число
Нет
Уникальный идентификатор платежа для фильтрации.
account
Строка
Нет
Имя клиента для фильтрации.
account_id
Положительное целое число
Нет
Коды клиентов для фильтрации.
number
Строка
Нет
Номер платежа для фильтрации. Поддерживается подстановочный знак *.
sender
Строка
Нет
Поиск по имени/ФИО плательщика. Поддержка символа ~ как разделителя для множественных значений.
sender_id
Положительное целое число
Нет
Коды плательщиков для фильтрации.
recipient
Строка (список)
Нет
id компаний-получателей для фильтрации. Возможен множественный выбор.
createdate
Строка (перечисление)
Нет
Период создания. Возможные значения:
nodate;
today;
currentweek;
currentmonth;
lastday;
lastweek;
lastmonth;
lastyear;
week;
month;
quarter;
halfyear;
year;
other.
createdatestart
Дата
Нет
Начальная дата диапазона создания. Формат: YYYY-MM-DD.
createdateend
Дата
Нет
Конечная дата диапазона создания . Формат: YYYY-MM-DD.
payfromdate
Дата
Нет
Платежи, зачисленные с даты. Формат: YYYY-MM-DD.
paytodate
Дата
Нет
Платежи, зачисленные по дату. Формат: YYYY-MM-DD.
profiletype
Строка (перечисление)
Нет
Юридический статус плательщика. Принимает значения:
1 — физическое лицо;
2 — юридическое лицо;
3 — индивидуальный предприниматель.
maildocs
Строка (перечисление)
Нет
Способ получения документов. Возможные значения:
0 — в личном кабинете;
1 — по почте;
2 — по электронной почте;
3 — через систему электронного документооборота (СЭД). Должен быть настроен электронный документооборот.
project
Строка (список)
Нет
id провайдеров для фильтрации.
paymethod
Строка (список)
Нет
id методов оплаты для фильтрации.
module
Строка (перечисление)
Нет
Платёжные системы. Например, pmwire или pmyandexcheckout.
status
Строка (перечисление)
Нет
Фильтр по статусу платежа. Возможные значения:
1 — новый;
2 — оплачивается;
3 — обещанный платёж;
4 —зачислен;
5 — ожидает возврата;
6 — возвращён;
7 — мошеннический;
8 — инициирован;
9 — отменён;
100 — удаляется.
docflow_pdf_status
Строка (перечисление)
Нет
Статусы ЭДО. Возможные значения:
100 — ожидает отправки;
101 — отправлен;
400 — завершён.
saamount_from
Строка
Нет
Минимальная сумма платежа, зачисляемая на счёт.
saamount_to
Строка
Нет
Максимальная сумма платежа, зачисляемая на счёт.
pmamount_from
Строка
Нет
Минимальная сумма в валюте метода оплаты.
pmamount_to
Строка
Нет
Максимальная сумма в валюте метода оплаты.
restrictrefund
Флаг
Нет
Фильтр по возможности возврата. Возможные значения:
on — запрещён;
off — разрешён;
null — не установлен.
sendreport
Флаг
Нет
Включить автоматическую отправку отчёта на email. Возможные значения:
on — включён;
off — выключен.
sendreport_email
Строка
Да
Email для отправки отчёта. Обязателен, если sendreport=on.
sendreport_period
Строка (перечисление)
Да
Периодичность отправки. Возможные значения:
daily — ежедневно;
weekly — еженедельно;
monthly — ежемесячно;
quarterly — ежеквартально;
annually — ежегодно.
reset
Флаг
Нет
Значение on сбрасывает все установленные фильтры.
Войти в панель с правами пользователя
Функция: payment.su
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: раздел Платежи → кнопка Войти в списке платежей.
Выполняет вход в панель управления с правами выбранного клиента для просмотра его данных.
Уровень доступа: admin
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
Уникальный идентификатор клиента, под правами которого необходимо войти.
Перейти к оплате платежа
Функция: payment.add.redirect
Результат: успешное выполнение операции или сообщение об ошибке
Выполняет перенаправление на мастер оплаты для выбранного платежа. Используется для завершения оплаты через веб-интерфейс.
Уровень доступа: user
Параметр
Тип
Обязательный
Значение
elid
Положительное целое число
Да
id платежа, который необходимо оплатить.
amount_currency
Положительное целое число
Да
Сумма платежа.
sok
Строка
Да
Значение ok подтверждает выполнение операции.
Создать платёж напрямую (старая корзина)
Функция: payment.add.pay
Результат: успешное выполнение операции или сообщение об ошибке
В веб-интерфейсе платформы: мастер оплаты и пополнения счёта.
Создаёт платёж напрямую, минуя корзину. Используется для оплаты только старой корзины.
При использовании данного API рекомендуем проходить весь путь мастера оплаты и ориентироваться на то, какой запрос отправляется на сервер с его завершением (вызов payment.add.pay). Вызов отдельно только данной функции может привести к ошибкам.
Набор параметров зависит от выбранного метода оплаты. Необходимость некоторых полей зависит от выбранного метода оплаты, например, для ЮKassa нужно указать payment_method.
Уровень доступа: admin, user
Параметр
Тип
Обязательный
Значение
amount
Строка
Да
Сумма платежа.
payment_currency
Положительное целое число
Да
id валюты платежа. Должна совпадать с валютой выбранного метода оплаты.
customer_account
Положительное целое число
Да
id клиента, для которого создаётся платёж.
paymethod
Положительное целое число
Да
id модуля оплаты.
plid
Положительное целое число
Нет
id клиента из функции payment.add.
profile
Положительное целое число
Нет
id плательщика. Необходим, если требуется для метода оплаты.