Schemas / Person / organisation / party
rig.party.account
v0.31.0 · draft 6 fields 0 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
iban |
string | optional | International bank account number |
accountNumber |
string | optional | Domestic / other account id |
accountName |
string | optional | Name as held by the institution |
currency |
string | optional | ISO 4217 alpha-3, uppercase |
bic |
string | optional | 8- or 11-character BIC |
bankName |
string | optional | Institution name |
Payment account of a person or organisation. Format when present.
Field meanings follow the ISO 20022 CashAccount and FinancialInstitutionIdentification types used inside financial MX messages. This schema is those account elements - not an MX message (pain.*, pacs.*, camt.*) and not a payment.
All fields optional. Emit what the source has; omit empty strings. An empty component is invalid - attach at least one field.
Prefer iban when the source has one. accountNumber is the non-IBAN identifier. Do not dual-author a BBAN you derived from an IBAN.
Compose onto the party that owns the account - a person or an organisation. Account-holder display name stays on rig.meta.named of that party; accountName is only the string the bank printed. Institution postal address is rig.place.address on a bank entity, not a second address blob here.
A second account is another entity. Do not invent an accounts array here.
JSON Schema
Resolves at https://rig.works/schemas/rig.party.account.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.party.account.schema.json",
"title": "rig.party.account",
"type": "object",
"additionalProperties": false,
"properties": {
"iban": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"accountNumber": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"accountName": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "ISO 4217 (ISO 20022 Ccy)."
},
"bic": {
"type": "string",
"pattern": "^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$",
"description": "ISO 9362 BIC (ISO 20022 BICFI)."
},
"bankName": {
"$ref": "./_defs.schema.json#/$defs/string"
}
},
"description": "Payment account. Field meanings follow ISO 20022 CashAccount and FinancialInstitutionIdentification. Prefer IBAN when present.",
"minProperties": 1
}