Sign in

d0dcc5024bd1

latestOpenAPI 3.0.42026-08-104969330.3 KB
Cases

Close a case

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)
post/cases/{id}/close

Path parameters

idstring uuid required

Request body

closeCodestring required

Close code/reason for closing the case.

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
  • UneconomicalToPursue: Recovery cost exceeds claim value
  • Other: Other reason (please provide comment)
commentstring nullable

Optional comment explaining the closure (recommended for 'Other' close code)

Example request

{
  "closeCode": "Paid",
  "comment": "Case closed after full payment received via bank transfer on 2025-11-19"
}

Response

Case closed successfully

caseReferencestring nullable required
closeCodestring nullable required
closeCodeDescriptionstring nullable required
commentstring nullable
closedAtstring date-time
finalOutstandingAmountnumber double
totalPaymentsnumber double
totalRecoverednumber double