pos-transactions-bff/docs/api/pos-transaction-workflows.md
2026-03-31 18:54:42 -06:00

31 lines
1.3 KiB
Markdown

# POS Transaction Workflow API
## Purpose
This BFF exposes POS summary, transaction detail, recent payment activity, and payment capture workflows over REST while delegating orchestration to `operations-service`.
## Endpoints
- `GET /api/pos/transactions/summary?contextId=<value>`
- Returns POS balance and recent payment summary.
- `GET /api/pos/transactions/recent-payments?contextId=<value>`
- Returns the recent POS payment activity snapshot.
- `GET /api/pos/transactions/{transactionId}?contextId=<value>`
- Returns the current detail projection for a single recent payment activity item.
- `POST /api/pos/transactions/payments`
- Captures a POS payment.
## Upstream Dependency
- Base address configuration: `OperationsService:BaseAddress`
- Default runtime target: `http://operations-service:8080`
- Internal upstream routes:
- `GET /internal/operations/pos/summary`
- `POST /internal/operations/pos/payments`
## Notes
- POS summary and detail are derived from payable restaurant checks exposed by `operations-service`, not from an independent payment event store.
- Transaction detail is currently derived from the payable-check snapshot returned by `operations-service`.
- Correlation IDs are preserved through Thalos session checks and operations-service calls.