Reference

world.id.banking$package.Reference
object Reference extends Scheme[Reference]

An ISO 11649 creditor reference: the RF payment reference an invoice carries so the payment that comes back can be matched to it by machine. A creditor mints one from its own invoice number with Reference.of; a payer's incoming reference is checked with parse. Values are Id[Reference].

Attributes

Graph
Supertypes
class Scheme[Reference]
class Object
trait Matchable
class Any
Self type
Reference.type

Members list

Value members

Concrete methods

def of(body: String): Either[Invalid, Id[Reference.type]]

Mints the reference for a creditor's own invoice number, computing the check digits. The number may be up to twenty-one letters and digits; spaces in it are ignored.

Mints the reference for a creditor's own invoice number, computing the check digits. The number may be up to twenty-one letters and digits; spaces in it are ignored.

Attributes

Inherited methods

inline def apply(inline value: String): Id[this.type]

A literal validated while compiling, emitted already canonical. Non-constant input goes to parse, as do schemes whose rules carry code, which cannot run at compile time.

A literal validated while compiling, emitted already canonical. Non-constant input goes to parse, as do schemes whose rules carry code, which cannot run at compile time.

Attributes

Inherited from:
Scheme
final def parse(raw: String): Either[Invalid, Id[this.type]]

Parses and canonicalises input under this scheme's rules - normalisation, row selection, structure, then check arithmetic - failing with the first violated tier's reason. The result is typed to this scheme whether it was named statically or selected at runtime.

Parses and canonicalises input under this scheme's rules - normalisation, row selection, structure, then check arithmetic - failing with the first violated tier's reason. The result is typed to this scheme whether it was named statically or selected at runtime.

Attributes

Inherited from:
Scheme

Inherited fields

val authority: Authority

Attributes

Inherited from:
Scheme
val label: String

Attributes

Inherited from:
Scheme

Givens

Givens

given given_Aux_Id_Invalid: Aux[Id[Reference.type], Invalid]

Extensions

Extensions

extension (r: Id[Reference.type])
def body: String

The creditor's own invoice number, back out of the reference.

The creditor's own invoice number, back out of the reference.

Attributes