Message Tokens

Below is a list of tokens that can be applied to payer messages to add dynamic information to the emails, letters and SMS messages that PayGate send to your payers. Also see the sample 'Advance Notice' template for an example of how tokens are used.

Token

Example

Explanation

[RecurrenceType]

Weekly,

Monthly,

Yearly

The base frequency of the payer's collection schedule

[RecurrenceEndType]

One Off,

Until Date,

Until Number Of Payments,

Ongoing

How the collection schedule will come to an end.

[AdvanceNoticeInDays]

The current advance notice period in days for the DDMS group.

[UntilDate]

03/11/2015

If the ' RecurrenceEndType' is set to 'Until Date' this shows the date that the schedule will end..

[TotalPayments]

If the ' RecurrenceEndType' is set to 'Until Number Of Payments' this shows the total number of collections in the schedule.

[NextScheduledPaymentDate]

03/11/2015

The date of the next scheduled collection after today. In dd/MM/yyyy format.

[NextScheduledPaymentAmount]

£12.34

The amount in pounds and pence (including the £ symbol) of the next scheduled collection after today.

[FirstAmount]

12.34

The amount of the first (or one-off) collection in a plan.

[RegularAmount]

123.45

The regular collection amount in a plan.

[LastAmount]

1234.56

In a plan that has a finite number of collections, this is the amount of the final collection.

[PayerSortcode]

123456

The sortcode of the payer bank account.

[PayerSortcode-]

12-34-56

The sortcode of the payer bank account presented with the commonly used hyphen separators.

[PayerAccountNumber]

12345678

The account number of the payer's bank account.

[PayerAccountNumberMasked]

****5678

The account number of the payer's bank account. First four numbers are masked as advised by Direct Debit scheme rules.

[Reference]

1234-32

The payer's reference.

[Firstname]

Bob

The payer's first name.

[Surname]

Smith

The payer's surname.

[AccountHoldersName]

Mr Bob Smith

The title and full name of the payer's account.

[Date]

26/05/2015

Today's date in DD/MM/YYYY format

[Date:ddMMyyyy]

Thursday 29th May 2015

29 May 2015

General Date and time formatter.

Usage: Replace ddMMyyyy with the date or time tokens from the table below to display the date and / or time in almost any format.

[Date+n]

[Date+10]

Today plus n working days

[Time12]

03:09 PM

The current time in hh:mm tt format. Where tt is either AM or PM. Based on a 12 hour clock.

[Time24]

15:09

The current time in hh:mm format. Based on a 12 hour clock

[ServiceUserName]

Soylent Corporation

The name of the service user. Taken from the setting in 'DDMS Group Configuration'.

[ServiceUserNumber]

123456

The Service User Number (SUN) this is being used for the group that the payer belongs to. Taken from the setting in 'DDMS Group Configuration'.

[ServiceUserTelephone]

01234 567 890

The service user's telephone number.