Skip to main content

Track Case Status

Monitor case progress through webhooks or polling.

Business context: See Case Status & Email Updates for what each status change means operationally.

Key Fields

FieldDescription
lifecycleCurrent state (e.g., Active, Paused, Closed)
closeCodeOutcome reason (only when Closed)

See Case Lifecycle for all lifecycle states and close codes.

Subscribe to case.updated and case.closed events for real-time notifications.

See Webhooks for setup, payloads, and event details.

Polling

Query the case endpoint when you need current status:

GET https://customer-api.debitura.com/cases/{caseId}
XApiKey: YOUR_API_KEY

For bulk checks, filter by lifecycle:

GET https://customer-api.debitura.com/cases?statuses=Active
XApiKey: YOUR_API_KEY

Look up a case by your own reference

If you only know your creditorReference (the value you sent on case creation), use the dedicated lookup endpoint instead of paginating /cases:

GET https://customer-api.debitura.com/cases/by-creditor-reference/{creditorReference}
XApiKey: YOUR_API_KEY

Returns the same case object as GET /cases/{caseId}. Returns 404 if no case matches the reference for the calling creditor, and 400 if the reference is empty. See Case Identifiers for when to use each identifier.

Send chat messages

Reply to the collection partner from your own UI with POST /cases/{id}/chats on the Customer API:

POST https://customer-api.debitura.com/cases/{id}/chats
XApiKey: YOUR_API_KEY
Content-Type: application/json

{
"message": "Attached the signed delivery note from January.",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

userId must belong to your team — list valid IDs with GET /users on the Customer API. The message appears as a creditor message to the collection partner. Subscribe to the chat.created webhook to receive partner replies in real time.

To track payments as they land on cases, see Payments and Reconciliation.

Exclusive collection period

Every case response from GET /cases/{caseId} includes an exclusivePeriodEndDate field (ISO 8601, null if no period applies).

Business context: See Collection period & exclusivity for what this means and when a case can be withdrawn.

For the full chain with extension history, call the dedicated endpoint:

GET https://customer-api.debitura.com/cases/{caseId}/exclusive-period
XApiKey: YOUR_API_KEY
{
"engagementStartDate": "2025-07-15T00:00:00Z",
"currentEndDate": "2026-07-15T00:00:00Z",
"daysRemaining": 65,
"status": "Active",
"extensions": [
{
"type": "Payment",
"eventDate": "2025-10-20T00:00:00Z",
"newEndDate": "2026-07-15T00:00:00Z"
}
]
}
FieldDescription
statusActive, Expired, or Terminated
daysRemainingDays until currentEndDate. Negative when the period has already passed.
extensions[].typeWhat triggered the extension: Payment, PromiseToPay, PaymentAgreement, or Manual

Returns 404 when the case has no collection period (quote-based cases or cases not yet assigned to a partner).