Объект: payment

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

Платежи

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

  • id — id, уникальный идентификатор платежа;
  • number — номер платежа согласно нумерации компании или метода оплаты;
  • create_date — дата создания платежа;
  • sender_name — плательщик, совершивший платёж;
  • recipient_name — получатель. Нет, если метод оплаты не связан ни с одной компанией;
  • paymethod_name — метод оплаты, связанный с этим платежом;
  • subaccountamount_iso — сумма
  • paymethodamount_iso — сумма в валюте платежа выбранного метода оплаты
  • status — Статус. Может принимать значения:
    • 1 — новый;
    • 2 — оплачивается;
    • 3 — обещанный платёж;
    • 4 — зачислен;
    • 5 — ожидает возврата;
    • 6 — возвращён клиенту полностью;
    • 7 — мошеннический.

Пример API вызова для получения списка платежей со статусом "Новый" за период:

Пример API вызова

https://<адрес BILLmamager>?authinfo=username:password&func=payment&filter=on&status=1&createdate=other&createdateend=2020-07-03&createdatestart=2020-06-03&out=xml
CODE

createdatestart — дата начала периода для фильтрации;

createdateend — дата окончания периода для фильтрации.

В примере выше при вызове функции в ответ будет получен список платежей со статусом "Новый" начиная с 3 июня 2020 г до 3 июля 2020 г.

Установить фильтр по клиенту

Функция: payment.setfilter

Установить фильтр по клиенту

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

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

payment.filter

Оплата

Функция: payment.add.redirect

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

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

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

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

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

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

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

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

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

  • amount_currency — сумма платежа. Сумма к оплате

Создание платежа

Функция: payment.add.pay

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

Результат: создание платежа

Данная функция используется для оплаты только старой корзины. В веб-интерфейсе платформы это мастер оплаты и пополнения счёта.

При использовании данного API рекомендуем проходить весь путь мастера оплаты и ориентироваться на то, какой запрос отправляется на сервер с его завершением (вызов payment.add.pay). Вызов отдельно только данной функции может привести к ошибкам.

Набор используемых в запросе параметров зависит от наличия других параметров. Необходимость некоторых полей зависит от выбранного метода оплаты, например, для ЮKassa нужно указать payment_method.

Платёж через метод ЮKassa

https://billdomain.com/billmgr?func=payment.add.pay&paymethod=3&profile=37&amount=555&payment_currency=126&sok=ok&payment_method=bank_card
CODE

Новый платёж

https://billdomain.com/billmgr?amount=43.00&customer_account=49&func=payment.add.pay&payment_currency=126&paymethod=3&plid=49&profile=33&profiletype=3&project=1&sok=ok
CODE
  • amount — сумма платежа
  • payment_currency — elid (уникальный идентификатор) валюты платежа
  • customer_account — id клиента
  • paymethod —  метод оплаты
  • plid — id клиента (из функции payment.add)
  • profile — id плательщика
  • profiletype — тип плательщика
  • project — провайдер

Создание платежа на пополнение лицевого счёта

https://billdomain.com/billmgr?func=payment.add.pay&paymethod=1&profile=37&amount=999&payment_currency=126&sok=ok
CODE
  • paymethod — id модуля оплаты
  • profile — id плательщика (если требуется методом оплаты)
  • amount — сумма платежа
  • payment_currency — валюта платежа (должна совпадать с валютой выбранного метода оплаты)

Оплата корзины

https://billdomain.com/billmgr?func=payment.add.pay&paymethod=1&profile=37&amount=999&payment_currency=126&sok=ok
CODE
  • paymethod — id модуля оплаты
  • profile — id плательщика (если требуется методом оплаты)
  • billorder — id корзины

Войти в панель с правами пользователя

Функция: payment.su

Войти в панель с правами пользователя

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