Options Type

object (Options)

options Default Value

The default value is:

Copy
{}

options Properties

rows

Number of rows for textarea components

rows

• is optional

• Type: number (Rows)

• cannot be null

• defined in: Form Definition V2 Schema

Rows Type

number (Rows)

maxWords

Maximum number of words allowed in text inputs

maxWords

• is optional

• Type: number (Max Words)

• cannot be null

• defined in: Form Definition V2 Schema

Max Words Type

number (Max Words)

maxDaysInPast

Maximum days in the past allowed for date inputs

maxDaysInPast

• is optional

• Type: number (Max Days In Past)

• cannot be null

• defined in: Form Definition V2 Schema

Max Days In Past Type

number (Max Days In Past)

maxDaysInFuture

Maximum days in the future allowed for date inputs

maxDaysInFuture

• is optional

• Type: number (Max Days In Future)

• cannot be null

• defined in: Form Definition V2 Schema

Max Days In Future Type

number (Max Days In Future)

earliestDate

Earliest date of allowed date range for date inputs

earliestDate

• is optional

• Type: integer (Earliest Date)

• cannot be null

• defined in: Form Definition V2 Schema

Earliest Date Type

integer (Earliest Date)

latestDate

Latest date of allowed date range for date inputs

latestDate

• is optional

• Type: integer (Latest Date)

• cannot be null

• defined in: Form Definition V2 Schema

Latest Date Type

integer (Latest Date)

customValidationMessage

Custom error message for validation failures

customValidationMessage

• is optional

• Type: string (Custom Validation Message)

• cannot be null

• defined in: Form Definition V2 Schema

Custom Validation Message Type

string (Custom Validation Message)

customValidationMessages

Custom error messages keyed by validation rule name

customValidationMessages

• is optional

• Type: object (Custom Validation Messages)

• cannot be null

• defined in: Form Definition V2 Schema

Custom Validation Messages Type

object (Custom Validation Messages)

amount

Payment amount in GBP (£0 - £100,000)

amount

• is optional

• Type: number (Amount)

• cannot be null

• defined in: Form Definition V2 Schema

Amount Type

number (Amount)

amount Constraints

maximum: the value of this number must smaller than or equal to: 100000

minimum: the value of this number must greater than or equal to: 0

description

Payment description (max 230 chars)

description

• is optional

• Type: string (Description)

• cannot be null

• defined in: Form Definition V2 Schema

Description Type

string (Description)

description Constraints

maximum length: the maximum number of characters for this string is: 230

conditionalAmounts

Conditional payment amounts evaluated in order

conditionalAmounts

• is optional

• Type: object[] (Item)

• cannot be null

• defined in: Form Definition V2 Schema

Conditional Amounts Type

object[] (Item)

emailField

Name of EmailAddressField to prepopulate GOV.UK Pay email

emailField

• is optional

• Type: string (Email Field)

• cannot be null

• defined in: Form Definition V2 Schema

Email Field Type

string (Email Field)

countries

Country filters for geospatial data - for GeospatialField only

countries

• is optional

• Type: string[] (Item)

• cannot be null

• defined in: Form Definition V2 Schema

Countries Type

string[] (Item)

geometryTypes

Geometry types for geospatial data - for GeospatialField only

geometryTypes

• is optional

• Type: string[] (Item)

• cannot be null

• defined in: Form Definition V2 Schema

Geometry Types Type

string[] (Item)

format

Format for telephone number - for TelephoneNumberField only

format

• is optional

• Type: string (Format)

• cannot be null

• defined in: Form Definition V2 Schema

Format Type

string (Format)

format Constraints

enum: the value of this property must be equal to one of the following values:

Additional Properties

Additional properties are allowed and do not have to follow a specific schema