This page explains how to customise the appearance of automated emails sent following transactions.
Include your logo
You can include your logo at the top of automated emails without needing to write any custom mark-up. This is shown alongside a small “Trust Payments” icon.
- Sign in to MyST.
- Click “Sites” from the side-bar and then click on your site reference (or alternatively search for your site reference using the universal search functionality).
Your customisations will only be performed on this site reference.
The image will be displayed on all stprofiles for this site reference. - Click the “File manager” icon.
You must have the role ‘Site admin’, ‘Developer’, ‘Developer 2’ or ‘File Manager’ to access the File Manager. - Upload an image called “emaillogo” (e.g. “emaillogo.png”).
We support the following image extensions: bmp, gif, jpeg, jpg, png, svg, tif, tiff.
Maximum file size is 1024kb.
We recommend against using an image with dimensions exceeding 256x256px.
It can take up to 10 minutes for uploaded files to be listed in the MyST File Manager and for your changes to be reflected in emails that we send.
Change the language
Using our localisation features, you can have customer email notifications translated into different languages.
Using mark-up
You can upload custom HTML to customise the appearance of the emails sent to customers or members of your organisation. Each file will need to contain HTML mark-up that makes use of st.field (click here for information on st.field). Using the MyST File Manager, you will need to upload the following files:
- defaultsuccessfulcustomer.email – Defines appearance of email sent to customer following a successful transaction.
- defaultdeclinedcustomer.email – Defines appearance of email sent to customer following a declined transaction.
The files described above will only modify the appearance of emails when stprofile is set to “default” in the POST.
If you are using custom mark-up customise the appearance of the Payment Pages, you can replace “default” with your stprofile name:
e.g. For stprofile “christmas”, the file containing HTML for a success customer email would be named: christmassuccessfulcustomer.email
Customer email example HTML
The following is an example of HTML mark-up for a simple email to be sent to the customer following a successful payment.
- You can include fields listed on our reference page, by including
{{st.<fieldname>.value}}.- Note: You can also reference custom fields you have included in the POST.
- You can opt to reference custom images by including
{{st.resource.<imagename>}}.- Note: Image names are case-sensitive.
- You must always include at least one of the following, that displays the Trust Payments logo in the email:
{{stresource.securetradingprocessed.png}}(Small logo){{stresource.securetradinglogo.png}}(Full-sized logo){{stresource.securetradinglogo-inverted.png}}(Logo for dark backgrounds)
<html>
<body>
<img src="cid:{{stresource.yourimage.jpg}}"/>
<img src="cid:{{stresource.securetradingprocessed.png}}"/>
<p>Thank you for your order received today</p>
<ul>
<li>Amount: {{st.mainamount.value}}</li>
<li>AuthCode: {{st.authcode.value}}</li>
<li>Reference: {{st.transactionreference.value}}</li>
</ul>
</body>
</html>
Testing and troubleshooting
Now you have uploaded the required files, you can test that this works on your test site reference. Email mark-up is only applied when the following criteria have been met:
- The required files are uploaded to the same site reference the requests are being processed on.
- The stprofile submitted in the POST matches the stprofile in the name of the .email file uploaded.
