Freeside:3:Documentation:Template:payment receipt email

From Freeside
Revision as of 03:55, 1 July 2019 by Burgerc (talk | contribs) (Variables)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


This template is emailed to customers when a manual payment is applied. A customer or support rep can initiate this. This applies to Process credit card and Process electronic check (ACH) payment links. If the value is set to NO, the template is ignored.

You may configure this template from Configuration, then Settings then payment_receipt_email. You can use ctrl-f (or cmd-f on macs) to search on the page.

First, apply a payment to the customer http://www.freeside.biz/~supaplex/screenshots/post-cash-payment.png , then they'll receive the payment email like http://www.freeside.biz/~supaplex/screenshots/received-payment_receipt_email.png

Defaults

On a new install, the checkbox is ticked (enabled).

Default template:

{ $date }

Dear { $name },

This message is to inform you that your payment of ${ $paid } has been
received.

Payment ID: { $paynum }
Date:       { $date }
Amount:     { $paid } 
Type:       { $payby } # { $payinfo }

{
  if ( $balance > 0 ) {
    $OUT .= "Your current balance is now \$$balance.\n\n";
  } elsif ( $balance < 0 ) {
    $OUT .= 'You have a credit balance of $'. sprintf("%.2f",0-$balance).
              ".\n".
            "Future charges will be deducted from this balance before billing ".
              "you again.\n\n";
            
  }
}
Thank you for your business.

Adding processing fee text

If using config option processing-fee you may want to add that to your payment receipt.

Add the below code to your payment receipt(Configuration->Miscellaneous->Message templates) to show the processing-fee only when it is applied.

This code will display the text below in your payment receipt only if there is a processing fee assessed.

which includes a processing fee of <processing-fee>

You can change the text to read what ever you would like.

{"which includes a processing fee of $processing_fee" if $processing_fee; }

Variables

$date
The date
$name
Customer name
$paynum
Freeside payment number
$paid
Amount of payment
$payby
Payment type (Card, Check, Electronic check, etc.)
$payinfo
Masked credit card number or check number
$balance
New balance
$processing_fee
processing fee assesed to transaction.