Close a case
POST/cases/:id/close
Closes a collection case with a specified close code.
Use Case: Use this endpoint to formally close a case when collection is complete or cannot continue. The close code determines the reason and impacts reporting.
Close Code Validation:
- Paid: Requires at least one payment AND total payments >= outstanding amount
- PartiallyPaid: Requires at least one payment AND total payments < outstanding amount
- All other codes: No payment requirements
Valid Close Codes:
- Paid - Full payment received from debtor
- PartiallyPaid - Some payment received but not full amount
- DebtorInsolventBankrupt - Debtor declared bankruptcy or insolvent
- DebtorUntraceable - Unable to locate or contact debtor
- DisputedLegalActionDeclinedByClient - Debt disputed, creditor declined legal action
- WithdrawnByClient - Creditor requested case withdrawal
- PreLegalExhaustedNoPayment - All pre-legal attempts exhausted without payment
- StatuteOfLimitationsExpired - Legal time limit to collect has passed
- SettlementRejectedByClient - Proposed settlement rejected by creditor
- UnresponsiveClient - Creditor not responding to collection partner
- Other - Other reason (please provide comment)
Request
Responses
- 200
- 400
- 404
- 500
Case closed successfully
Invalid request (validation errors)
Case not found or not assigned to you
Server error occurred