Payment Receipt Template Variables Documentation

This document provides a comprehensive guide to all payment receipt template system variables, which can be used to create custom payment receipt templates.

Please refer to the zenskar default template in your sandbox account for their usage.

Basic Payment Receipt Information

Header Information

• {{logo}} - Organization's logo URL

• {{zenskar_redirect_url_pay_receipt_doc}} - Zenskar redirect URL for payment receipt documentation

Payment Information

• {{payment_info.id}} - Payment ID

• {{payment_info.receipt_number}} - Receipt number

• {{payment_info.created_at}} - Date when the payment was received

• {{payment_info.amount}} - Payment amount (formatted with currency)

• {{payment_info.payment_method}} - Payment method details

Customer Information

• {{customer.name}} - Customer's name

• {{customer.email}} - Customer's email address

• {{customer.address}} - Customer's billing address

• {{customer.ship_to_address}} - Customer's shipping address (if different from billing)

• {{customer.invoice_recipients}} - List of invoice recipients

• {{customer.tax_id}} - Customer's tax ID (if available)

• {{customer.custom_data}} - Any custom data associated with the customer

• {{customer.external_id}} - Customer's external ID

• {{customer.id}} - Customer's internal ID

Seller Information

• {{seller.name}} - Seller's name

• {{seller.address}} - Seller's address

• {{seller.tax_config}} - Seller's tax configuration

Invoice Information

• {{invoice_data.invoice_numbers}} - comma separated invoice numbers which are linked to the payment

Custom Attributes

Custom attributes which are set up for modules can be accessed in the template. The following are available in invoice template currently

• Customer
  Using {{customer.custom_data.<custom attribute keyname}}

  Usage Examples

  Basic Payment Information Display

  HTML

  <div class="payment-info">
    <h2>Payment Received</h2>
    <p>We have received your payment of {{payment_info.amount}}</p>
    <div class="payment-details">
      <p>Receipt ID: {{payment_info.receipt_number}}</p>
      <p>Payment Date: {{payment_info.created_at}}</p>
      <p>Payment Method: {{payment_info.payment_method}}</p>
    </div>
  </div>

  Customer and Seller Information

  HTML

  <div class="party-info">
    <div class="customer">
      <h3>Paid By</h3>
      <p>{{customer.name}}</p>
      <p>{{customer.address}}</p>
    </div>
    <div class="seller">
      <h3>Paid To</h3>
      <p>{{seller.name}}</p>
      <p>{{seller.address}}</p>
    </div>
  </div>

  Notes

1. All currency values are automatically formatted according to the specified currency.
2. Dates are formatted according to the standard date format: "MMM DD, YYYY"
3. Boolean values can be used with Mustache's conditional syntax: {{#variable}}...{{/variable}}
4. Arrays can be iterated using Mustache's iteration syntax: {{#array}}...{{/array}}
5. Some variables may be optional and should be checked for existence before use
6. The payment receipt template is specifically designed for payment confirmations and does not include invoice or credit note-related variables