Schemas / Finance
rig.finance.payment
v1.0.0 · stable maturity: draft 8 fields 3 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
debtor |
entity | required | Party that pays |
creditor |
entity | required | Party that receives |
status |
enumpending · booked · rejected · cancelled | required | pending / booked / rejected / cancelled |
debtorAccount |
entity | optional | Optional. Debtor rig.party.account |
creditorAccount |
entity | optional | Optional. Creditor account |
endToEndId |
string | optional | Optional. End-to-end identification |
bookedDate |
string | optional | Optional. Booking day, YYYY-MM-DD |
invoice |
entity | optional | Optional. The rig.commerce.invoice this settles |
A movement of money between two parties. Format when present.
Field meanings follow ISO 20022 CreditTransferTransaction / PaymentIdentification elements used inside financial MX messages. This schema is those payment elements - not a pacs.* / pain.* message, and not a settlement engine.
debtor, creditor, and status are required.
The amount is rig.commerce.price on this entity. The clock of the happening is rig.calendar.event. A file this payment belongs to is rig.record.concerns. A second payment is another entity.
JSON Schema
Resolves at https://rig.works/schemas/rig.finance.payment.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.finance.payment.schema.json",
"title": "rig.finance.payment",
"type": "object",
"additionalProperties": false,
"properties": {
"debtor": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"creditor": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"status": {
"type": "string",
"enum": [
"pending",
"booked",
"rejected",
"cancelled"
]
},
"debtorAccount": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"creditorAccount": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"endToEndId": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"bookedDate": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"description": "ISO 8601 calendar date."
},
"invoice": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"required": [
"debtor",
"creditor",
"status"
],
"description": "A movement of money. Field meanings follow ISO 20022 payment identification. Not a pacs message.",
"x-rig-maturity": "draft"
}