Settlements
The settlement (quita) workflow allows operators to propose discounted payoff offers to resolve accounts for less than the full balance.
How It Works
- Navigate to an account detail and find the Settlements card.
- Click Propose to create a new settlement offer with the discounted amount and optional notes.
- If the discount exceeds the strategy's maximum allowed discount (
max_discount_pctin negotiation parameters), the offer is flagged as pending approval and requires an admin to approve it. - Once proposed (or approved), the offer can be accepted — which updates the account's pending balance to the offered amount — or rejected.
Settlement Statuses
| Status | Description |
|---|---|
| Proposed | Offer created, within discount limits |
| Pending Approval | Discount exceeds strategy limits, needs admin approval |
| Approved | Admin approved the high-discount offer |
| Rejected | Offer was rejected |
| Accepted | Debtor accepted, account balance updated to the offered amount |
| Expired | Offer expired without action |
API Access
POST /api/admin/accounts/:accountId/settlements
GET /api/admin/accounts/:accountId/settlements
PATCH /api/admin/settlements/:idSee the API Reference for details.