Skip to content

Commit 5a7e1d2

Browse files
committed
document relationship between gov pay and ref number
1 parent ae78583 commit 5a7e1d2

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/features/form-definition-options.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,8 @@ The `options` object controls a handful of form-wide behaviours.
174174

175175
The reference number is always generated for every form session regardless of this setting. The setting only controls whether it is visible to the user on the confirmation screen.
176176

177+
When a form uses [GOV.UK Pay](./components/payment-field.mdx), the same reference number is passed to Gov.UK Pay as the payment reference. Enabling `showReferenceNumber` lets users correlate their form submission with their payment receipt.
178+
177179
### Reference number prefix
178180

179181
`metadata.referenceNumberPrefix` — a string prepended to the auto-generated reference number. Without a prefix the format is `XXX-XXX-XXX`. With a prefix the format is `PREFIX-XXX-XXX`.

0 commit comments

Comments
 (0)