PENDING status and only takes effect on the group balance after all active admins have approved it. Members can view their own transaction history; admins can filter across the entire group.
List transactions
Retrieve a paginated list of transactions. Members always see only their own records. Admins can optionally filter by any member and by date range.GET /api/transactions
Query parameters
Filter by member ID. Admins only — members always see their own transactions regardless of this parameter.
Response
Returns aPaginatedResponse wrapping a list of TransactionEntity objects.
Example
Create a transaction
Record a new financial transaction for a group member. The transaction is immediately saved with aPENDING status — it does not affect the group balance until it is approved.
POST /api/transactions
Supply an
idempotency_key on every request that may be retried (e.g., after a network timeout). If the server has already processed a request with the same key, it returns the original transaction instead of creating a duplicate.Request body
Full name of the member as stored in the system. The API looks up the member record by this name.
Type of transaction. Must be one of:
CONTRIBUTION, PAYOUT, LOAN_REPAYMENT, PENALTY, SHORTFALL_RESOLUTION.Amount in the group’s currency. Must be greater than
0 and must not exceed the system-configured MAX_TRANSACTION_AMOUNT.A unique string (max 100 characters) you generate per request. Enables safe retries without creating duplicate transactions.
Response
Returns the createdTransactionEntity with status: "PENDING".
Example
Approve a transaction
Approve a pending transaction. This endpoint requires admin privileges. The system uses unanimous approval — a transaction is only executed once every active admin has called this endpoint for it.POST /api/transactions/{id}/approve
When unanimous approval is reached, the following side effects occur automatically:
CONTRIBUTION— the group balance is credited and the member’scontribution_paidtotal is increased. The member’s credit score is then updated: an on-time payment (before the active cycle’scontribution_due_date) awards positive points; a late payment deducts points.PAYOUT— the group balance is debited.LOAN_REPAYMENT— the group balance is credited.PENALTY— the group balance is credited and the member’sshortfall_amountis increased.
Path parameters
Request body
Response
Either
"Transaction approved and executed successfully" (when unanimous approval is reached) or "Approval recorded. Waiting for other admins to approve." (when more approvals are still needed).
