Skip to content

Template: Payment Received

Action Key
payment_received
Description
Sent when a payment is recorded for a family.
Recipients
guardian

Template Variables

These variables are available in the Liquid template context. Access nested properties using dot notation (e.g., enrolment.activity.name). For a guided introduction to Liquid in Cadence, seeCommunication templates.

payments(type: list[payment])

							{% for item in payments %}
  {{ item }}
{% endfor %}
						
Property PathTypeDescription
payments.idlist[string]
Unique ID of the payment (UUID).
payments.amountlist[string]
The payment amount (formatted decimal string).
payments.gateway_transaction_messagelist[string]
Message returned by the payment gateway.
payments.gateway_transaction_statuslist[string]
Status code or label returned by the gateway.

family(type: family)

An object representing a household / family group.

Property PathTypeDescription
family.idinteger
Unique ID of the family.
family.namestring
Family name.

tenant(type: tenant)

An object representing an organisation/tenant.

Property PathTypeDescription
tenant.idinteger
Unique ID of the tenant.
tenant.namestring
Name of the organisation.