Плейсхолдеры для создания способа оплаты

В таблице ниже приведен список плейсхолдеров, которые могут быть использованы при настройке способа оплаты (см. Создание способа оплаты).

ПлейсхолдерОписание

payment.payment_method

Название способа оплаты
payment.account_idID клиента, которому принадлежит платеж
payment.account_nameПолное имя клиента, которому принадлежит платеж
payment.account_type_keyКлюч типа клиента, которому принадлежит платеж
payment.account_custom_attributes['attribute_key']Значениедополнительного параметра с указанным ключом (см. Создание дополнительного параметра) клиента, которому принадлежит платеж
payment.account_addressПолный адрес клиента, которому принадлежит платеж. Формируется на основе адресной информации клиента (см. Создание клиента). Пример: 143246, Российская Федерация, Московская область, г. Светлый, ул. Широкая, дом 3, офис 5
payment.account_emailEmail клиента, которому принадлежит платеж
payment.account_phoneНомер телефона клиента, которому принадлежит платеж
payment.account_countryКод страны клиента, которому принадлежит платеж
payment.account_country_nameНазвание страны клиента, которому принадлежит платеж
payment.account_regionНазвание области клиента, которому принадлежит платеж
payment.account_cityНазвание города клиента, которому принадлежит платеж
payment.account_zipПочтовый индекс клиента, которому принадлежит платеж
payment.account_streetНазвание улицы клиента, которому принадлежит платеж
payment.account_buildingНомер дома клиента, которому принадлежит платеж

payment.id

ID платежа

payment.document_id

Номер платежного документа
payment.document_numberНомер платежа, указываемый в платежном документе клиента
payment.totalОбщая сумма платежа
payment.total_in_wordsОбщая сумма платежа прописью
payment.status

  • Ожидает оплаты (waiting_for_payment — при работе с API-методами) — начальный статус, в котором формируются все платежи. Платеж создан, но не подтвержден.
  • Просрочен (expired) — оплата не была получена вовремя.
  • Отменен (cancelled) — платеж был отменен.
  • Счет формируется (receipt_creating) — менеджер вручную формирует счет на оплату (см. Обработка платежа с ручным методом выставления счета).
  • Счет отправлен (receipt_sent) — менеджер отправил клиенту сформированный вручную счет.

  • Обрабатывается (processing) — временный статус платежа, пока оплата обрабатывается на стороне платежного шлюза. В этом статусе для платежа недоступны никакие операции.
  • Завершен (completed) — платеж обработан (подтвержден), оплата получена.

  • Оплачен с баланса (paid_from_balance) — платеж был оплачен с баланса клиента.

payment.commentКомментарий к платежу
payment.ordersПолная информация о заказах, объединенных в платеж (данные будут выведены через ";")
payment.order_chargesИнформация о списаниях по заказу, проведенных в рамках данного платежа (данные будут выведены через ";"): description, quantity, unit_price, unit_price_without_tax, discount_amount, discounted_unit_price_without_tax, amount_without_tax, period, tax_percent, amount, discount_ids
payment.order_charges.sizeКоличество списаний в счете на оплату
payment.order_charges[].has_taxesBool; признак, что позиция платежа содержит налог
payment.order_charges[].taxes_amountСумма всех налогов в платеже
payment.order_charges[].taxes[]Массив налогов, включенных в позицию платежа
payment.order_charges[].taxes[].idID налога
payment.order_charges[].taxes[].nameНазвание налога
payment.order_charges[].taxes[].codeКод налога
payment.order_charges[].taxes[].amountСумма налога
payment.grouped_order_charges

Информация о сгруппированном списании в счете на оплату (данные будут выведены через ";" для первого списания из группы, если не указано иное): id; name; description; unit_price (price); amount (устанавливается как сумма по всей группе); duration (period); discount_ids; discount_amount (устанавливается как сумма по всей группе); quantity (устанавливается как сумма по всей группе); operate_from; operate_to; type; plan_id; plan_name; plan_resource_id; unit_price_without_tax; discounted_unit_price_without_tax; amount_without_tax (устанавливается как сумма по всей группе); unit_price_with_discount; tax_percent.

Пример использования для отображения в виде таблицы:

{% for charge in payment.grouped_order_charges %} <tr>
  <td>{{ charge.plan_id }}</td>
  <td>{{ charge.plan_name }}</td>
</tr>
{% endfor %}

Списания группируются, если у них совпадают следующие параметры:

  • reseller_id
  • account_id
  • subscription_id
  • resource_id
  • operate_from
  • operate_to
  • duration
  • unit_price
  • status
  • type
  • taxes_amount
  • discount_id
  • original_amount_currency
  • currency_rate
  • currency_unit
payment.grouped_order_charges.sizeКоличество сгруппированных списаний в счете на оплату
payment.created_atДата и время создания платежа
payment.provisioning_itemsИнформация о заказанных ресурсах, связанных с платежом
payment.positive_provisioning_itemsИнформация о заказанных ресурсах с количеством больше 0, связанных с платежом
payment.topup?Признак платежа для пополнения баланса
payment.topup_sumСумма платежа для пополнения баланса
payment.automatically_generated?Признак платежа, автоматически сформированного платформой
payment.invoicesИнформация об актах, связанных с платежом
payment.panel_linkСсылка на платеж в Панели управления Клиента
payment.downloadableПризнак доступности скачивания счета для платежа
payment.receipt_urlСсылка для скачивания счета для платежа
payment.purposeНазначение платежа для пополнения баланса клиента (см. Ручное создание платежа)
payment.due_date

Дата Оплатить до платежа в зависимости от модели оплаты:

  • Предоплата — рассчитывается в зависимости от типа связанного заказа. Для объединенных платежей рассчитывается как ближайшая дата для всех связанных заказов.

    Тип заказаДата Оплатить до
    Заказ на покупкуДата истечения заказа
    Заказ на изменение количества ресурсов
    Заказ на переключение
    Заказ на пролонгацию
    • Если заказ создан до даты Оплачена до подписки (paid_to) — дата Оплачена до подписки.
    • Если заказ создан после даты Оплачена до подписки — дата истечения pаказа.

    Правила установки даты Оплачена до для подписки см. в Пролонгация подписки

    Заказ на продление
    • Если заказ создан до даты истечения подписки — ближайшая дата из даты истечения подписки и даты истечения заказа.
    • Если заказ создан после даты истечения подписки — дата истечения заказа.
  • Постоплата — дата отсрочки платежа.
payment.external_totalСумма счета на оплату, переданная из сторонней ERP-системы (см. Управление актами по модели Постоплата сторонней ERP-системой). Только для вставки в шаблон PDF
payment.external_currencyКод валюты счета на оплату, переданный из сторонней ERP-системы (см. Управление актами по модели Постоплата сторонней ERP-системой). Только для вставки в шаблон PDF
payment.pdf_urlИспользуется в шаблоне инструкции для способа оплаты на основе модуля CheckCash plugin: ссылка для скачивания PDF-счета, сформированного платформой по шаблону Шаблон PDF (в формате Liquid) (см. Создание способа оплаты)
payment.external_file_url

Используется в шаблоне инструкции для способа оплаты на основе модуля CheckCash plugin:

  • Ссылка для скачивания счета, сформированного платформой по шаблону Шаблон PDF (в формате Liquid) (см. Создание способа оплаты) — в следующих случаях:
    • Платеж по модели Предоплата.
    • Платеж по модели Постоплата, когда платформа самостоятельно управляет актами по модели Постоплата.
    • Платеж по модели Постоплата, когда используется  внешнее управление актами по модели Постоплата, и сторонняя ERP-система не прикрепила к платежу счет.
  • Ссылка для скачивания счета, прикрепленного сторонней ERP-системой к платежу по модели Постоплата в виде файла или ссылки, когда используется  внешнее управление актами по модели Постоплата.

См. также  Управление актами по модели Постоплата сторонней ERP-системой.