LanguageValues and typesStandard typesMoney and banking
PaymentReference
On this page
The reference a payer sees on a UK bank payment: up to 18 characters.
Use it on Bacs and Faster Payments transfers, where banks allow only capitals, digits, spaces and . & / -. For your own invoice's number, use InvoiceNumber.
Shape
One value, held as text in one set form, with no parts: ACME & CO.
Example
PaymentReference("INV-2026/0042")PaymentReference(raw) checks the text, and text that isn't one breaks the format rule.
text.parse(raw, as: PaymentReference) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as inv-42, REFERENCE-NUMBER-123 or INV42.
Good to know
- It refuses lower case, so upper-case your text first.
==tells you whether two are the same.<andlist.sort_bydon't take it.
In JSON
A string, in a request, a response or json.write:
"INV-2026/0042""ACME & CO"
Details
Text form, storage, how it is shown, and operations
PaymentReference is in the group Money and banking, and has been in Jadpo since 0.1.0.
Text form
text.from writes one standard text form, the same form text.parse reads back: INV-2026/0042 and ACME & CO.
How it is stored
It is stored in one column named for the field, of type text. ACME & CO is stored as 'ACME & CO'.
How it is shown to people
text.format(value, locale:) shows it to people in their locale.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
INV-2026/0042 |
INV-2026/0042 |
ACME & CO |
ACME & CO |
Operations
It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.
Markdown for agents: /docs/types/type-payment-reference.md.Built from Jadpo main at aee2e8f.