Skip to content

Template: Payment Failed

Action Key
payment_failed
Description
Sent when a payment reaches a terminal failed state.
Recipients
guardian

Template Variables

These variables are available in the Liquid template context. Access nested properties using dot notation (e.g., enrolment.activity.name).

payment(type: payment)

An object representing a payment transaction.

Property PathTypeDescription
payment.idstring
Unique ID of the payment (UUID).
payment.amountstring
The payment amount (formatted decimal string).
payment.gateway_transaction_messagestring
Message returned by the payment gateway.
payment.gateway_transaction_statusstring
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.