am.noz.at.spl.settlement

noz.am

Documentation

An immutable record of money paid between two ledger members, optionally filed in a group.

main record

An immutable record of money paid between two ledger members, optionally filed in a group.

Record Key tid Timestamp-based ID

Properties

amountMinor integer Required

No description available.

minimum: 1
createdAt string datetime Required

An RFC 3339 formatted timestamp.

currency string Required

No description available.

maxLength: 3 bytesminLength: 3 bytes
fromDid string did Required

A decentralized identifier (DID).

groupId string Optional

Optional organizational group or trip within the ledger Space.

maxLength: 64 bytesminLength: 1 bytes
minorUnit integer Required

No description available.

minimum: 0maximum: 4
note string Optional

No description available.

maxLength: 2000 bytesmaxGraphemes: 300 graphemes
occurredAt string datetime Required

An RFC 3339 formatted timestamp.

paymentReference string Optional

Optional opaque reference from a payment integration; never store credentials or secrets.

maxLength: 500 bytes
schemaVersion integer Required

No description available.

settlementId string Required

No description available.

maxLength: 64 bytesminLength: 1 bytes
toDid string did Required

A decentralized identifier (DID).

voided boolean Required

No description available.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "schemaVersion",
      "settlementId",
      "fromDid",
      "toDid",
      "currency",
      "minorUnit",
      "amountMinor",
      "occurredAt",
      "createdAt",
      "voided"
    ],
    "properties": {
      "note": {
        "type": "string",
        "maxLength": 2000,
        "maxGraphemes": 300
      },
      "toDid": {
        "type": "string",
        "format": "did"
      },
      "voided": {
        "type": "boolean"
      },
      "fromDid": {
        "type": "string",
        "format": "did"
      },
      "groupId": {
        "type": "string",
        "maxLength": 64,
        "minLength": 1,
        "description": "Optional organizational group or trip within the ledger Space."
      },
      "currency": {
        "type": "string",
        "maxLength": 3,
        "minLength": 3
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "minorUnit": {
        "type": "integer",
        "maximum": 4,
        "minimum": 0
      },
      "occurredAt": {
        "type": "string",
        "format": "datetime"
      },
      "amountMinor": {
        "type": "integer",
        "minimum": 1
      },
      "settlementId": {
        "type": "string",
        "maxLength": 64,
        "minLength": 1
      },
      "schemaVersion": {
        "type": "integer",
        "const": 1
      },
      "paymentReference": {
        "type": "string",
        "maxLength": 500,
        "description": "Optional opaque reference from a payment integration; never store credentials or secrets."
      }
    }
  },
  "description": "An immutable record of money paid between two ledger members, optionally filed in a group."
}

Lexicon Garden

@