Data Models

Ledgers

{
  "id": "ledger_123",
  "name": "Main Ledger",
  "api_key": "******",
  "metadata": {
    "project_features": "sepa, cards",
    "project_type": "personal, business",
    "status": "active"
  },
  "created_at": "2026-04-16T10:00:00Z",
  "updated_at": "2026-04-16T10:00:00Z"
}

Ledger metadata

The metadata an object can be used for custom business classification and configuration.

Example:

{
  "metadata": {
    "project_features": "sepa, cards",
    "project_type": "personal, business",
    "status": "active"
  }
}

Recommended usage:

• project_features: comma-separated or structured list of supported capabilities

• project_type: business classification such as personal, business, enterprise

• status: lifecycle state such as active, disabled, pending

Account

{
  "id": "ledger_123",
  "name": "Main Ledger",
  "api_key": "******",
  "metadata": {
    "project_features": "sepa, cards",
    "project_type": "personal, business",
    "status": "active"
  },
  "created_at": "2026-04-16T10:00:00Z",
  "updated_at": "2026-04-16T10:00:00Z"
}

Transaction

{
  "id": "txn_123",
  "ledger_id": "ledger_123",
  "account_id": "account_123",
  "amount": 2500,
  "description": "Card settlement",
  "type": "TRANSFER",
  "status": "PENDING",
  "metadata": {
    "provider": "letknow",
    "reference": "ABC123"
  },
  "created_at": "2026-04-16T10:00:00Z",
  "updated_at": "2026-04-16T10:00:00Z"
}

Allowed transaction types:

• TRANSFER

• ISSUE

• RETIRE

Allowed transaction statuses:

• PENDING

• INFLIGHT

• COMPLETED

• REJECTED

• VOID

Allowed status transitions:

• PENDING → INFLIGHT, COMPLETED, REJECTED, VOID

• INFLIGHT → COMPLETED, REJECTED, VOID

• COMPLETED → no further transitions

• REJECTED → no further transitions

• VOID → no further transitions