System Generated Email Variables

Summary

This document outlines the values that can be configured in Redcat system generated emails for both the Ordering and Loyalty platforms. Where you wish to customise further please provide HTML email templates to our inhouse team for implementation.

Global (available in every template)

Verify — Email verification

Forgot Password — Password reset

Welcome
Feedback
Two Factor Authentication Pin
Email Updated
Member Email Update
Member Profile Update
Card Transfer Start
Card Transfer Acknowledgement
Member Merge Acknowledgement
Order Acknowledgement
Future Ordering Reminder
Gift Card Purchase - Recipient
Gift Card Purchase — Self Recipient
Gift Card Purchase Receipt
Stamp Card Reward Earned
Control Console Notification
SMS Limit Notification
Unprocessed Order
Cardset End-of-Life Warning
Scheduled Report Alert
Points Retrieval Request — Member
Point Retrieval Request — Failed
Point Retrieval Request — Approval
Point Retrieval Request — Approved / No Points
Point Retrieval Request — Rejected
Point Retrieval Request — Submitted
DB-driven Admin Templates — parameter_template Modifiers

Global (available in every template)

The following fields are able to be applied across all system generated templates:

Variable	Description	In template	Output
`currency`	Currency symbol	`4.50`	`$4.50`
`headerimage`	Header banner image URL	`<img src="">`	`<img src="<https://cdn.example.com/mail/header.jpg>">`
`attach_image`	Helper fn to build absolute static asset URL	`<img src="">`	`<img src="<https://cdn.example.com/static/wallet-apple.png>">`
`template_type` / `dbtemplate_version`	Internal bookkeeping (not for display)		`verify`

`verify` — Email verification

Variable	Description	In template	Output
`app_name`	Brand/app name	`Welcome to`	`Welcome to Redcat Rewards`
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`
`verify_link`	Verification link	`<a href="">Verify</a>`	`<a href="<https://app.example.com/verify?Code=abc123>">Verify</a>`

`forgot_password` — Password reset

Variable	Description	In template	Output
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`
`verify_link`	Reset password link	`<a href="">Reset password</a>`	`<a href="<https://app.example.com/universal/updatePassword?Code=abc123>">Reset password</a>`
`app_name`	Brand name	`Your account`	`Your Redcat Rewards account`

User variant:

Variable	Description	In template	Output
`user.username`	Web-user username	`Hi ,`	`Hi sarah.admin,`
`verify_link`	Reset link	`<a href="">Reset password</a>`	`<a href="<https://app.example.com/user/reset/?Code=abc123>">Reset password</a>`

`welcome` — Welcome email

Variable	Description	In template	Output
`app_name`	Brand name	`Welcome to`	`Welcome to Redcat Rewards`
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`
`barcode_link`	Link to member's barcode image	`<img src="">`	`<img src="<https://app.example.com/barcode/00012345/enc789>">`
`wallet_loyalty_apple` / `wallet_loyalty_google`	Apple/Google Wallet pass links	`<a href="">Add to Apple Wallet</a>`	`<a href="<https://app.example.com/wallet/apple?token=xyz>">Add to Apple Wallet</a>`
`display_wallet_loyalty`	Feature flag		(wallet block rendered only when `true`)

`feedback` — Feedback-loop survey

Variable	Description	In template	Output
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`
`feedback_link`	Survey link	`<a href="">Give feedback</a>`	`<a href="<https://survey.example.com/f/9987>">Give feedback</a>`
`order.tbl_poslocation.locationname`	Store name	`about your visit to`	`about your visit to George St Store`
`support_email`	Support contact	`Questions?`	`Questions? support@example.com`
`app_name`	Brand name	`Thanks for choosing`	`Thanks for choosing Redcat Rewards`

`tfa_pin` — Two-factor auth pin

Variable	Description	In template	Output
`member.givennames` (member variant)	Member first name	`Hi ,`	`Hi Sarah,`
`user.username` (user variant)	Webuser username	`Hi ,`	`Hi sarah.admin,`
`pin`	Generated OTP	`Your code is`	`Your code is 482913`
`message`	Pre-formatted pin message		`Your one-time code is 482913`
`expiry_time`	Minutes until PIN expires	`expires in minutes`	`expires in 5 minutes`
`brand_name`	Brand name	`security code`	`Redcat Rewards security code`
`support_email`	Support contact	`Contact`	`Contact support@example.com`

`email_updated` — Old address notified after change

Variable	Description	In template	Output
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`
`support_email`	Support contact	`Contact`	`Contact support@example.com`
`message`	Override message (defaults if false)		`Your Email address has been updated.`

`member_email_update`

Variable	Description	In template	Output
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`
`support_email`	Support contact	`Contact`	`Contact support@example.com`

`member_profile_update`

Variable	Description	In template	Output
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`

`card_transfer_start`

Variable	Description	In template	Output
`member.givennames` / `member.memberno`	Member details	`Hi (card )`	`Hi Sarah (card 00012345)`
`confirmation_link`	Card-transfer confirmation URL	`<a href="">Confirm transfer</a>`	`<a href="<https://app.example.com/transfer?Code=abc123>">Confirm transfer</a>`
`params`	Extra raw params		`00012345`

`card_transfer_acknowledgement`

Variable	Description	In template	Output
`member.givennames` / `member.memberno`	Member details	`Hi (card )`	`Hi Sarah (card 00012345)`

`member_merge_acknowledgement`

Variable	Description	In template	Output
`member.givennames` / `member.memberno`	Member details	`Hi (card )`	`Hi Sarah (card 00012345)`

`order_acknowledgement` — Order confirmation

Variable	Description	In template	Output
`order_data['Details']['GivenNames']`	Customer given name	`Hi ,`	`Hi Sarah,`
`header.createdlocal`	Order creation datetime	`Ordered on`	`Ordered on 16-07-2026 12:45PM`
`header.folioid`	Order/folio ID	`Order #`	`Order #FOL-88213`
`header.possaleid`	POS sale ID	`Sale #`	`Sale #SALE-44120`
`header.custname`	Customer name on order		`Sarah Jones`
`header.order_payments[0].paymenttypename`	Payment method	`Paid via`	`Paid via CreditCard`
`store['LocationName'/'AddressList'/'Phone'/'ABN']`	Store details	`,`	`George St Store, 02 9123 4567`
`lines[].ingredientdepth/pluitem/price/qty`	Order line items		`2x Flat White - $4.50`
`currency`	Currency symbol		`$24.90`
`header.total`	Order grand total	`Total:`	`Total: $24.90`
`header.GST` / `header.totalgst`	GST amount	`GST:`	`GST: $2.26`
`local_pickup_time`	Formatted pickup time	`Pickup at`	`Pickup at July 16, 2026 at 01:00PM`
`local_delivery_time`	Formatted delivery time	`Delivery at`	`Delivery at July 16, 2026 at 01:30PM`
`header.saletype`	Sale type (dine-in/pickup/delivery)		(pickup block rendered)
`order_data.cust_table_no`	Table number (dine-in)	`Table`	`Table 12`
`tracking_url`	Delivery tracking URL	`<a href="">Track order</a>`	`<a href="<https://tracking.example.com/order/44120>">Track order</a>`

`future_ordering_reminder`

Also supports the fields in the order confirmation email.

Variable	Description	In template	Output
`order_data.Address.address1/postcode/state/suburb`	Delivery address	`,`	`45 Smith St, Sydney NSW 2000`
`app_name`	Brand name	`Reminder from`	`Reminder from Redcat Rewards`

`giftcard_purchase` – gift to someone else

Variable	Description	In template	Output
`member['Amount'/'GivenNames'/'Surname'/'MemberNo'/'VerifyPIN']`	Generated gift-card record	`, you received`	`Sarah, you received $50.00`
`sender['GivenNames'/'Surname']`	Purchaser's name	`From`	`From John Smith`
`memo`	Personal gift message	`""`	`"Happy Birthday!"`
`is_gift`	Boolean flag		(gift block rendered)
`expiry_date`	Gift card expiry	`Expires`	`Expires July 16, 2027`
`barcode_url`	Gift card barcode view URL	`<img src="">`	`<img src="<https://app.example.com/barcode/token789>">`
`currency`	Currency symbol		`$50.00`
`headerimage`	Header image	`<img src="">`	`<img src="<https://cdn.example.com/mail/giftcard-600px.jpg>">`
`app_name`	Brand name	`A gift from`	`A gift from Redcat Rewards`
`store_details['ABN']`	Issuing (HQ) store ABN	`ABN`	`ABN 12 345 678 901`
`display_wallet_loyalty` / `wallet_loyalty_apple` / `wallet_loyalty_google`	Wallet pass links		`<a href="<https://app.example.com/wallet/apple?token=xyz>">Add to Wallet</a>`
`attach_image`	Asset URL helper	`<img src="">`	`<img src="<https://cdn.example.com/static/wallet-apple.png>">`

`giftcard_purchase_self` — self-purchase, no recipient

Subset of #14 — no sender/memo/is_gift/expiry_date/barcode_url/store_details['ABN']/currency/headerimage/app_name/wallet vars.

`giftcard_purchase_receipt` — receipt to purchaser

Variable	Description	In template	Output
`member['Amount'/'GivenNames'/'Surname']`	Gift card / recipient details	`Gift card for :`	`Gift card for Sarah Jones: $50.00`
`sender['GivenNames']`	Purchaser name	`Purchased by`	`Purchased by John`
`surcharge`	Card purchase surcharge fee	`Surcharge:`	`Surcharge: $1.50`
`recipient_data['recipient']`	Recipient email/identifier	`Sent to`	`Sent to sarah@example.com`
`scheduled_time`	Scheduled send time (if scheduled)	`Scheduled for`	`Scheduled for Thu Jul 16 09:00:00 2026 AEST`
`store_details['ABN']`	HQ store ABN	`ABN`	`ABN 12 345 678 901`
`currency`	Currency symbol		`$50.00`
`headerimage`	Header image	`<img src="">`	`<img src="<https://cdn.example.com/mail/GiftcardReceipt-600px.jpg>">`

`stampcard_reward_earned`

Variable	Description	In template	Output
`member.givennames`	Member first name	`Hi ,`	`Hi Sarah,`

`control_console_notification`

Variable	Description	In template	Output
`crud_type`	List of triggered order-stop actions	`Action taken:`	`Action taken: pause orders and notify manager`
`rule`	Triggering control-console rule object/name	`Rule triggered:`	`Rule triggered: High refund rate rule`

`sms_limit_notification`

Raw params dict passed through, varies by call site.

In template	Output
`Used of SMS`	`Used 1000 of 1000 SMS`

`unprocessed_order`

Variable	Description	In template	Output
`orders`	List of unprocessed order dicts		`FOL-88213`
`locationname`	Store name	`at`	`at George St Store`
`numOrders`	Count of unprocessed orders	`unprocessed orders`	`3 unprocessed orders`

`cardset_end_of_life_warning`

Variable	Description	In template	Output
`cardset.alpha`	Cardset alpha prefix	`Cardset`	`Cardset AB`
`cardset.MAX_CS_RANGE - number`	Numbers remaining before exhaustion	`0 numbers left`	`500 numbers left`
`client`	Client/site name	`Client:`	`Client: redcat-demo`

`alert` — Scheduled report alert

Variable	Description	Output
`data['name']`	Alert name	`Daily Sales Report`
`data['axis']`	Report column headers	`<th>Date</th><th>Total Sales</th><th>GST</th>`
`data['report_data']`	Report row data	`<td>2026-07-15</td><td>4520.00</td><td>411.00</td>`

`points_retrieval_request_member_request`

Variable	Description	In template	Output
`member.email/givennames/memberno/surname`	Requesting member's details	`()`	`Sarah Jones (sarah@example.com)`
`location_name`	Store name	`at`	`at George St Store`
`store_id`	Store recid	`Store #`	`Store #14`
`sale_id`	Receipt/sale number entered	`Receipt`	`Receipt SALE-44120`
`sale_total`	Claimed total	`Total`	`Total $24.90`
`transactiondatetime`	Claimed transaction datetime	`on`	`on 2026-07-15 12:45:00`

Also carries an image attachment (member-uploaded receipt photo).

`point_retrieval_request_fail`

Variable	Description	In template	Output
`member_email/given_names/surname/mobile/no`	Member contact/details	`,`	`Sarah Jones, sarah@example.com`
`store_name`	Store name	`at`	`at George St Store`
`recid_plo`	Store recid	`Store #`	`Store #14`
`salesid`	Receipt/sale ID entered	`Receipt`	`Receipt SALE-44120`
`total`	Total entered by member		`$24.90`
`photourl`	Uploaded receipt photo URL	`<img src="">`	`<img src="<https://cdn.example.com/uploads/receipt123.jpg>">`
`transactiondatetime`	Claimed transaction datetime	`on`	`on 2026-07-15 12:45:00`

`point_retrieval_request_approval`

Includes all of the point retrieval fail fields, plus:

Variable	Description	In template	Output
`token`	Encoded approval/decline token	`<a href="/approve?token=">Approve</a>`	`<a href="app.example.com/approve?token=eyJhbGciOiJIUzI1NiJ9...">Approve</a>`
`host`	Request host (for approval link)		`app.example.com`
`total_points`	Points to be awarded	`Award points`	`Award 250 points`
`header` (`.salelines[].item/qty/price/gst/points/recid_pou`)	Reconstructed sale header/lines		`2x Flat White`
`transactiondatetime`	Formatted transaction date/time	`on`	`on Wednesday, 15/07/2026 12:45PM`

`point_retrieval_request_approved` / `_no_points`

Variable	Description	In template	Output
`points_increase`	Points added to balance	`You earned points`	`You earned 250 points`
`member`	Member credited	`Hi ,`	`Hi Sarah,`

`point_retrieval_request_rejected`

Variable	Description	In template	Output
`comment`	Rejection reason	`Reason:`	`Reason: Receipt total does not match store records`
`requires_approval`	Whether approval flow was in effect		(approval-specific text rendered)
`third_party`	Rejected due to unsupported 3rd-party ordering provider		(third-party text rendered)
`member`	Member the rejection applies to	`Hi ,`	`Hi Sarah,`

`point_retrieval_request_submitted`

Static content, no variables.

DB-driven admin templates: parameter_template modifiers

Modifier	Effect	Example
`format`	Date formatting	`format: "%d/%m/%Y"` on `2026-07-16T12:45:00` → `16/07/2026`
`type`	Type coercion	`type: "float"` on `"24.90"` → `24.9`

Article Change Log

Date	Record of Changes	Author
August 2026	Introduced Article.	R Raines

System Generated Email Variables

Summary

Contents

Global (available in every template)

verify — Email verification

forgot_password — Password reset

User variant:

welcome — Welcome email

feedback — Feedback-loop survey

tfa_pin — Two-factor auth pin

email_updated — Old address notified after change

member_email_update

member_profile_update

card_transfer_start

card_transfer_acknowledgement

member_merge_acknowledgement

order_acknowledgement — Order confirmation

future_ordering_reminder

giftcard_purchase – gift to someone else

giftcard_purchase_self — self-purchase, no recipient

giftcard_purchase_receipt — receipt to purchaser

stampcard_reward_earned

control_console_notification

sms_limit_notification

unprocessed_order

cardset_end_of_life_warning

alert — Scheduled report alert

points_retrieval_request_member_request

point_retrieval_request_fail

point_retrieval_request_approval

Includes all of the point retrieval fail fields, plus:

point_retrieval_request_approved / _no_points

point_retrieval_request_rejected

point_retrieval_request_submitted

DB-driven admin templates: parameter_template modifiers

`verify` — Email verification

`forgot_password` — Password reset

`welcome` — Welcome email

`feedback` — Feedback-loop survey

`tfa_pin` — Two-factor auth pin

`email_updated` — Old address notified after change

`member_email_update`

`member_profile_update`

`card_transfer_start`

`card_transfer_acknowledgement`

`member_merge_acknowledgement`

`order_acknowledgement` — Order confirmation

`future_ordering_reminder`

`giftcard_purchase` – gift to someone else

`giftcard_purchase_self` — self-purchase, no recipient

`giftcard_purchase_receipt` — receipt to purchaser

`stampcard_reward_earned`

`control_console_notification`

`sms_limit_notification`

`unprocessed_order`

`cardset_end_of_life_warning`

`alert` — Scheduled report alert

`points_retrieval_request_member_request`

`point_retrieval_request_fail`

`point_retrieval_request_approval`

`point_retrieval_request_approved` / `_no_points`

`point_retrieval_request_rejected`

`point_retrieval_request_submitted`