7 Commits
Author SHA1 Message Date
zemion f6b4834588 test: compare manifest version with package metadata
Module Package Release / publish-packages (push) Successful in 11s
2026-09-08 02:16:54 +02:00
zemion a081f59ab7 fix(packaging): expose immutable WebUI Git package for v0.1.22 2026-09-08 02:06:10 +02:00
zemion 2340bf53f9 docs(payments): add complete German payment guidance
Module Package Release / publish-packages (push) Successful in 11s
2026-08-23 01:54:19 +02:00
zemion e08bc8b992 feat(payments): add governed DSAR coverage 2026-08-21 04:26:14 +02:00
zemion da0ee0f325 refactor(webui): adopt semantic page actions 2026-08-19 18:47:45 +02:00
zemion 884d068689 Adopt semantic payments action layout 2026-08-19 14:26:26 +02:00
zemion a2dcd8f2dd Add guided Payments operator workspace
Module Package Release / publish-packages (push) Successful in 14s
2026-08-19 13:17:13 +02:00
20 changed files with 2536 additions and 7 deletions
+26
View File
@@ -14,6 +14,12 @@ amount/currency, external transaction reference, and a same-tenant versioned or
checksum-bound evidence reference. Payments rejects changed replays, partial or
cross-currency matches, cross-tenant evidence, and a second settlement.
Version 0.1.20 adds the permission-aware Payments operator workspace at
`/payments`. It uses the shared Core page, action, form, dialog, and table
grammar, keeps Reload and Create in stable collection slots, and guides request
creation and exact evidence-bound manual reconciliation without exposing raw
JSON.
Online payment providers, applicant checkout, partial payments, refunds,
reversals, Ledger posting, and XRechnung are intentionally separate next
slices. See [docs/PAYMENTS_DOMAIN.md](docs/PAYMENTS_DOMAIN.md).
@@ -23,4 +29,24 @@ Focused verification:
```sh
PYTHONPATH=src:/mnt/DATA/git/govoplan-core/src \
/mnt/DATA/git/govoplan/.venv/bin/python -m unittest discover -s tests
cd webui && npm run test:interface-pattern
```
## Git-source WebUI package
The repository root exposes `@govoplan/payments-webui` for Git-tagged release
dependencies. It mirrors the owning `webui/package.json` version, public
TypeScript/CSS exports and peer requirements, with entry paths under
`webui/src`. Consumers provide the shared Core/React peers; the facade runs no
development or install scripts. The source archive contains `webui/src`, this
README and any repository license file. Run module development checks from `webui/`; Python
installation remains governed by `pyproject.toml`.
Das Repository stellt `@govoplan/payments-webui` am Wurzelpfad für versionierte
Git-Abhängigkeiten bereit. Version, öffentliche TypeScript-/CSS-Exporte und
Peer-Anforderungen entsprechen `webui/package.json`; die Einstiegspfade liegen
unter `webui/src`. Gemeinsame Core-/React-Peers stellt die einbindende Anwendung
bereit. Die Fassade führt keine Entwicklungs- oder Installationsskripte aus.
Entwicklungsprüfungen bleiben in `webui/`, die Python-Installation weiterhin in
`pyproject.toml` definiert.
+23
View File
@@ -39,6 +39,29 @@ closed. Corrections, reversals, refunds, chargebacks, partial payments, and
overpayments require future append-only adjustment types and must never mutate
the original evidence silently.
## Operator workspace
The permission-aware `/payments` workspace is the operator projection of this
contract. Readers can filter requested and paid obligations and inspect their
source, Case/Workflow context references, amount, due or settled time, and
immutable evidence reference. Writers create fixed obligations in a guided
dialog; the UI supplies an explicit replay key and never copies applicant or
Form content into Payments.
Reconciliation uses a separate consequential dialog. Amount and currency are
fixed from the selected obligation rather than editable. The operator records
the external transaction reference, receipt time, evidence owner, kind, ID,
and at least one immutable version or checksum. The dialog explains that paid
state cannot be silently undone and that a governed adjustment is required.
Missing permissions remain visible with the exact scope and responsible
administrator.
Reload is always available in the collection action bar. A failed refresh
preserves the last successful result and labels it stale; an initial failure
uses a whole-surface retry state. The workspace also distinguishes loading,
empty, permission-blocked, conflict, replay-success, and ordinary success
states.
## Access, privacy, and audit
Payment readers see obligation and reconciliation metadata. Writers create
+33
View File
@@ -0,0 +1,33 @@
{
"name": "@govoplan/payments-webui",
"version": "0.1.22",
"private": true,
"type": "module",
"main": "webui/src/index.ts",
"module": "webui/src/index.ts",
"types": "webui/src/index.ts",
"exports": {
".": {
"types": "./webui/src/index.ts",
"import": "./webui/src/index.ts"
},
"./styles/payments.css": "./webui/src/styles/payments.css"
},
"peerDependencies": {
"@govoplan/core-webui": "^0.1.18",
"lucide-react": "^1.23.0",
"react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20",
"react-router": ">=8.3.0 <9"
},
"peerDependenciesMeta": {
"@govoplan/core-webui": {
"optional": true
}
},
"files": [
"webui/src",
"README.md",
"LICENSE"
]
}
+2 -2
View File
@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
[project]
name = "govoplan-payments"
version = "0.1.19"
version = "0.1.22"
description = "Replay-safe payment obligations and reconciliation evidence for GovOPlaN."
readme = "README.md"
requires-python = ">=3.12"
authors = [{ name = "GovOPlaN" }]
dependencies = ["govoplan-core>=0.1.18"]
dependencies = ["govoplan-core>=0.1.37"]
[tool.setuptools.packages.find]
where = ["src"]
+1 -1
View File
@@ -1,3 +1,3 @@
"""GovOPlaN Payments module."""
__version__ = "0.1.19"
__version__ = "0.1.22"
@@ -0,0 +1,550 @@
from __future__ import annotations
from collections.abc import Mapping, Sequence
from dataclasses import dataclass
from datetime import datetime, timezone
from sqlalchemy.orm import Session
from govoplan_core.core.dsar import (
DsarErasureActionRef,
DsarExecutionResultRef,
DsarRecordRef,
DsarSubjectRef,
dsar_capability_name,
)
from govoplan_payments.backend.db.models import (
PaymentEvent,
PaymentObligation,
PaymentReconciliation,
)
PAYMENTS_DSAR_CAPABILITY = dsar_capability_name("payments")
_MAX_RECORDS = 5_000
_MAX_CHILD_RECORDS = 1_000
_CONFLICT = object()
_ATTRIBUTION_TYPES = frozenset(
{
"payment_request_attribution",
"payment_reconciliation_attribution",
"payment_event_attribution",
}
)
@dataclass(frozen=True, slots=True)
class _SubjectSelectors:
actor_refs: tuple[str, ...]
payment_row_id: str | None
payment_id: str | None
payment_reference: str | None
@property
def has_payment_selector(self) -> bool:
return bool(self.payment_row_id or self.payment_id or self.payment_reference)
class PaymentsDsarProvider:
provider_id = "payments"
module_id = "payments"
def search_subject(
self,
session: object,
*,
tenant_id: str,
subject: DsarSubjectRef,
) -> Sequence[DsarRecordRef]:
db = _session(session)
selectors = _subject_selectors(subject)
if selectors is None:
return ()
if selectors.has_payment_selector:
query = db.query(PaymentObligation).filter(
PaymentObligation.tenant_id == tenant_id
)
if selectors.payment_row_id:
query = query.filter(PaymentObligation.id == selectors.payment_row_id)
if selectors.payment_id:
query = query.filter(
PaymentObligation.payment_id == selectors.payment_id
)
if selectors.payment_reference:
query = query.filter(
PaymentObligation.payment_reference == selectors.payment_reference
)
rows = (
query.order_by(
PaymentObligation.requested_at,
PaymentObligation.id,
)
.limit(_MAX_RECORDS + 1)
.all()
)
if len(rows) > _MAX_RECORDS:
raise ValueError(
"Payments DSAR result limit exceeded; narrow the identifiers."
)
return tuple(_payment_record(db, row) for row in rows)
if not selectors.actor_refs:
return ()
records: list[DsarRecordRef] = []
obligations = db.query(PaymentObligation).filter(
PaymentObligation.tenant_id == tenant_id,
PaymentObligation.requested_by_ref.in_(selectors.actor_refs),
)
records.extend(
_request_attribution(row)
for row in _limited(
obligations,
PaymentObligation,
"request attribution",
)
)
reconciliations = db.query(PaymentReconciliation).filter(
PaymentReconciliation.tenant_id == tenant_id,
PaymentReconciliation.recorded_by_ref.in_(selectors.actor_refs),
)
records.extend(
_reconciliation_attribution(row)
for row in _limited(
reconciliations,
PaymentReconciliation,
"reconciliation attribution",
)
)
events = db.query(PaymentEvent).filter(
PaymentEvent.tenant_id == tenant_id,
PaymentEvent.actor_ref.in_(selectors.actor_refs),
)
records.extend(
_event_attribution(row)
for row in _limited(events, PaymentEvent, "event attribution")
)
if len(records) > _MAX_RECORDS:
raise ValueError(
"Payments DSAR combined result limit exceeded; narrow the selectors."
)
order = {
"payment_request_attribution": 10,
"payment_reconciliation_attribution": 20,
"payment_event_attribution": 30,
}
return tuple(
sorted(
records,
key=lambda item: (order[item.resource_type], item.resource_id),
)
)
def plan_erasure(
self,
session: object,
*,
tenant_id: str,
subject: DsarSubjectRef,
records: Sequence[DsarRecordRef],
) -> Sequence[DsarErasureActionRef]:
del tenant_id
_session(session)
if _subject_selectors(subject) is None:
raise ValueError("Payments DSAR subject selectors conflict.")
actions: list[DsarErasureActionRef] = []
for record in records:
_validate_record(record)
actions.append(
DsarErasureActionRef(
action_id=(
f"payments:retain:{record.resource_type}:{record.resource_id}"
),
provider_id=self.provider_id,
module_id=self.module_id,
kind="retain",
resource_type=record.resource_type,
resource_id=record.resource_id,
title=f"Retain {record.title}",
rationale=record.retention_reason
or "Financial and reconciliation evidence must be retained.",
executable=False,
)
)
return tuple(actions)
def execute_erasure(
self,
session: object,
*,
tenant_id: str,
subject: DsarSubjectRef,
actions: Sequence[DsarErasureActionRef],
request_id: str,
) -> Sequence[DsarExecutionResultRef]:
del tenant_id
_session(session)
if _subject_selectors(subject) is None:
raise ValueError("Payments DSAR subject selectors conflict.")
results: list[DsarExecutionResultRef] = []
for action in actions:
_validate_action(action)
if action.executable or action.kind != "retain":
raise ValueError("Payments DSAR publishes retain-only actions.")
results.append(
DsarExecutionResultRef(
action_id=action.action_id,
status="blocked",
summary=(
"Payment and reconciliation evidence remains under the "
"configured financial, statutory, and legal-hold policy."
),
evidence={"request_id": request_id},
)
)
return tuple(results)
def _subject_selectors(subject: DsarSubjectRef) -> _SubjectSelectors | None:
references = subject.external_references
values = {
"account_id": _coalesce(
subject.account_id,
references.get("payments.account"),
references.get("access.account"),
),
"membership_id": _coalesce(
subject.membership_id,
references.get("payments.membership"),
references.get("tenancy.membership"),
),
"identity_id": _coalesce(
subject.identity_id,
references.get("payments.identity"),
references.get("identity.id"),
),
"actor_ref": _coalesce(
references.get("payments.actor"),
references.get("payments.operator"),
),
"payment_row_id": _coalesce(
references.get("payments.obligation"),
references.get("payments.row"),
),
"payment_id": _coalesce(
references.get("payments.payment"),
references.get("payments.payment_id"),
),
"payment_reference": _coalesce(
references.get("payments.reference"),
references.get("payments.payment_reference"),
),
}
if any(value is _CONFLICT for value in values.values()):
return None
account_id = _optional_string(values["account_id"])
membership_id = _optional_string(values["membership_id"])
identity_id = _optional_string(values["identity_id"])
direct_actor = _optional_string(values["actor_ref"])
actor_refs = tuple(
dict.fromkeys(
value
for value in (
account_id,
f"account:{account_id}" if account_id else None,
membership_id,
f"membership:{membership_id}" if membership_id else None,
identity_id,
f"identity:{identity_id}" if identity_id else None,
direct_actor,
)
if value
)
)
selectors = _SubjectSelectors(
actor_refs=actor_refs,
payment_row_id=_optional_string(values["payment_row_id"]),
payment_id=_optional_string(values["payment_id"]),
payment_reference=_optional_string(values["payment_reference"]),
)
if not selectors.actor_refs and not selectors.has_payment_selector:
return None
return selectors
def _coalesce(*values: str | None) -> str | None | object:
normalized = {str(value).strip() for value in values if str(value or "").strip()}
if len(normalized) > 1:
return _CONFLICT
return next(iter(normalized), None)
def _optional_string(value: object) -> str | None:
return value if isinstance(value, str) and value else None
def _limited(query, model, label: str):
rows = query.order_by(model.created_at, model.id).limit(_MAX_RECORDS + 1).all()
if len(rows) > _MAX_RECORDS:
raise ValueError(f"Payments DSAR {label} limit exceeded; narrow the selectors.")
return rows
def _payment_record(
session: Session,
obligation: PaymentObligation,
) -> DsarRecordRef:
reconciliations = _children(
session.query(PaymentReconciliation).filter(
PaymentReconciliation.tenant_id == obligation.tenant_id,
PaymentReconciliation.payment_row_id == obligation.id,
),
PaymentReconciliation,
"reconciliation",
)
events = _children(
session.query(PaymentEvent).filter(
PaymentEvent.tenant_id == obligation.tenant_id,
PaymentEvent.payment_row_id == obligation.id,
),
PaymentEvent,
"event",
)
return DsarRecordRef(
provider_id="payments",
module_id="payments",
resource_type="payment_obligation",
resource_id=obligation.id,
category="financial_obligation_and_evidence",
title=f"Payment obligation {obligation.payment_reference}",
data={
"payment_id": obligation.payment_id,
"payment_reference": obligation.payment_reference,
"source_module": obligation.source_module,
"source_resource_type": obligation.source_resource_type,
"source_resource_id": obligation.source_resource_id,
"amount_minor": obligation.amount_minor,
"currency": obligation.currency,
"subject": obligation.subject[:1_000],
"status": obligation.status,
"requested_at": _iso(obligation.requested_at),
"requested_by_ref": obligation.requested_by_ref,
"due_at": _iso(obligation.due_at),
"settled_at": _iso(obligation.settled_at),
"context_refs": _context_refs(obligation.context_refs),
"reconciliations": [
{
"id": row.id,
"reconciliation_id": row.reconciliation_id,
"mode": row.mode,
"amount_minor": row.amount_minor,
"currency": row.currency,
"transaction_reference": row.transaction_reference,
"evidence_ref": _evidence_reference(row.evidence_ref),
"received_at": _iso(row.received_at),
"recorded_at": _iso(row.recorded_at),
"recorded_by_ref": row.recorded_by_ref,
}
for row in reconciliations
],
"events": [
{
"id": row.id,
"event_id": row.event_id,
"event_type": row.event_type,
"status": row.status,
"occurred_at": _iso(row.occurred_at),
"actor_ref": row.actor_ref,
}
for row in events
],
},
observed_at=_aware(obligation.updated_at),
immutable_evidence=True,
retention_reason=(
"The exact obligation, reconciliation, and lifecycle records are "
"financial evidence. Arbitrary metadata and event payloads are excluded."
),
)
def _children(query, model, label: str):
rows = (
query.order_by(model.created_at, model.id).limit(_MAX_CHILD_RECORDS + 1).all()
)
if len(rows) > _MAX_CHILD_RECORDS:
raise ValueError(
f"Payment {label} history exceeds the DSAR bound; narrow and review the payment."
)
return rows
def _request_attribution(row: PaymentObligation) -> DsarRecordRef:
return _attribution_record(
"payment_request_attribution",
row.id,
"Requested payment obligation",
{
"activity": "requested_payment_obligation",
"payment_id": row.payment_id,
"payment_reference": row.payment_reference,
"source_module": row.source_module,
"source_resource_type": row.source_resource_type,
"source_resource_id": row.source_resource_id,
"amount_minor": row.amount_minor,
"currency": row.currency,
"status": row.status,
"requested_at": _iso(row.requested_at),
},
row.requested_at,
)
def _reconciliation_attribution(row: PaymentReconciliation) -> DsarRecordRef:
return _attribution_record(
"payment_reconciliation_attribution",
row.id,
"Recorded payment reconciliation",
{
"activity": "recorded_payment_reconciliation",
"payment_row_id": row.payment_row_id,
"reconciliation_id": row.reconciliation_id,
"mode": row.mode,
"amount_minor": row.amount_minor,
"currency": row.currency,
"received_at": _iso(row.received_at),
"recorded_at": _iso(row.recorded_at),
},
row.recorded_at,
)
def _event_attribution(row: PaymentEvent) -> DsarRecordRef:
return _attribution_record(
"payment_event_attribution",
row.id,
"Payment lifecycle event attribution",
{
"activity": "recorded_payment_event",
"payment_row_id": row.payment_row_id,
"event_id": row.event_id,
"event_type": row.event_type,
"status": row.status,
"occurred_at": _iso(row.occurred_at),
},
row.occurred_at,
)
def _attribution_record(
resource_type: str,
resource_id: str,
title: str,
data: Mapping[str, object],
observed_at: datetime,
) -> DsarRecordRef:
return DsarRecordRef(
provider_id="payments",
module_id="payments",
resource_type=resource_type,
resource_id=resource_id,
category="operator_accountability_evidence",
title=title,
data=data,
observed_at=_aware(observed_at),
immutable_evidence=True,
retention_reason=(
"Payment operator attribution is financial accountability evidence; "
"arbitrary metadata, hashes, replay keys, and payloads are excluded."
),
)
def _context_refs(value: object) -> dict[str, str]:
if not isinstance(value, Mapping) or len(value) > 100:
raise ValueError("Payment context references exceed the DSAR bound.")
result: dict[str, str] = {}
for raw_key, raw_value in value.items():
key = str(raw_key)
if not key or len(key) > 200:
raise ValueError("Payment context reference key is invalid.")
result[key] = "[redacted]" if _sensitive_key(key) else str(raw_value)[:2_000]
return result
def _evidence_reference(value: object) -> dict[str, object]:
if not isinstance(value, Mapping):
raise ValueError("Payment evidence reference is invalid.")
derived = value.get("derived_from")
if not isinstance(derived, list) or len(derived) > 100:
raise ValueError("Payment evidence derivation exceeds the DSAR bound.")
return {
"kind": _bounded(value.get("kind"), 100),
"owner_module": _bounded(value.get("owner_module"), 100),
"evidence_id": _bounded(value.get("evidence_id"), 255),
"tenant_id": _bounded(value.get("tenant_id"), 36),
"version": _bounded(value.get("version"), 255),
"checksum": _bounded(value.get("checksum"), 255),
"source_ref": _bounded(value.get("source_ref"), 2_000),
"derived_from": [_bounded(item, 2_000) for item in derived],
"responsible_actor_ref": _bounded(
value.get("responsible_actor_ref"),
255,
),
"captured_at": _bounded(value.get("captured_at"), 100),
}
def _bounded(value: object, limit: int) -> str | None:
return str(value)[:limit] if value is not None else None
def _sensitive_key(value: str) -> bool:
normalized = value.strip().casefold().replace("-", "_")
return any(
part in normalized
for part in (
"authorization",
"cookie",
"credential",
"password",
"secret",
"token",
)
)
def _iso(value: datetime | None) -> str | None:
aware = _aware(value)
return aware.isoformat() if aware else None
def _aware(value: datetime | None) -> datetime | None:
if value is None or value.tzinfo is not None:
return value
return value.replace(tzinfo=timezone.utc)
def _session(value: object) -> Session:
if not isinstance(value, Session):
raise TypeError("Payments DSAR requires a SQLAlchemy Session.")
return value
def _validate_record(record: DsarRecordRef) -> None:
if record.provider_id != "payments" or record.module_id != "payments":
raise ValueError("Payments DSAR cannot plan a foreign provider record.")
if record.resource_type not in {"payment_obligation"} | _ATTRIBUTION_TYPES:
raise ValueError("Payments DSAR record type is invalid.")
if not record.resource_id:
raise ValueError("Payments DSAR record identity is incomplete.")
def _validate_action(action: DsarErasureActionRef) -> None:
if action.provider_id != "payments" or action.module_id != "payments":
raise ValueError("Payments DSAR cannot execute a foreign provider action.")
if not action.action_id.startswith("payments:"):
raise ValueError("Payments DSAR action identity is invalid.")
__all__ = ["PAYMENTS_DSAR_CAPABILITY", "PaymentsDsarProvider"]
+286 -4
View File
@@ -8,25 +8,35 @@ from govoplan_core.core.module_guards import (
)
from govoplan_core.core.modules import (
CapabilityDocumentation,
DocumentationCondition,
DocumentationLink,
DocumentationTopic,
FrontendModule,
FrontendRoute,
MigrationSpec,
ModuleContext,
ModuleInterfaceProvider,
ModuleManifest,
NavItem,
PermissionDefinition,
ProductAreaContribution,
RoleTemplate,
)
from govoplan_core.core.payments import CAPABILITY_PAYMENT_REQUESTS
from govoplan_core.core.provider_governance import declared_module_architecture
from govoplan_core.core.views import ViewSurface
from govoplan_core.db.base import Base
from govoplan_payments.backend.db import models as payment_models
from govoplan_payments.backend.dsar_provider import (
PAYMENTS_DSAR_CAPABILITY,
PaymentsDsarProvider,
)
from govoplan_payments.backend.service import SqlPaymentRequestProvider
MODULE_ID = "payments"
MODULE_NAME = "Payments"
MODULE_VERSION = "0.1.19"
MODULE_VERSION = "0.1.22"
READ_SCOPE = "payments:payment:read"
WRITE_SCOPE = "payments:payment:write"
RECONCILE_SCOPE = "payments:payment:reconcile"
@@ -57,6 +67,10 @@ def _payment_requests(_context: ModuleContext) -> SqlPaymentRequestProvider:
return SqlPaymentRequestProvider()
def _dsar_provider(_context: ModuleContext) -> PaymentsDsarProvider:
return PaymentsDsarProvider()
def _tenant_summary(session: object, tenant_id: str) -> dict[str, int]:
if not hasattr(session, "query"):
return {"payment_requests": 0, "paid_payments": 0, "reconciliations": 0}
@@ -122,16 +136,90 @@ manifest = ModuleManifest(
permissions=(READ_SCOPE,),
),
),
nav_items=(
NavItem(
path="/payments",
label="Payments",
icon="landmark",
required_any=(READ_SCOPE,),
order=73,
surface_id="payments.navigation",
),
),
frontend=FrontendModule(
module_id=MODULE_ID,
package_name="@govoplan/payments-webui",
routes=(
FrontendRoute(
path="/payments",
component="PaymentsPage",
required_any=(READ_SCOPE,),
order=73,
surface_id="payments.workspace",
),
),
nav_items=(
NavItem(
path="/payments",
label="Payments",
icon="landmark",
required_any=(READ_SCOPE,),
order=73,
surface_id="payments.navigation",
),
),
product_areas=(
ProductAreaContribution(
id="services-cases",
module_id=MODULE_ID,
label="i18n:govoplan-core.product_area.services_cases",
icon="landmark",
description="i18n:govoplan-core.product_area.services_cases_description",
surface_ids=("payments.navigation", "payments.workspace"),
order=20,
),
),
view_surfaces=(
ViewSurface(
id="payments.request.create",
module_id=MODULE_ID,
kind="section",
label="Create payment request",
parent_id="payments.workspace",
order=30,
),
ViewSurface(
id="payments.reconciliation.manual",
module_id=MODULE_ID,
kind="section",
label="Record manual payment",
parent_id="payments.workspace",
order=40,
),
),
),
provides_interfaces=(
ModuleInterfaceProvider(name=CAPABILITY_PAYMENT_REQUESTS, version="1.0.0"),
ModuleInterfaceProvider(name=PAYMENTS_DSAR_CAPABILITY, version="0.1.0"),
),
capability_factories={CAPABILITY_PAYMENT_REQUESTS: _payment_requests},
capability_factories={
CAPABILITY_PAYMENT_REQUESTS: _payment_requests,
PAYMENTS_DSAR_CAPABILITY: _dsar_provider,
},
capability_documentation={
CAPABILITY_PAYMENT_REQUESTS: CapabilityDocumentation(
label="Payment request and reconciliation",
summary="Creates replay-safe obligations and records exact, evidence-bound manual settlement.",
contract_version="1.0.0",
),
PAYMENTS_DSAR_CAPABILITY: CapabilityDocumentation(
label="Payments data-subject request provider",
summary=(
"Exports exact verified payment evidence or minimized operator "
"attribution with retain-only erasure outcomes."
),
contract_version="0.1.0",
),
},
route_factory=_router,
migration_spec=MigrationSpec(
@@ -160,6 +248,101 @@ manifest = ModuleManifest(
),
tenant_summary_providers=(_tenant_summary,),
documentation=(
DocumentationTopic(
id="payments.data-subject-requests",
title="Payment data-subject requests",
summary=(
"Export exact payment obligations and financial evidence without "
"using payment descriptions as an identity search surface."
),
body=(
"Payments has no resident or applicant identity column and does not "
"search payment subjects, context JSON, metadata, or source records "
"for a person. Full financial access therefore requires an exact "
"payment row id, payment id, or human payment reference supplied as "
"a verified external subject reference. The resulting package contains "
"the obligation amount, currency, subject, status, dates, source and "
"bounded context references, reconciliation facts and typed evidence "
"references, and lifecycle-event facts. Reconciliation metadata, event "
"payloads, hashes, replay keys, provider data, inspection URLs, and "
"credentials are excluded. A request containing only an account, "
"membership, identity, or exact actor reference receives minimized "
"request, reconciliation, and event attribution for that operator; it "
"does not expose payment subjects. Every result is exact-tenant and "
"bounded. All erasure actions are retain-only and non-executable because "
"obligations, settlements, evidence links, and lifecycle attribution "
"remain governed financial and statutory evidence."
),
layer="configured",
documentation_types=("admin", "user"),
audience=("data_subject", "operator", "auditor", "module_admin"),
related_modules=("core", "cases", "workflow_engine", "ledger"),
metadata={
"kind": "reference",
"help_contexts": [
"payments.workspace",
"payments.state.requested",
"payments.state.paid",
"privacy.data-subject-requests",
],
"consequence_classes": {
"export_exact_payment": (
"Returns the obligation and bounded financial evidence for a "
"verified exact payment identifier."
),
"export_operator_attribution": (
"Returns minimized financial activity, never arbitrary payment "
"content."
),
"retain_payment_evidence": (
"Keeps financial evidence under configured statutory retention "
"and legal hold."
),
},
},
translations={
"de": {
"title": "Datenschutzanfragen zu Zahlungen",
"summary": (
"Exakte Zahlungsverpflichtungen und Finanznachweise exportieren, ohne "
"Zahlungsbeschreibungen als Identitätssuchfläche zu verwenden."
),
"body": (
"Payments besitzt keine Spalte für Einwohner- oder Antragstelleridentitäten und "
"durchsucht weder Zahlungsbetreffe noch Kontext-JSON, Metadaten oder Quelldatensätze "
"nach einer Person. Eine vollständige Finanzauskunft erfordert deshalb eine exakte "
"Zahlungszeilenkennung, Zahlungskennung oder menschenlesbare Zahlungsreferenz, die als "
"verifizierte externe Betroffenenreferenz bereitgestellt wird. Das Auskunftspaket enthält "
"Verpflichtungsbetrag, Währung, Betreff, Status, Zeitpunkte, Quell- und begrenzte "
"Kontextreferenzen, Abstimmungsfakten, typisierte Nachweisreferenzen und Fakten zu "
"Lebenszyklusereignissen. Abstimmungsmetadaten, Ereignisinhalte, Prüfsummen, "
"Wiederholungsschlüssel, Anbieterdaten, Prüf-URLs und Zugangsdaten bleiben ausgeschlossen. "
"Eine Anfrage nur mit Konto-, Mitgliedschafts-, Identitäts- oder exakter Akteursreferenz "
"liefert minimierte Zuschreibungen zu Anforderung, Abstimmung und Ereignissen dieser "
"bearbeitenden Person; Zahlungsbetreffe werden nicht offengelegt. Jedes Ergebnis ist exakt "
"mandantenbegrenzt. Alle Löschaktionen sind reine Aufbewahrungsergebnisse und nicht "
"ausführbar, weil Verpflichtungen, Erfüllungen, Nachweisverknüpfungen und "
"Lebenszykluszuschreibungen gesteuerte finanzielle und gesetzliche Nachweise bleiben."
),
}
},
structured_translation_version="1",
structured_translations={
"de": {
"consequence_classes": {
"export_exact_payment": (
"Gibt Verpflichtung und begrenzte Finanznachweise für eine verifizierte exakte Zahlungskennung zurück."
),
"export_operator_attribution": (
"Gibt minimierte Finanzaktivität, aber niemals beliebige Zahlungsinhalte zurück."
),
"retain_payment_evidence": (
"Bewahrt Finanznachweise gemäß konfigurierter gesetzlicher Aufbewahrung und Sperre auf."
),
}
}
},
),
DocumentationTopic(
id="payments.requests-and-reconciliation",
title="Payment requests and manual reconciliation",
@@ -167,12 +350,15 @@ manifest = ModuleManifest(
body=(
"Payments owns the tenant-bound payment ID, human payment reference, requested amount and currency, lifecycle events, and reconciliation evidence. "
"A Case, Workflow, or other procedure calls the payments.requests capability with its own source reference and a replay key; it keeps the returned payment ID instead of writing Payments tables. "
"The first supported receipt path is manual reconciliation of a full payment. The operator must record the exact amount and currency, external transaction reference, received time, and a same-tenant EvidenceReference carrying a version or checksum. A mismatch, duplicate settlement under another key, cross-tenant evidence, partial amount, or timezone-free timestamp fails closed. "
"The Payments workspace lists requested and paid obligations with source, due or settled times, and reconciliation evidence. A writer creates a request through the guided dialog; a reconciler uses the separate consequential dialog, which fixes the amount and currency and requires an external transaction reference plus a same-tenant versioned or checksum-bound EvidenceReference. Reload preserves loaded data and marks it stale when refresh fails. Missing create or reconciliation authority remains visible with the required permission and responsible administrator. "
"The first supported receipt path is manual reconciliation of a full payment. A mismatch, duplicate settlement under another key, cross-tenant evidence, partial amount, or timezone-free timestamp fails closed. "
"Successful requests and reconciliations append payment events and API actions add audit evidence when Audit is installed. There is no silent correction: reversal, refund, partial payment, online checkout, provider callbacks, Ledger posting, and XRechnung remain explicit future flows."
),
layer="configured",
documentation_types=("admin", "user"),
audience=("operator", "module_admin", "auditor", "product_owner"),
conditions=(DocumentationCondition(required_scopes=(READ_SCOPE,)),),
related_modules=("cases", "workflow_engine", "audit", "ledger"),
links=(
DocumentationLink(
label="Payments boundary and recovery",
@@ -181,12 +367,35 @@ manifest = ModuleManifest(
),
),
metadata={
"kind": "workflow",
"help_contexts": [
"payments.request",
"payments.workspace",
"payments.request.create",
"payments.reconciliation.manual",
"payments.state.requested",
"payments.state.paid",
],
"purpose": (
"Create an exact payment obligation and reconcile it as paid only against matching immutable evidence."
),
"prerequisites": [
"The actor can read Payments; creating and reconciling require their dedicated scopes.",
"The source procedure supplies a stable same-tenant reference and a replay-safe request key.",
"Manual reconciliation has a same-tenant versioned or checksum-bound evidence reference.",
],
"steps": [
"Create the amount, currency, source reference, due date, and human payment reference in the guided dialog.",
"Retain the returned payment ID in the calling Case or Workflow instead of writing Payments tables.",
"Reload the obligation before reconciliation when the workspace reports stale data.",
"Provide the external transaction reference, exact settlement time, and immutable evidence reference.",
"Confirm full amount and currency; any mismatch, duplicate, partial amount, or cross-tenant evidence fails closed.",
"Review the appended lifecycle and audit evidence after the obligation becomes paid.",
],
"limitations": [
"Only full manual reconciliation is supported; partial payment, refund, reversal, and correction need future governed flows.",
"Online checkout, callbacks, Ledger posting, XRechnung, and an applicant payment page are not implemented here.",
],
"privacy_notes": [
"Procedure context uses stable references; applicant names, bank account details, and submitted form values are not required.",
"The immutable evidence remains owned by its provider; Payments stores only the typed EvidenceReference.",
@@ -195,6 +404,79 @@ manifest = ModuleManifest(
"request_payment": "Creates a durable amount/currency obligation and a stable applicant payment reference.",
"reconcile_manual": "Marks the exact obligation paid and appends evidence; a future governed adjustment is required to reverse it.",
},
"verification": [
"The paid obligation retains the original amount, currency, payment ID, and human reference unchanged.",
"Reconciliation names the external transaction and immutable evidence reference.",
"Replay and duplicate checks prove that one external settlement did not create conflicting paid states.",
],
},
translations={
"de": {
"title": "Zahlungsanforderungen und manuelle Abstimmung",
"summary": (
"Eine exakte Verpflichtung anlegen und nur mit passendem unveränderlichem "
"Nachweis als bezahlt kennzeichnen."
),
"body": (
"Payments führt die mandantengebundene Zahlungskennung, die menschenlesbare "
"Zahlungsreferenz, angeforderten Betrag und Währung, Lebenszyklusereignisse und "
"Abstimmungsnachweise. Ein Case, Workflow oder anderes Verfahren ruft die Fähigkeit "
"payments.requests mit eigener Quellreferenz und Wiederholungsschlüssel auf und bewahrt "
"die zurückgegebene Zahlungskennung auf, statt Payments-Tabellen zu schreiben. Der "
"Arbeitsbereich zeigt angeforderte und bezahlte Verpflichtungen mit Quelle, Fälligkeit "
"oder Erfüllungszeit und Abstimmungsnachweis. Schreibberechtigte legen eine Anforderung im "
"geführten Dialog an. Abstimmungsberechtigte verwenden den getrennten folgenreichen Dialog, "
"der Betrag und Währung fixiert und eine externe Transaktionsreferenz sowie eine "
"mandantengleiche versionierte oder prüfsummengebundene EvidenceReference verlangt. Neu "
"laden erhält vorhandene Daten und kennzeichnet sie als veraltet, wenn die Aktualisierung "
"scheitert. Fehlende Anlege- oder Abstimmungsberechtigung bleibt mit erforderlicher "
"Berechtigung und zuständiger Administration sichtbar. Der erste unterstützte Zahlungseingang "
"ist die manuelle Abstimmung einer vollständigen Zahlung. Abweichung, doppelte Erfüllung unter "
"anderem Schlüssel, mandantenfremder Nachweis, Teilbetrag oder Zeitstempel ohne Zeitzone "
"scheitert geschlossen. Erfolgreiche Anforderungen und Abstimmungen fügen "
"Zahlungsereignisse an; API-Aktionen erzeugen bei installiertem Audit Nachweise. Es gibt keine "
"stille Korrektur: Storno, Erstattung, Teilzahlung, Online-Checkout, Anbieter-Callbacks, "
"Ledger-Buchung und XRechnung bleiben ausdrückliche zukünftige Abläufe."
),
}
},
structured_translation_version="1",
structured_translations={
"de": {
"purpose": (
"Eine exakte Zahlungsverpflichtung anlegen und nur anhand passender unveränderlicher Nachweise als bezahlt abstimmen."
),
"prerequisites": [
"Die handelnde Person darf Payments lesen; Anlegen und Abstimmen erfordern ihre jeweils eigenen Berechtigungen.",
"Das Quellverfahren liefert eine stabile mandantengleiche Referenz und einen wiederholungssicheren Anforderungsschlüssel.",
"Für die manuelle Abstimmung liegt eine mandantengleiche versionierte oder prüfsummengebundene Nachweisreferenz vor.",
],
"steps": [
"Betrag, Währung, Quellreferenz, Fälligkeit und menschenlesbare Zahlungsreferenz im geführten Dialog anlegen.",
"Die zurückgegebene Zahlungskennung im aufrufenden Case oder Workflow bewahren, statt Payments-Tabellen zu schreiben.",
"Die Verpflichtung vor der Abstimmung neu laden, wenn der Arbeitsbereich veraltete Daten meldet.",
"Externe Transaktionsreferenz, exakte Erfüllungszeit und unveränderliche Nachweisreferenz angeben.",
"Vollständigen Betrag und Währung bestätigen; Abweichung, Duplikat, Teilbetrag oder mandantenfremder Nachweis scheitert geschlossen.",
"Nach dem Wechsel auf bezahlt die angefügten Lebenszyklus- und Auditnachweise prüfen.",
],
"limitations": [
"Nur vollständige manuelle Abstimmung wird unterstützt; Teilzahlung, Erstattung, Storno und Korrektur benötigen zukünftige gesteuerte Abläufe.",
"Online-Checkout, Callbacks, Ledger-Buchung, XRechnung und eine Antragsteller-Zahlungsseite sind hier nicht implementiert.",
],
"privacy_notes": [
"Verfahrenskontext verwendet stabile Referenzen; Namen von Antragstellern, Bankverbindungen und übermittelte Formularwerte sind nicht erforderlich.",
"Der unveränderliche Nachweis bleibt Eigentum seines Anbieters; Payments speichert nur die typisierte EvidenceReference.",
],
"consequence_classes": {
"request_payment": "Erzeugt eine dauerhafte Betrags- und Währungsverpflichtung sowie eine stabile Zahlungsreferenz für Antragsteller.",
"reconcile_manual": "Kennzeichnet die exakte Verpflichtung als bezahlt und fügt Nachweise an; eine zukünftige gesteuerte Anpassung ist zur Umkehr erforderlich.",
},
"verification": [
"Die bezahlte Verpflichtung bewahrt ursprünglichen Betrag, Währung, Zahlungskennung und menschenlesbare Referenz unverändert.",
"Die Abstimmung nennt externe Transaktion und unveränderliche Nachweisreferenz.",
"Wiederholungs- und Duplikatprüfungen belegen, dass eine externe Erfüllung keine widersprüchlichen Bezahltzustände erzeugt hat.",
],
}
},
),
),
@@ -206,7 +488,7 @@ manifest = ModuleManifest(
test_ref="tests/test_payments.py",
known_limits=(
"Only full manual payment reconciliation is implemented; partial payments, refunds, reversals, and corrections need explicit governed flows.",
"No online payment provider, callback, ledger posting, XRechnung, applicant payment page, or dedicated operator WebUI is included yet.",
"No online payment provider, callback, ledger posting, XRechnung, or applicant payment page is included yet; the operator workspace covers fixed requests and full manual reconciliation only.",
),
supported_authority_modes=("native_authoritative",),
owned_concepts=(
+31
View File
@@ -0,0 +1,31 @@
from __future__ import annotations
import unittest
from govoplan_core.core.modules import (
documentation_structured_translation_issues,
user_workflow_scope_condition_issues,
)
from govoplan_payments.backend.manifest import manifest
class PaymentsDocumentationTests(unittest.TestCase):
def test_public_topics_have_complete_german_reference_content(self) -> None:
self.assertEqual(2, len(manifest.documentation))
for topic in manifest.documentation:
translation = topic.translations.get("de", {})
self.assertTrue(
all(translation.get(key) for key in ("title", "summary", "body"))
)
self.assertEqual((), documentation_structured_translation_issues(topic))
def test_documentation_has_scope_conditioned_workflow_and_reference(self) -> None:
kinds = {topic.metadata.get("kind") for topic in manifest.documentation}
self.assertIn("workflow", kinds)
self.assertIn("reference", kinds)
for topic in manifest.documentation:
self.assertEqual((), user_workflow_scope_condition_issues(topic))
if __name__ == "__main__":
unittest.main()
+418
View File
@@ -0,0 +1,418 @@
from __future__ import annotations
import json
import unittest
from datetime import UTC, datetime
from sqlalchemy import create_engine
from sqlalchemy.orm import Session
from govoplan_core.core.dsar import (
DsarErasureActionRef,
DsarProvider,
DsarRecordRef,
DsarSubjectRef,
)
from govoplan_core.db.base import Base
from govoplan_core.privacy.dsar_workflow import (
create_data_subject_request,
search_data_subject_request,
)
from govoplan_payments.backend.db.models import (
PaymentEvent,
PaymentObligation,
PaymentReconciliation,
)
from govoplan_payments.backend.dsar_provider import (
PAYMENTS_DSAR_CAPABILITY,
PaymentsDsarProvider,
)
from govoplan_payments.backend.manifest import manifest
NOW = datetime(2026, 8, 21, 10, 0, tzinfo=UTC)
class _Registry:
def __init__(self, provider: PaymentsDsarProvider, *, active: bool = True) -> None:
self.provider = provider
self.active = active
def capability_names(self):
return (PAYMENTS_DSAR_CAPABILITY,)
def capability_owner(self, name):
self._assert_capability(name)
return "payments"
def tenant_entitlement_resolver(self):
active = self.active
class _Resolver:
@staticmethod
def resolve(session, tenant_id):
del session, tenant_id
return type(
"State",
(),
{"effective_modules": ("payments",) if active else ()},
)()
return _Resolver()
def require_tenant_capability(self, name, session, **kwargs):
del session, kwargs
self._assert_capability(name)
return self.provider
def manifests(self):
return (type("Manifest", (), {"id": "payments"})(),)
@staticmethod
def _assert_capability(name: str) -> None:
if name != PAYMENTS_DSAR_CAPABILITY:
raise KeyError(name)
class PaymentsDsarProviderTests(unittest.TestCase):
def setUp(self) -> None:
self.engine = create_engine("sqlite+pysqlite:///:memory:")
Base.metadata.create_all(self.engine)
self.session = Session(self.engine)
self.provider = PaymentsDsarProvider()
self.assertIsInstance(self.provider, DsarProvider)
self._seed()
self.session.commit()
def tearDown(self) -> None:
self.session.close()
self.engine.dispose()
def _obligation(
self,
row_id: str,
*,
tenant_id: str = "tenant-1",
payment_id: str,
payment_reference: str,
requested_by_ref: str,
subject: str,
) -> PaymentObligation:
return PaymentObligation(
id=row_id,
tenant_id=tenant_id,
payment_id=payment_id,
payment_reference=payment_reference,
source_module="cases",
source_resource_type="case",
source_resource_id=f"case-{row_id}",
amount_minor=12_500,
currency="EUR",
subject=subject,
status="paid",
idempotency_key=f"idempotency-{row_id}-do-not-export",
request_sha256="a" * 64,
requested_at=NOW,
requested_by_ref=requested_by_ref,
settled_at=NOW,
context_refs={
"service": "resident-permit",
"access_token": "payment-secret-do-not-export",
},
details={"private": "obligation-metadata-do-not-export"},
)
def _seed(self) -> None:
subject_payment = self._obligation(
"payment-row-1",
payment_id="payment-1",
payment_reference="PAY-0001",
requested_by_ref="account:account-1",
subject="Resident permit fee",
)
other_payment = self._obligation(
"payment-row-other",
payment_id="payment-other",
payment_reference="PAY-OTHER",
requested_by_ref="account:account-other",
subject="Other person's private payment",
)
other_tenant = self._obligation(
"payment-row-other-tenant",
tenant_id="tenant-2",
payment_id="payment-other-tenant",
payment_reference="PAY-TENANT-2",
requested_by_ref="account:account-1",
subject="Other tenant private payment",
)
self.session.add_all((subject_payment, other_payment, other_tenant))
self.session.flush()
self.session.add_all(
(
PaymentReconciliation(
id="reconciliation-1",
tenant_id="tenant-1",
reconciliation_id="reconciliation-command-1",
payment_row_id="payment-row-1",
mode="manual_full",
amount_minor=12_500,
currency="EUR",
transaction_reference="BANK-REFERENCE-1",
evidence_ref={
"kind": "record",
"owner_module": "records",
"evidence_id": "record-1",
"tenant_id": "tenant-1",
"version": "4",
"checksum": "b" * 64,
"source_ref": "records:record-1:v4",
"derived_from": ["bank-statement-1"],
"responsible_actor_ref": "account:account-1",
"captured_at": NOW.isoformat(),
"inspection_url": "/records/record-1",
},
idempotency_key="reconcile-key-do-not-export",
request_sha256="c" * 64,
received_at=NOW,
recorded_at=NOW,
recorded_by_ref="account:account-1",
details={"private": "reconciliation-metadata-do-not-export"},
),
PaymentEvent(
id="event-1",
tenant_id="tenant-1",
event_id="payment-event-1",
payment_row_id="payment-row-1",
event_type="payment.reconciled",
status="paid",
occurred_at=NOW,
actor_ref="account:account-1",
payload={"secret": "event-payload-do-not-export"},
),
PaymentEvent(
id="event-other",
tenant_id="tenant-1",
event_id="payment-event-other",
payment_row_id="payment-row-other",
event_type="payment.requested",
status="requested",
occurred_at=NOW,
actor_ref="account:account-other",
payload={"private": "other event"},
),
)
)
def test_exact_payment_reference_exports_bounded_financial_evidence(self) -> None:
records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
external_references={"payments.reference": "PAY-0001"}
),
)
self.assertEqual(["payment-row-1"], [record.resource_id for record in records])
exported = json.dumps([record.to_dict() for record in records])
self.assertIn("Resident permit fee", exported)
self.assertIn("BANK-REFERENCE-1", exported)
self.assertIn("records:record-1:v4", exported)
self.assertIn("payment.reconciled", exported)
self.assertIn("[redacted]", exported)
for excluded in (
"payment-secret-do-not-export",
"obligation-metadata-do-not-export",
"reconciliation-metadata-do-not-export",
"event-payload-do-not-export",
"idempotency-payment-row-1-do-not-export",
"reconcile-key-do-not-export",
"inspection_url",
"Other person's private payment",
"Other tenant private payment",
):
self.assertNotIn(excluded, exported)
def test_actor_search_is_minimized_and_does_not_expose_subject(self) -> None:
records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(account_id="account-1"),
)
self.assertEqual(
{
"payment_request_attribution",
"payment_reconciliation_attribution",
"payment_event_attribution",
},
{record.resource_type for record in records},
)
exported = json.dumps([record.to_dict() for record in records])
self.assertIn("PAY-0001", exported)
self.assertIn("recorded_payment_reconciliation", exported)
self.assertNotIn("Resident permit fee", exported)
self.assertNotIn("BANK-REFERENCE-1", exported)
self.assertNotIn("Other person's private payment", exported)
self.assertNotIn("Other tenant private payment", exported)
def test_identifiers_corroborate_and_alias_conflicts_fail_closed(self) -> None:
corroborated = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
external_references={
"payments.payment": "payment-1",
"payments.reference": "PAY-0001",
}
),
)
mismatched = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
external_references={
"payments.payment": "payment-1",
"payments.reference": "PAY-OTHER",
}
),
)
conflict = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
account_id="account-1",
external_references={"payments.account": "account-other"},
),
)
self.assertEqual(["payment-row-1"], [item.resource_id for item in corroborated])
self.assertEqual((), mismatched)
self.assertEqual((), conflict)
def test_erasure_is_retain_only_and_foreign_inputs_are_rejected(self) -> None:
subject = DsarSubjectRef(external_references={"payments.reference": "PAY-0001"})
records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=subject,
)
actions = self.provider.plan_erasure(
self.session,
tenant_id="tenant-1",
subject=subject,
records=records,
)
self.assertTrue(all(action.kind == "retain" for action in actions))
self.assertTrue(all(not action.executable for action in actions))
results = self.provider.execute_erasure(
self.session,
tenant_id="tenant-1",
subject=subject,
actions=actions,
request_id="dsar-1",
)
self.assertTrue(all(result.status == "blocked" for result in results))
self.assertIsNotNone(self.session.get(PaymentObligation, "payment-row-1"))
with self.assertRaisesRegex(ValueError, "foreign provider record"):
self.provider.plan_erasure(
self.session,
tenant_id="tenant-1",
subject=subject,
records=(
DsarRecordRef(
provider_id="ledger",
module_id="ledger",
resource_type="payment_obligation",
resource_id="payment-row-1",
category="financial",
title="Foreign payment",
),
),
)
with self.assertRaisesRegex(ValueError, "foreign provider action"):
self.provider.execute_erasure(
self.session,
tenant_id="tenant-1",
subject=subject,
actions=(
DsarErasureActionRef(
action_id="ledger:retain:payment:payment-row-1",
provider_id="ledger",
module_id="ledger",
kind="retain",
resource_type="payment_obligation",
resource_id="payment-row-1",
title="Retain payment",
rationale="Financial evidence",
executable=False,
),
),
request_id="dsar-1",
)
def test_core_workflow_and_manifest_register_provider(self) -> None:
subject = DsarSubjectRef(external_references={"payments.reference": "PAY-0001"})
row = create_data_subject_request(
self.session,
tenant_id="tenant-1",
reference="DSAR-PAYMENTS-1",
request_kind="access",
subject=subject,
purpose="Respond to a verified request.",
legal_basis="Article 15 GDPR",
due_at=None,
requested_by_account_id="privacy-officer",
)
self.session.commit()
search_data_subject_request(
self.session,
registry=_Registry(self.provider),
row=row,
expected_revision=1,
)
self.assertEqual(
[PAYMENTS_DSAR_CAPABILITY], row.coverage["provider_capabilities"]
)
self.assertEqual(1, row.search_result["record_count"])
inactive = create_data_subject_request(
self.session,
tenant_id="tenant-1",
reference="DSAR-PAYMENTS-2",
request_kind="access",
subject=subject,
purpose="Respond to a verified request.",
legal_basis="Article 15 GDPR",
due_at=None,
requested_by_account_id="privacy-officer",
)
self.session.commit()
search_data_subject_request(
self.session,
registry=_Registry(self.provider, active=False),
row=inactive,
expected_revision=1,
)
self.assertEqual(
[PAYMENTS_DSAR_CAPABILITY],
inactive.coverage["inactive_provider_capabilities"],
)
self.assertIn(PAYMENTS_DSAR_CAPABILITY, manifest.capability_factories)
self.assertIn(PAYMENTS_DSAR_CAPABILITY, manifest.capability_documentation)
self.assertIn(
PAYMENTS_DSAR_CAPABILITY,
{item.name for item in manifest.provides_interfaces},
)
self.assertTrue(
any(
topic.id == "payments.data-subject-requests"
and {"admin", "user"}.issubset(topic.documentation_types)
for topic in manifest.documentation
)
)
if __name__ == "__main__":
unittest.main()
+17
View File
@@ -1,6 +1,8 @@
from __future__ import annotations
from datetime import UTC, datetime, timedelta
from pathlib import Path
import tomllib
import unittest
from sqlalchemy import create_engine
@@ -21,6 +23,7 @@ from govoplan_payments.backend.service import (
PaymentError,
SqlPaymentRequestProvider,
)
from govoplan_payments.backend.manifest import manifest
NOW = datetime(2026, 8, 19, 10, 0, tzinfo=UTC)
@@ -199,6 +202,20 @@ class PaymentTests(unittest.TestCase):
self.assertEqual(1, len(requested))
self.assertEqual((), self.provider.list_payments(self.session, tenant_id="tenant-2"))
def test_manifest_exposes_permission_bounded_operator_workspace(self) -> None:
project = tomllib.loads((Path(__file__).parents[1] / "pyproject.toml").read_text())
self.assertEqual(project["project"]["version"], manifest.version)
self.assertIsNotNone(manifest.frontend)
assert manifest.frontend is not None
self.assertEqual("@govoplan/payments-webui", manifest.frontend.package_name)
self.assertEqual("/payments", manifest.frontend.routes[0].path)
self.assertEqual(("payments:payment:read",), manifest.frontend.routes[0].required_any)
self.assertEqual("payments.workspace", manifest.frontend.routes[0].surface_id)
self.assertEqual("payments.navigation", manifest.frontend.nav_items[0].surface_id)
surface_ids = {surface.id for surface in manifest.frontend.view_surfaces}
self.assertIn("payments.request.create", surface_ids)
self.assertIn("payments.reconciliation.manual", surface_ids)
if __name__ == "__main__":
unittest.main()
+31
View File
@@ -0,0 +1,31 @@
{
"name": "@govoplan/payments-webui",
"version": "0.1.22",
"private": true,
"type": "module",
"main": "src/index.ts",
"module": "src/index.ts",
"types": "src/index.ts",
"exports": {
".": {
"types": "./src/index.ts",
"import": "./src/index.ts"
},
"./styles/payments.css": "./src/styles/payments.css"
},
"scripts": {
"test:interface-pattern": "node scripts/test-interface-pattern.mjs"
},
"peerDependencies": {
"@govoplan/core-webui": "^0.1.18",
"lucide-react": "^1.23.0",
"react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20",
"react-router": ">=8.3.0 <9"
},
"peerDependenciesMeta": {
"@govoplan/core-webui": {
"optional": true
}
}
}
+33
View File
@@ -0,0 +1,33 @@
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import { resolve } from "node:path";
import { fileURLToPath } from "node:url";
const root = resolve(fileURLToPath(new URL("..", import.meta.url)));
const read = (path) => readFileSync(resolve(root, path), "utf8");
const page = read("src/features/payments/PaymentsPage.tsx");
const createDialog = read("src/features/payments/PaymentRequestDialog.tsx");
const reconcileDialog = read("src/features/payments/ManualReconciliationDialog.tsx");
const styles = read("src/styles/payments.css");
assert.match(page, /<WorkspaceFrame/, "Payments uses the central full-height module frame");
assert.match(page, /<PageLayout/, "Payments uses the central headed page frame");
assert.match(page, /<PageActionBar[\s\S]*variant="collection"/, "Payments declares the collection action archetype");
assert.match(page, /reloadAction=/, "Payments provides the required reload slot");
assert.match(page, /createAction=/, "Payments provides the far-right create slot");
assert.match(page, /<MetricGrid/, "Payments summary geometry is centralized");
assert.match(page, /<FilterBar/, "Payments filters use the central bar");
assert.match(page, /<DataGrid/, "Payments rows use the central data grid");
assert.match(page, /<TableActionGroup/, "Payments keeps one stable ordered row action set");
assert.match(page, /disabledReason=/, "permission and state blockers remain actionable");
assert.match(page, /stale/, "refresh failures retain explicit stale-data state");
assert.match(createDialog, /<Dialog[\s\S]*<DialogForm/, "request creation composes central dialog anatomy");
assert.match(createDialog, /useUnsavedDraftGuard/, "request drafts use the shared discard guard");
assert.match(createDialog, /idempotency_key/, "request creation exposes replay protection");
assert.match(reconcileDialog, /<DescriptionList/, "reconciliation presents exact immutable facts semantically");
assert.match(reconcileDialog, /version[\s\S]*checksum/, "reconciliation captures immutable evidence binding");
assert.match(reconcileDialog, /useUnsavedDraftGuard/, "reconciliation drafts use the shared discard guard");
assert.doesNotMatch(styles, /\.page-heading|\.action-toolbar|\.dialog-panel|\.data-grid/, "Payments does not redefine shared page, toolbar, dialog, or table anatomy");
assert.doesNotMatch(`${page}\n${createDialog}\n${reconcileDialog}`, /window\.alert|\balert\s*\(/, "Payments does not use global alerts");
console.log("Payments interface-pattern contracts passed.");
+138
View File
@@ -0,0 +1,138 @@
import {
ApiError,
apiFetch,
apiPath,
type ApiSettings
} from "@govoplan/core-webui";
export type PaymentStatus = "requested" | "paid";
export type EvidenceReference = {
kind: string;
owner_module: string;
evidence_id: string;
tenant_id: string;
version?: string | null;
checksum?: string | null;
};
export type PaymentReconciliation = {
reconciliation_id: string;
mode: "manual";
amount_minor: number;
currency: string;
transaction_reference: string;
evidence_ref: EvidenceReference;
received_at: string;
recorded_at: string;
recorded_by_ref: string;
};
export type PaymentEvent = {
event_id: string;
event_type: string;
status: PaymentStatus;
occurred_at: string;
actor_ref: string;
payload: Record<string, unknown>;
};
export type PaymentRequest = {
payment_id: string;
tenant_id: string;
payment_reference: string;
source: {
module: string;
resource_type: string;
resource_id: string;
};
amount_minor: number;
currency: string;
subject: string;
status: PaymentStatus;
requested_at: string;
requested_by_ref: string;
due_at?: string | null;
settled_at?: string | null;
context_refs: Record<string, string>;
metadata: Record<string, unknown>;
reconciliation?: PaymentReconciliation | null;
events: PaymentEvent[];
replayed: boolean;
};
export type PaymentRequestCreate = {
source_module: string;
source_resource_type: string;
source_resource_id: string;
amount_minor: number;
currency: string;
subject: string;
idempotency_key: string;
due_at?: string | null;
context_refs: Record<string, string>;
metadata: Record<string, unknown>;
};
export type ManualPaymentReconciliationCreate = {
amount_minor: number;
currency: string;
transaction_reference: string;
evidence_ref: EvidenceReference;
idempotency_key: string;
received_at: string;
metadata: Record<string, unknown>;
};
export async function listPaymentRequests(
settings: ApiSettings,
filters: { status?: PaymentStatus; sourceResourceId?: string; limit?: number } = {},
signal?: AbortSignal
): Promise<PaymentRequest[]> {
const response = await apiFetch<{ payments: PaymentRequest[] }>(
settings,
apiPath("/api/v1/payments/requests", {
status: filters.status,
source_resource_id: filters.sourceResourceId,
limit: filters.limit ?? 200
}),
{ signal }
);
return response.payments;
}
export function createPaymentRequest(
settings: ApiSettings,
payload: PaymentRequestCreate
): Promise<PaymentRequest> {
return apiFetch<PaymentRequest>(settings, "/api/v1/payments/requests", {
method: "POST",
body: JSON.stringify(payload)
});
}
export function reconcileManualPayment(
settings: ApiSettings,
paymentId: string,
payload: ManualPaymentReconciliationCreate
): Promise<PaymentRequest> {
return apiFetch<PaymentRequest>(
settings,
`/api/v1/payments/requests/${encodeURIComponent(paymentId)}/manual-reconciliations`,
{ method: "POST", body: JSON.stringify(payload) }
);
}
export function paymentApiErrorMessage(reason: unknown): string {
if (reason instanceof ApiError) {
try {
const payload = JSON.parse(reason.body) as { detail?: unknown };
if (typeof payload.detail === "string") return payload.detail;
} catch {
// The response body may be plain text.
}
if (reason.status === 409) return "The payment changed or this replay key is already bound to different evidence. Reload and review the current state.";
if (reason.status === 403) return "Your current role does not permit this payment action.";
}
return reason instanceof Error ? reason.message : String(reason);
}
@@ -0,0 +1,249 @@
import { useEffect, useState, type FormEvent } from "react";
import {
Button,
DateTimeField,
DescriptionItem,
DescriptionList,
Dialog,
DialogForm,
DialogSection,
DismissibleAlert,
FormField,
FormGrid,
useUnsavedChanges,
useUnsavedDraftGuard,
type ApiSettings
} from "@govoplan/core-webui";
import {
paymentApiErrorMessage,
reconcileManualPayment,
type PaymentRequest
} from "../../api/payments";
type ManualReconciliationDialogProps = {
open: boolean;
settings: ApiSettings;
tenantId: string;
payment: PaymentRequest | null;
onClose: () => void;
onReconciled: (payment: PaymentRequest) => void;
};
type ReconciliationDraft = {
transactionReference: string;
receivedAt: string;
evidenceOwnerModule: string;
evidenceKind: string;
evidenceId: string;
evidenceVersion: string;
evidenceChecksum: string;
idempotencyKey: string;
};
const FORM_ID = "payments-manual-reconciliation-form";
function localDateTime(date = new Date()): string {
const local = new Date(date.getTime() - date.getTimezoneOffset() * 60_000);
return local.toISOString().slice(0, 16);
}
function replayKey(): string {
const suffix = globalThis.crypto?.randomUUID?.() ?? `${Date.now()}-${Math.random().toString(16).slice(2)}`;
return `payments-ui-reconciliation-${suffix}`;
}
function emptyDraft(): ReconciliationDraft {
return {
transactionReference: "",
receivedAt: localDateTime(),
evidenceOwnerModule: "files",
evidenceKind: "document",
evidenceId: "",
evidenceVersion: "",
evidenceChecksum: "",
idempotencyKey: replayKey()
};
}
function formatAmount(amountMinor: number, currency: string): string {
try {
return new Intl.NumberFormat(undefined, { style: "currency", currency }).format(amountMinor / 100);
} catch {
return `${(amountMinor / 100).toFixed(2)} ${currency}`;
}
}
export default function ManualReconciliationDialog({
open,
settings,
tenantId,
payment,
onClose,
onReconciled
}: ManualReconciliationDialogProps) {
const [draft, setDraft] = useState<ReconciliationDraft>(emptyDraft);
const [dirty, setDirty] = useState(false);
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
const { requestDiscard } = useUnsavedChanges();
function reset() {
setDraft(emptyDraft());
setDirty(false);
setError("");
}
useEffect(() => {
if (open) reset();
}, [open, payment?.payment_id]);
function change<K extends keyof ReconciliationDraft>(key: K, value: ReconciliationDraft[K]) {
setDraft((current) => ({ ...current, [key]: value }));
setDirty(true);
}
async function submit(): Promise<boolean> {
if (!payment) return false;
if (!draft.transactionReference.trim() || !draft.evidenceOwnerModule.trim() || !draft.evidenceKind.trim() || !draft.evidenceId.trim()) {
setError("Transaction reference and evidence owner, kind, and ID are required.");
return false;
}
if (!draft.evidenceVersion.trim() && !draft.evidenceChecksum.trim()) {
setError("Provide an evidence version or checksum so the receipt evidence is immutable.");
return false;
}
if (!draft.receivedAt) {
setError("Payment received time is required.");
return false;
}
setBusy(true);
setError("");
try {
const reconciled = await reconcileManualPayment(settings, payment.payment_id, {
amount_minor: payment.amount_minor,
currency: payment.currency,
transaction_reference: draft.transactionReference.trim(),
evidence_ref: {
tenant_id: tenantId,
owner_module: draft.evidenceOwnerModule.trim(),
kind: draft.evidenceKind.trim(),
evidence_id: draft.evidenceId.trim(),
version: draft.evidenceVersion.trim() || null,
checksum: draft.evidenceChecksum.trim() || null
},
idempotency_key: draft.idempotencyKey.trim(),
received_at: new Date(draft.receivedAt).toISOString(),
metadata: {}
});
setDirty(false);
onReconciled(reconciled);
return true;
} catch (reason) {
setError(paymentApiErrorMessage(reason));
return false;
} finally {
setBusy(false);
}
}
useUnsavedDraftGuard({
dirty: open && dirty,
title: "Discard the reconciliation draft?",
message: "No payment state has changed yet. Save the exact receipt evidence before leaving or discard this draft.",
onSave: submit,
onDiscard: reset,
enabled: open
});
function close() {
if (busy) return;
if (dirty) requestDiscard(onClose);
else onClose();
}
function handleSubmit(event: FormEvent) {
event.preventDefault();
void submit();
}
return (
<Dialog
open={open}
title="Record manual payment"
description="Confirm a full offline receipt against immutable evidence. Payments rejects any amount or currency mismatch."
size="wide"
closeDisabled={busy}
onClose={close}
interfaceId="payments.reconciliation.manual.dialog"
helpContextId="payments.reconciliation.manual"
helpModuleId="payments"
notices={error ? <DismissibleAlert tone="danger" resetKey={error}>{error}</DismissibleAlert> : null}
footer={(
<>
<Button type="button" onClick={close} disabled={busy}>Cancel</Button>
<Button type="submit" form={FORM_ID} variant="primary" disabled={busy || !payment}>
{busy ? "Recording…" : "Record payment as paid"}
</Button>
</>
)}
>
<DialogForm id={FORM_ID} onSubmit={handleSubmit}>
{payment && (
<DialogSection variant="inset" className="payments-reconciliation-warning">
<h3 className="payments-dialog-section-title">Exact obligation</h3>
<DescriptionList columns={2} density="compact">
<DescriptionItem term="Payment reference">{payment.payment_reference}</DescriptionItem>
<DescriptionItem term="Amount"><span className="payments-readonly-amount">{formatAmount(payment.amount_minor, payment.currency)}</span></DescriptionItem>
<DescriptionItem term="Source">{payment.source.module}:{payment.source.resource_type}:{payment.source.resource_id}</DescriptionItem>
<DescriptionItem term="Current state">Requested</DescriptionItem>
</DescriptionList>
<p className="payments-dialog-copy">This action appends reconciliation evidence and marks the obligation paid. It cannot be silently undone; correction or reversal requires a future governed adjustment flow.</p>
</DialogSection>
)}
<DialogSection variant="separated">
<h3 className="payments-dialog-section-title">Receipt</h3>
<FormGrid columns={2}>
<FormField label="External transaction reference" helpContextId="payments.reconciliation.field.transaction-reference" helpModuleId="payments">
<input required maxLength={255} value={draft.transactionReference} onChange={(event) => change("transactionReference", event.target.value)} />
</FormField>
<FormField label="Payment received date and time">
<DateTimeField required value={draft.receivedAt} onChange={(value) => change("receivedAt", value)} aria-label="Payment received date and time" />
</FormField>
</FormGrid>
</DialogSection>
<DialogSection variant="separated">
<h3 className="payments-dialog-section-title">Immutable evidence</h3>
<p className="payments-dialog-section-copy">Payments stores only this typed reference. The evidence bytes and retention remain with the owning module.</p>
<FormGrid columns={2}>
<FormField label="Evidence owner module">
<input required maxLength={120} value={draft.evidenceOwnerModule} onChange={(event) => change("evidenceOwnerModule", event.target.value)} />
</FormField>
<FormField label="Evidence kind">
<input required maxLength={120} value={draft.evidenceKind} onChange={(event) => change("evidenceKind", event.target.value)} />
</FormField>
<FormField label="Evidence ID">
<input required maxLength={255} value={draft.evidenceId} onChange={(event) => change("evidenceId", event.target.value)} />
</FormField>
<FormField label="Evidence version" help="Provide a version or checksum; both may be supplied.">
<input maxLength={255} value={draft.evidenceVersion} onChange={(event) => change("evidenceVersion", event.target.value)} />
</FormField>
<FormField label="Evidence checksum" help="Provide a checksum or version; both may be supplied.">
<input maxLength={255} value={draft.evidenceChecksum} onChange={(event) => change("evidenceChecksum", event.target.value)} />
</FormField>
</FormGrid>
</DialogSection>
<DialogSection variant="inset">
<h3 className="payments-dialog-section-title">Replay protection</h3>
<p className="payments-dialog-section-copy">Retry this key only for this exact payment and evidence. A changed replay conflicts instead of creating ambiguous settlement evidence.</p>
<FormField label="Idempotency key" helpContextId="payments.reconciliation.field.replay-key" helpModuleId="payments">
<input required maxLength={255} value={draft.idempotencyKey} onChange={(event) => change("idempotencyKey", event.target.value)} />
</FormField>
</DialogSection>
</DialogForm>
</Dialog>
);
}
@@ -0,0 +1,240 @@
import { useEffect, useState, type FormEvent } from "react";
import {
Button,
DateTimeField,
Dialog,
DialogForm,
DialogSection,
DismissibleAlert,
FormField,
FormGrid,
useUnsavedChanges,
useUnsavedDraftGuard,
type ApiSettings
} from "@govoplan/core-webui";
import {
createPaymentRequest,
paymentApiErrorMessage,
type PaymentRequest,
type PaymentRequestCreate
} from "../../api/payments";
type PaymentRequestDialogProps = {
open: boolean;
settings: ApiSettings;
onClose: () => void;
onCreated: (payment: PaymentRequest) => void;
};
type PaymentRequestDraft = {
sourceModule: string;
sourceResourceType: string;
sourceResourceId: string;
subject: string;
amount: string;
currency: string;
dueAt: string;
caseRef: string;
workflowRef: string;
idempotencyKey: string;
};
const FORM_ID = "payments-create-request-form";
function replayKey(prefix: string): string {
const suffix = globalThis.crypto?.randomUUID?.() ?? `${Date.now()}-${Math.random().toString(16).slice(2)}`;
return `${prefix}-${suffix}`;
}
function emptyDraft(): PaymentRequestDraft {
return {
sourceModule: "cases",
sourceResourceType: "case",
sourceResourceId: "",
subject: "",
amount: "",
currency: "EUR",
dueAt: "",
caseRef: "",
workflowRef: "",
idempotencyKey: replayKey("payments-ui-request")
};
}
function amountToMinor(value: string): number | null {
const normalized = value.trim().replace(",", ".");
if (!/^\d+(?:\.\d{1,2})?$/.test(normalized)) return null;
const [whole, fraction = ""] = normalized.split(".");
const result = Number(whole) * 100 + Number(fraction.padEnd(2, "0"));
return Number.isSafeInteger(result) && result > 0 ? result : null;
}
export default function PaymentRequestDialog({ open, settings, onClose, onCreated }: PaymentRequestDialogProps) {
const [draft, setDraft] = useState<PaymentRequestDraft>(emptyDraft);
const [dirty, setDirty] = useState(false);
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
const { requestDiscard } = useUnsavedChanges();
function reset() {
setDraft(emptyDraft());
setDirty(false);
setError("");
}
useEffect(() => {
if (open) reset();
}, [open]);
function change<K extends keyof PaymentRequestDraft>(key: K, value: PaymentRequestDraft[K]) {
setDraft((current) => ({ ...current, [key]: value }));
setDirty(true);
}
async function submit(): Promise<boolean> {
const amountMinor = amountToMinor(draft.amount);
if (!draft.sourceModule.trim() || !draft.sourceResourceType.trim() || !draft.sourceResourceId.trim() || !draft.subject.trim()) {
setError("Source, source ID, and payment subject are required.");
return false;
}
if (amountMinor === null) {
setError("Enter a positive amount with no more than two decimal places.");
return false;
}
if (!/^[A-Za-z]{3}$/.test(draft.currency.trim())) {
setError("Currency must be a three-letter ISO code.");
return false;
}
const contextRefs = Object.fromEntries([
["case", draft.caseRef.trim()],
["workflow", draft.workflowRef.trim()]
].filter((entry): entry is [string, string] => Boolean(entry[1])));
const payload: PaymentRequestCreate = {
source_module: draft.sourceModule.trim(),
source_resource_type: draft.sourceResourceType.trim(),
source_resource_id: draft.sourceResourceId.trim(),
amount_minor: amountMinor,
currency: draft.currency.trim().toUpperCase(),
subject: draft.subject.trim(),
idempotency_key: draft.idempotencyKey.trim(),
due_at: draft.dueAt ? new Date(draft.dueAt).toISOString() : null,
context_refs: contextRefs,
metadata: {}
};
setBusy(true);
setError("");
try {
const payment = await createPaymentRequest(settings, payload);
setDirty(false);
onCreated(payment);
return true;
} catch (reason) {
setError(paymentApiErrorMessage(reason));
return false;
} finally {
setBusy(false);
}
}
useUnsavedDraftGuard({
dirty: open && dirty,
title: "Discard the payment request draft?",
message: "The payment request has not been created. Save it before leaving or discard the draft.",
onSave: submit,
onDiscard: reset,
enabled: open
});
function close() {
if (busy) return;
if (dirty) requestDiscard(onClose);
else onClose();
}
function handleSubmit(event: FormEvent) {
event.preventDefault();
void submit();
}
return (
<Dialog
open={open}
title="Create payment request"
description="Create one fixed, source-bound obligation. The returned payment reference remains stable for the owning procedure."
size="wide"
closeDisabled={busy}
onClose={close}
interfaceId="payments.request.create.dialog"
helpContextId="payments.request.create"
helpModuleId="payments"
notices={error ? <DismissibleAlert tone="danger" resetKey={error}>{error}</DismissibleAlert> : null}
footer={(
<>
<Button type="button" onClick={close} disabled={busy}>Cancel</Button>
<Button type="submit" form={FORM_ID} variant="primary" disabled={busy}>
{busy ? "Creating…" : "Create request"}
</Button>
</>
)}
>
<DialogForm id={FORM_ID} onSubmit={handleSubmit}>
<DialogSection>
<h3 className="payments-dialog-section-title">Owning source</h3>
<p className="payments-dialog-section-copy">Use the stable reference of the Case, Workflow, or other procedure that owns this obligation.</p>
<FormGrid columns={2}>
<FormField label="Source module" helpContextId="payments.request.field.source-module" helpModuleId="payments">
<input required maxLength={120} value={draft.sourceModule} onChange={(event) => change("sourceModule", event.target.value)} />
</FormField>
<FormField label="Resource type" helpContextId="payments.request.field.resource-type" helpModuleId="payments">
<input required maxLength={120} value={draft.sourceResourceType} onChange={(event) => change("sourceResourceType", event.target.value)} />
</FormField>
<FormField label="Source resource ID" helpContextId="payments.request.field.source-id" helpModuleId="payments">
<input required maxLength={255} value={draft.sourceResourceId} onChange={(event) => change("sourceResourceId", event.target.value)} />
</FormField>
<FormField label="Payment subject" helpContextId="payments.request.field.subject" helpModuleId="payments">
<input required maxLength={1000} value={draft.subject} onChange={(event) => change("subject", event.target.value)} />
</FormField>
</FormGrid>
</DialogSection>
<DialogSection variant="separated">
<h3 className="payments-dialog-section-title">Obligation</h3>
<FormGrid columns={2}>
<FormField label="Amount" help="Enter the major currency amount, for example 30.00.">
<input required inputMode="decimal" placeholder="0.00" value={draft.amount} onChange={(event) => change("amount", event.target.value)} />
</FormField>
<FormField label="Currency" help="Three-letter ISO currency code.">
<input required maxLength={3} value={draft.currency} onChange={(event) => change("currency", event.target.value.toUpperCase())} />
</FormField>
<FormField label="Due date and time" help="Optional. The local time is converted to an absolute timestamp.">
<DateTimeField value={draft.dueAt} onChange={(value) => change("dueAt", value)} aria-label="Payment due date and time" />
</FormField>
</FormGrid>
</DialogSection>
<DialogSection variant="separated">
<h3 className="payments-dialog-section-title">Procedure context</h3>
<p className="payments-dialog-section-copy">Optional references make the source visible without copying applicant or form data into Payments.</p>
<FormGrid columns={2}>
<FormField label="Case reference">
<input maxLength={255} value={draft.caseRef} onChange={(event) => change("caseRef", event.target.value)} />
</FormField>
<FormField label="Workflow reference">
<input maxLength={255} value={draft.workflowRef} onChange={(event) => change("workflowRef", event.target.value)} />
</FormField>
</FormGrid>
</DialogSection>
<DialogSection variant="inset">
<h3 className="payments-dialog-section-title">Replay protection</h3>
<p className="payments-dialog-section-copy">Retry with this key only for the same source, amount, currency, subject, dates, and context. Reusing it for changed values is rejected.</p>
<FormField label="Idempotency key" helpContextId="payments.request.field.replay-key" helpModuleId="payments">
<input required maxLength={255} value={draft.idempotencyKey} onChange={(event) => change("idempotencyKey", event.target.value)} />
</FormField>
</DialogSection>
</DialogForm>
</Dialog>
);
}
@@ -0,0 +1,358 @@
import { CheckCircle2, Plus } from "lucide-react";
import { useEffect, useMemo, useRef, useState } from "react";
import {
Button,
Card,
DataGrid,
DismissibleAlert,
DocumentationHelpLink,
FilterBar,
MetricCard,
MetricGrid,
PageActionBar,
PageLayout,
StatePanel,
StatusBadge,
TableActionGroup,
WorkspaceFrame,
hasScope,
type DataGridColumn,
type PlatformRouteContext
} from "@govoplan/core-webui";
import {
listPaymentRequests,
paymentApiErrorMessage,
type PaymentRequest,
type PaymentStatus
} from "../../api/payments";
import ManualReconciliationDialog from "./ManualReconciliationDialog";
import PaymentRequestDialog from "./PaymentRequestDialog";
function formatAmount(amountMinor: number, currency: string): string {
try {
return new Intl.NumberFormat(undefined, { style: "currency", currency }).format(amountMinor / 100);
} catch {
return `${(amountMinor / 100).toFixed(2)} ${currency}`;
}
}
function formatDateTime(value?: string | null): string {
if (!value) return "—";
const date = new Date(value);
return Number.isNaN(date.getTime()) ? value : date.toLocaleString();
}
function reconciliationEvidence(payment: PaymentRequest): string {
const evidence = payment.reconciliation?.evidence_ref;
if (!evidence) return "Not recorded";
const immutableRef = evidence.version ? `version ${evidence.version}` : `checksum ${String(evidence.checksum).slice(0, 12)}`;
return `${evidence.owner_module}:${evidence.evidence_id} · ${immutableRef}`;
}
export default function PaymentsPage({ settings, auth }: PlatformRouteContext) {
const [payments, setPayments] = useState<PaymentRequest[]>([]);
const [statusFilter, setStatusFilter] = useState<"all" | PaymentStatus>("all");
const [sourceFilter, setSourceFilter] = useState("");
const [loading, setLoading] = useState(true);
const [refreshing, setRefreshing] = useState(false);
const [initialError, setInitialError] = useState("");
const [staleError, setStaleError] = useState("");
const [success, setSuccess] = useState("");
const [loadedAt, setLoadedAt] = useState<Date | null>(null);
const [createOpen, setCreateOpen] = useState(false);
const [reconcilingPayment, setReconcilingPayment] = useState<PaymentRequest | null>(null);
const loadedRef = useRef(false);
const canRead = hasScope(auth, "payments:payment:read");
const canCreate = hasScope(auth, "payments:payment:write");
const canReconcile = hasScope(auth, "payments:payment:reconcile");
const tenantId = auth.active_tenant?.id ?? auth.tenant.id;
async function reload(signal?: AbortSignal) {
if (!canRead) {
setLoading(false);
return;
}
if (loadedRef.current) setRefreshing(true);
else setLoading(true);
setInitialError("");
try {
const result = await listPaymentRequests(settings, {}, signal);
setPayments(result);
setLoadedAt(new Date());
setStaleError("");
loadedRef.current = true;
} catch (reason) {
if (reason instanceof Error && reason.name === "AbortError") return;
const message = paymentApiErrorMessage(reason);
if (loadedRef.current) setStaleError(message);
else setInitialError(message);
} finally {
setLoading(false);
setRefreshing(false);
}
}
useEffect(() => {
loadedRef.current = false;
const controller = new AbortController();
void reload(controller.signal);
return () => controller.abort();
}, [settings, canRead]);
const filteredPayments = useMemo(() => {
const sourceQuery = sourceFilter.trim().toLocaleLowerCase();
return payments.filter((payment) => {
if (statusFilter !== "all" && payment.status !== statusFilter) return false;
if (!sourceQuery) return true;
return [
payment.source.module,
payment.source.resource_type,
payment.source.resource_id,
payment.context_refs.case,
payment.context_refs.workflow,
payment.payment_reference,
payment.subject
].filter(Boolean).join(" ").toLocaleLowerCase().includes(sourceQuery);
});
}, [payments, sourceFilter, statusFilter]);
const requestedCount = payments.filter((payment) => payment.status === "requested").length;
const paidCount = payments.filter((payment) => payment.status === "paid").length;
const overdueCount = payments.filter((payment) => payment.status === "requested" && payment.due_at && new Date(payment.due_at) < new Date()).length;
const columns = useMemo<DataGridColumn<PaymentRequest>[]>(() => [
{
id: "reference",
header: "Payment",
width: "1.2fr",
minWidth: 220,
sortable: true,
filterable: true,
value: (payment) => `${payment.payment_reference} ${payment.subject}`,
render: (payment) => <div className="payments-source"><strong>{payment.subject}</strong><span>{payment.payment_reference}</span></div>
},
{
id: "source",
header: "Owning source",
width: "1.1fr",
minWidth: 210,
sortable: true,
filterable: true,
value: (payment) => `${payment.source.module} ${payment.source.resource_type} ${payment.source.resource_id} ${payment.context_refs.case ?? ""} ${payment.context_refs.workflow ?? ""}`,
render: (payment) => (
<div className="payments-source">
<strong>{payment.source.module}:{payment.source.resource_type}</strong>
<span>{payment.source.resource_id}</span>
{(payment.context_refs.case || payment.context_refs.workflow) && <span>{[payment.context_refs.case && `Case ${payment.context_refs.case}`, payment.context_refs.workflow && `Workflow ${payment.context_refs.workflow}`].filter(Boolean).join(" · ")}</span>}
</div>
)
},
{
id: "amount",
header: "Amount",
width: 130,
minWidth: 120,
align: "right",
sortable: true,
sortValue: (payment) => payment.amount_minor,
render: (payment) => <strong className="payments-amount">{formatAmount(payment.amount_minor, payment.currency)}</strong>
},
{
id: "status",
header: "State",
width: 115,
minWidth: 105,
sortable: true,
filterable: true,
filterType: "list",
value: (payment) => payment.status,
list: {
options: [
{ value: "requested", label: "Requested" },
{ value: "paid", label: "Paid" }
],
display: "pill"
},
render: (payment) => <StatusBadge status={payment.status === "paid" ? "active" : "pending"} label={payment.status === "paid" ? "Paid" : "Requested"} />
},
{
id: "dates",
header: "Due / settled",
width: 190,
minWidth: 170,
sortable: true,
sortValue: (payment) => payment.settled_at ?? payment.due_at ?? payment.requested_at,
render: (payment) => <div className="payments-dates"><strong>{payment.status === "paid" ? `Settled ${formatDateTime(payment.settled_at)}` : `Due ${formatDateTime(payment.due_at)}`}</strong><span>Requested {formatDateTime(payment.requested_at)}</span></div>
},
{
id: "evidence",
header: "Reconciliation evidence",
width: "1fr",
minWidth: 210,
filterable: true,
value: reconciliationEvidence,
render: (payment) => (
<div className="payments-evidence">
<strong>{payment.reconciliation?.transaction_reference ?? "Not reconciled"}</strong>
<span>{reconciliationEvidence(payment)}</span>
</div>
)
},
{
id: "actions",
header: "Actions",
width: 88,
minWidth: 88,
sticky: "end",
align: "right",
resizable: false,
render: (payment) => (
<TableActionGroup
label={`Actions for ${payment.payment_reference}`}
actions={[
{
id: "reconcile",
label: "Record manual payment",
icon: <CheckCircle2 size={16} />,
onClick: () => setReconcilingPayment(payment),
disabled: payment.status === "paid" || !canReconcile,
disabledReason: payment.status === "paid"
? "This payment is already reconciled. A correction requires a governed adjustment flow."
: !canReconcile
? "The payments:payment:reconcile permission is required. Ask a Payments administrator to grant a reconciliation role."
: undefined
}
]}
/>
)
}
], [canReconcile]);
function handleCreated(payment: PaymentRequest) {
setPayments((current) => [payment, ...current.filter((item) => item.payment_id !== payment.payment_id)]);
setCreateOpen(false);
setSuccess(payment.replayed
? `Payment request ${payment.payment_reference} was returned from the existing replay key.`
: `Payment request ${payment.payment_reference} was created.`);
}
function handleReconciled(payment: PaymentRequest) {
setPayments((current) => current.map((item) => item.payment_id === payment.payment_id ? payment : item));
setReconcilingPayment(null);
setSuccess(payment.replayed
? `Existing reconciliation for ${payment.payment_reference} was returned from the replay key.`
: `Payment ${payment.payment_reference} was recorded as paid with immutable evidence.`);
}
const createButton = (
<Button
variant="primary"
onClick={() => setCreateOpen(true)}
disabled={!canCreate}
disabledReason={!canCreate ? "The payments:payment:write permission is required. Ask a Payments administrator to grant a payment operator role." : undefined}
interfaceId="payments.request.create"
helpContextId="payments.request.create"
helpModuleId="payments"
>
<Plus size={16} aria-hidden="true" /> Create request
</Button>
);
return (
<WorkspaceFrame as="main" height="viewport" surface="plain" label="Payments workspace" interfaceId="payments.workspace" helpContextId="payments.workspace" helpModuleId="payments">
<PageLayout
archetype="collection"
mode="standalone"
title="Payment requests"
description="Track source-bound obligations and record exact manual receipts against immutable evidence."
loading={loading}
loadingLabel="Loading payment requests"
success={success}
interfaceId="payments.workspace.page"
helpContextId="payments.workspace"
helpModuleId="payments"
actions={(
<PageActionBar
variant="collection"
refreshable
label="Payment request actions"
interfaceId="payments.workspace.actions"
helpContextId="payments.workspace"
helpModuleId="payments"
reloadAction={{ onReload: () => void reload(), loading: refreshing, label: "Reload payment requests" }}
helpAction={<DocumentationHelpLink reference={{ topicId: "payments.requests-and-reconciliation", documentationType: "user" }} label="Open Payments documentation" />}
createAction={createButton}
/>
)}
notices={staleError ? (
<DismissibleAlert tone="warning" resetKey={staleError}>
<div>The loaded payment list may be stale because refresh failed: {staleError}</div>
<div className="payments-notice-action"><Button type="button" onClick={() => void reload()}>Retry reload</Button></div>
</DismissibleAlert>
) : null}
>
{!canRead ? (
<StatePanel
size="fill"
tone="warning"
title="Payment access is unavailable"
description="The payments:payment:read permission is required. Ask a Payments administrator to grant a payment reader, operator, or auditor role."
/>
) : initialError ? (
<StatePanel
size="fill"
tone="danger"
title="Payment requests could not be loaded"
description={initialError}
actions={<Button type="button" onClick={() => void reload()}>Retry</Button>}
/>
) : (
<>
<MetricGrid columns={4} density="compact" spacing="none" minimum="compact" collapseAt="standard">
<MetricCard density="compact" label="All requests" value={payments.length} detail={loadedAt ? `Updated ${loadedAt.toLocaleTimeString()}` : "Not loaded"} />
<MetricCard density="compact" tone="warning" label="Requested" value={requestedCount} detail="Awaiting receipt" />
<MetricCard density="compact" tone="good" label="Paid" value={paidCount} detail="Evidence recorded" />
<MetricCard density="compact" tone={overdueCount ? "danger" : "neutral"} label="Overdue" value={overdueCount} detail="Requested past due time" />
</MetricGrid>
<FilterBar surface="panel" className="payments-filter-bar">
<select aria-label="Filter payment state" value={statusFilter} onChange={(event) => setStatusFilter(event.target.value as "all" | PaymentStatus)}>
<option value="all">All states</option>
<option value="requested">Requested</option>
<option value="paid">Paid</option>
</select>
<input aria-label="Filter by source or payment reference" placeholder="Source, Case, Workflow, or payment reference" value={sourceFilter} onChange={(event) => setSourceFilter(event.target.value)} />
{(statusFilter !== "all" || sourceFilter) && <Button type="button" variant="ghost" onClick={() => { setStatusFilter("all"); setSourceFilter(""); }}>Clear filters</Button>}
</FilterBar>
<Card title={`${filteredPayments.length} payment request${filteredPayments.length === 1 ? "" : "s"}`} interfaceId="payments.requests.list" helpContextId="payments.workspace.list" helpModuleId="payments">
<DataGrid
id="payments.requests"
storageKey="govoplan.payments.requests.grid"
rows={filteredPayments}
columns={columns}
getRowKey={(payment) => payment.payment_id}
initialSort={{ columnId: "dates", direction: "desc" }}
emptyText="No payment requests have been created."
filteredEmptyText="No payment requests match the current filters."
emptyAction={createButton}
emptyActionColumnId="actions"
/>
</Card>
</>
)}
</PageLayout>
<PaymentRequestDialog open={createOpen} settings={settings} onClose={() => setCreateOpen(false)} onCreated={handleCreated} />
<ManualReconciliationDialog
open={Boolean(reconcilingPayment)}
settings={settings}
tenantId={tenantId}
payment={reconcilingPayment}
onClose={() => setReconcilingPayment(null)}
onReconciled={handleReconciled}
/>
</WorkspaceFrame>
);
}
+2
View File
@@ -0,0 +1,2 @@
export { default, paymentsModule } from "./module";
export * from "./api/payments";
+50
View File
@@ -0,0 +1,50 @@
import { createElement, lazy } from "react";
import type { PlatformWebModule } from "@govoplan/core-webui";
import "./styles/payments.css";
const PaymentsPage = lazy(() => import("./features/payments/PaymentsPage"));
export const paymentsModule: PlatformWebModule = {
id: "payments",
label: "Payments",
version: "0.1.20",
optionalDependencies: ["files", "audit", "cases", "workflow_engine", "ledger", "xrechnung"],
routes: [
{
path: "/payments",
anyOf: ["payments:payment:read"],
order: 73,
surfaceId: "payments.workspace",
render: (context) => createElement(PaymentsPage, context)
}
],
navItems: [
{
to: "/payments",
label: "Payments",
iconName: "landmark",
anyOf: ["payments:payment:read"],
order: 73,
surfaceId: "payments.navigation"
}
],
productAreas: [
{
id: "services-cases",
moduleId: "payments",
label: "i18n:govoplan-core.product_area.services_cases",
description: "i18n:govoplan-core.product_area.services_cases_description",
iconName: "landmark",
surfaceIds: ["payments.navigation", "payments.workspace"],
order: 20
}
],
viewSurfaces: [
{ id: "payments.navigation", moduleId: "payments", kind: "navigation", label: "Payments navigation", order: 10 },
{ id: "payments.workspace", moduleId: "payments", kind: "route", label: "Payment request workspace", order: 20 },
{ id: "payments.request.create", moduleId: "payments", kind: "section", label: "Create payment request", parentId: "payments.workspace", order: 30 },
{ id: "payments.reconciliation.manual", moduleId: "payments", kind: "section", label: "Record manual payment", parentId: "payments.workspace", order: 40 }
]
};
export default paymentsModule;
+19
View File
@@ -0,0 +1,19 @@
.payments-page .page-layout-body { display: grid; gap: 18px; }
.payments-filter-bar { justify-content: flex-start; }
.payments-filter-bar input { min-width: min(320px, 100%); }
.payments-amount { font-variant-numeric: tabular-nums; white-space: nowrap; }
.payments-source { min-width: 0; display: grid; gap: 2px; }
.payments-source span { overflow: hidden; color: var(--muted); font-size: 12px; text-overflow: ellipsis; white-space: nowrap; }
.payments-dates { display: grid; gap: 3px; font-size: 12px; }
.payments-dates span { color: var(--muted); }
.payments-evidence { min-width: 0; display: grid; gap: 2px; font-size: 12px; overflow-wrap: anywhere; }
.payments-notice-action { margin-top: 8px; }
.payments-dialog-copy { margin: 0; color: var(--muted); line-height: 1.5; }
.payments-dialog-section-title { margin: 0 0 8px; color: var(--text-strong); font-size: 14px; }
.payments-dialog-section-copy { margin: 0 0 12px; color: var(--muted); line-height: 1.5; }
.payments-readonly-amount { color: var(--text-strong); font-size: 20px; font-weight: 700; font-variant-numeric: tabular-nums; }
.payments-reconciliation-warning { border-left: 3px solid var(--amber); }
@media (max-width: 760px) {
.payments-filter-bar input,
.payments-filter-bar select { width: 100%; min-width: 0; }
}
+29
View File
@@ -0,0 +1,29 @@
{
"compilerOptions": {
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["DOM", "DOM.Iterable", "ES2020"],
"allowJs": false,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"forceConsistentCasingInFileNames": true,
"module": "ESNext",
"moduleResolution": "Bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx",
"baseUrl": ".",
"paths": {
"@govoplan/core-webui": ["../../govoplan-core/webui/src/index.ts"],
"lucide-react": ["../../govoplan-core/webui/node_modules/lucide-react/dist/lucide-react.d.ts"],
"react": ["../../govoplan-core/webui/node_modules/@types/react/index.d.ts"],
"react/*": ["../../govoplan-core/webui/node_modules/@types/react/*"]
}
},
"include": ["src", "../../govoplan-core/webui/src/vite-env.d.ts"]
}