Placeholders for configuring Payment Methods

The following Placeholders can be used for configuring Payment Methods (see Creating a Payment Method).

PlaceholderDescription

payment.payment_method

Payment Method name
payment.account_idID of an Account linked to the Payment
payment.account_nameFull name of an Account linked to the Payment
payment.account_type_keyAccount type key of an Account linked to the Payment
payment.account_custom_attributes['attribute_key']Value of an additional Attribute with the given key (see Creating an Attribute) of an Account linked to the Payment
payment.account_addressFull 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_emailEmail of an Account linked to the Payment
payment.account_phonePhone number of an Account linked to the Payment
payment.account_countryCountry code of an Account linked to the Payment
payment.account_country_nameCountry name of an Account linked to the Payment
payment.account_regionRegion of an Account linked to the Payment
payment.account_cityCity of an Account linked to the Payment
payment.account_zipZip of an Account linked to the Payment
payment.account_streetStreet of an Account linked to the Payment
payment.account_buildingBuilding of an Account linked to the Payment

payment.id

Payment ID

payment.document_id

Payment document number
payment.document_numberPayment number in the payment document
payment.totalPayment total
payment.total_in_wordsPayment total in letters
payment.statusPayment status (see Payment types)
payment.commentPayment comment
payment.ordersInformation about Orders linked to the Payment (semicolon-separated list)
payment.order_chargesInformation about Charges linked to the Payment via the Orders (semicolon-separated list)
payment.created_atDate 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?Indicator of a top-up Payment
payment.topup_sumTop-up amount
payment.automatically_generated?Indicator of a Payment created automatically by the platform
payment.invoicesInformation about Invoices linked to the Payment
payment.panel_linkLink to the Payment in the Customer Control Panel
payment.downloadableIndicator of the availability of a downloadable receipt for the Payment
payment.receipt_urlReceipt 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 Subscriptionthe 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 datethe Order expiration date.
  • Postpay — the Due date of the Payment.