PUT request. Every field is optional on update — only the fields you include are changed, and the full updated configuration is returned immediately. Changes persist to the database and take effect across all connected devices without a restart.
GET /api/config
Returns the current system configuration. This endpoint is public — no authentication is required.GET /api/config requires no Authorization header. You can call it from an unauthenticated client to display group settings on onboarding screens or public-facing pages.Response
See the full SystemConfig fields table below.Sample response
PUT /api/config
Updates system configuration. Requires an admin JWT. Only the fields present in the request body are modified — omitted fields retain their current values. Returns the full updatedSystemConfig object.
Request body
All fields are optional. Include only the fields you want to change.Financial rules
Maximum loan amount expressed as a multiple of the member’s savings. For example,
3 means a member can borrow up to three times what they have contributed. Must be >= 0.Percentage of the payout amount retained in the group fund rather than disbursed. Must be between
0 and 100.Credit score weights
These values are added to or subtracted from a member’s credit score when the corresponding event occurs.Credit score boundaries
Cycle and chama settings
The date the current cycle started, used as the reference point for scheduling. Accepts a human-readable date string (e.g.,
"Jan 1, 2025").When
true, payouts are executed automatically by the scheduler. When false, an admin must trigger each payout manually.When
true, the system sends reminders and tracks contribution due dates based on the configured frequency and start_date.When
true, member transactions are rounded up and the difference is added as a micro-contribution to the group fund.When
true, the system automatically advances the group to the next cycle when all conditions are met.When
true, members can submit new loan requests. Set to false to pause the loan request flow for all members.Response
Returns the full updatedSystemConfig object. See the sample response under GET /api/config.
Error responses
Notifications
GET /api/notifications
Returns all notifications for the authenticated user, ordered bycreated_at descending. Requires authentication.
Response
Returns an array ofNotificationResponse objects.
POST /api/notifications//read
Marks a single notification as read. The notification must belong to the authenticated user. Returns404 if the ID is not found or belongs to a different user.
Response
POST /api/notifications/read-all
Marks all unread notifications for the authenticated user as read in a single operation.Response
POST /api/notifications/update-token
Registers or replaces the FCM (Firebase Cloud Messaging) push token for the authenticated user’s device. Call this endpoint after obtaining a fresh token from the Firebase SDK — typically on app launch and wheneveronTokenRefresh fires.
Request body
Response
Sample response (all notification endpoints)

