Payment Field

Redirects the user to GOV.UK Pay to collect a payment before proceeding.

Preview

Before payment

Pay for your application

Application fee

Warning You may see a pending transaction in your bank account but you will only be charged when you submit the form.

You can submit the form after you have added your payment details.

Total amount:

£2,300.00

After payment

You have already authorised a payment for this form

Continue to submit the form. You will not be charged twice.

JSON definition

{
  "type": "PaymentField",
  "name": "fieldName",
  "title": "Question title",
  "hint": "",
  "shortDescription": "",
  "options": {
    "amount": 0,
    "description": ""
  }
}

Properties

Property	Type	Required	Description
`hint`	`string`	No	Hint text displayed below the field label to help the user answer the question.
`shortDescription`	`string`	No	A short description of the field used in the check-your-answers summary.

Options

Property	Type	Required	Description
`amount`	`number`	Yes	Fixed payment amount in pence.
`classes`	`string`	No	Additional CSS classes applied to the component.
`conditionalAmounts`	`object`	No	Condition-based payment amounts. Each entry requires a `condition` name and `amount` in pence.
`customValidationMessages`	`object`	No	A map of Joi error codes to custom error messages.
`description`	`string`	Yes	Description shown on the GOV.UK Pay payment page.
`emailField`	`string`	No	Name of the form field containing the user's email address for the confirmation email.
`instructionText`	`string`	No	Alternative text read by screen readers in place of the field title.
`optionalText`	`boolean`	No	When `true`, appends '(optional)' to the field label.
`required`	`boolean`	No	Whether the field must be filled in. Defaults to `true`.