PaymentReference
The reference a payer sees on a UK bank payment: up to 18 of Bacs's characters, INV-2026/0042.
Money and banking; not ordered; since Jadpo 0.1.0.
Make one
Build one from its text, PaymentReference("INV-2026/0042"), which checks it: text that isn't one breaks format.
text.parse(raw, as: PaymentReference) reads one from its text; text that isn't one at all fails malformed, such as inv-42, REFERENCE-NUMBER-123 or INV42.
Text, JSON and storage
text.from writes its canonical text, the one form text.parse reads back. JSON sends its canonical text as a string.
| Text | JSON |
|---|---|
INV-2026/0042 |
"INV-2026/0042" |
ACME & CO |
"ACME & CO" |
It is stored in one column named for the field, of type text. ACME & CO is stored as 'ACME & CO'.
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 has the contract's own operations: text.parse, text.from, text.format, json.read, json.write and ==. It isn't ordered, so < and sorting don't take it. Every standard type meets one contract says how they work.
Markdown for agents: /docs/types/type-payment-reference.md.Built from Jadpo main at e00e61f.