Placeholders for configuring payment methods

The following placeholders can be used for configuring payment methods (see Creating a payment method).

PlaceholderDescription

payment.payment_method

The payment method name
payment.account_idThe ID of an account linked to the payment
payment.account_nameThe full name of an account linked to the payment
payment.account_type_keyThe account type key of an account linked to the payment
payment.account_custom_attributes['attribute_key']The value of an additional attribute with the given key (see Creating an attribute) of an account linked to the payment
payment.account_addressThe full address of an account linked to the payment. Autogenerated from the address information of the account (see Creating an account). Example: 143246, Russia, Moscow region, Novodvorsk city, Lenina str., building 3, office 5
payment.account_emailThe email of an account linked to the payment
payment.account_phoneThe phone number of an account linked to the payment
payment.account_countryThe country code of an account linked to the payment
payment.account_country_nameThe country name of an account linked to the payment
payment.account_regionThe region of an account linked to the payment
payment.account_cityThe city of an account linked to the payment
payment.account_zipThe zip of an account linked to the payment
payment.account_streetThe street of an account linked to the payment
payment.account_buildingThe building of an account linked to the payment

payment.id

The payment ID

payment.document_id

The payment document number
payment.document_numberThe payment number in the payment document
payment.totalThe payment total
payment.total_in_wordsThe payment total in letters
payment.statusThe payment status (see Payment types)
payment.commentThe payment comment
payment.ordersInformation about orders linked to the payment (semicolon-separated list)
payment.order_chargesThe list of the charges linked to the payment (separated by ";"): 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.sizeThe number of charges in a PDF receipt
payment.grouped_order_charges

The list of the grouped charges linked to the payment (separated by ";" parameters are set for the first charge in a group if not specified otherwise): id; name; description; unit_price (price); amount (specified as the total amount for a group); duration (period); discount_ids; discount_amount (specified as the total amount for a group); quantity (specified as the total amount for a group); operate_from; operate_to; type; plan_id; plan_resource_id; unit_price_without_tax; discounted_unit_price_without_tax; amount_without_tax (specified as the total amount for a group); unit_price_with_discount; tax_percent.

Charges are grouped if have the following identical parameters:

  • 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.sizeThe number of grouped charges in a PDF receipt
payment.created_atThe date and time when the payment is created
payment.provisioning_itemsInformation about resources linked to the payment
payment.positive_provisioning_itemsInformation about resources linked to the payment and with the resource amount greater than 0
payment.topup?The indicator of a top-up payment
payment.topup_sumThe top-up amount
payment.automatically_generated?The indicator of a payment created automatically by the platform
payment.invoicesInformation about Invoices linked to the payment
payment.panel_linkA link to the payment in the Customer Control Panel
payment.downloadableThe indicator of the availability of a downloadable receipt for the payment
payment.receipt_urlThe receipt download link for the payment
payment.purposeThe purpose of the top-up payment (see Creating a payment manually)
payment.due_date

The due date for the payment. Depending on the payment mode:

  • Prepay — the date is calculated considering the type of a linked order. For joined payments, the earliest date among the linked orders is selected.

    Order typeThe due date
    Sales orderThe order expiration date
    Change order
    Switch plan order
    Prolong order
    • If an order is created before the Paid to date of a subscription — the Paid to date of a subscription.
    • If an order is created after the Paid to date of a subscription — the subscription expiration date.

    Setting the Paid to date for different subscriptions is described in Prolonging a subscription

    Renewal order
    • If an order is created before the subscription expiration date — the earliest date among the subscription expiration date and order expiration date.
    • If an order is created after the subscription expiration date — the order expiration date.
  • Postpay — the due date of the payment.
payment.external_totalThe amount of a third-party invoice, if specified (see Managing invoices for the Postpay model by a third-party ERP system). For a PDF template only
payment.external_currencyThe ISO code of the currency of a third-party invoice, if specified (see Managing invoices for the Postpay model by a third-party ERP system). For a PDF template only