Cases

Batch lookup of cases by the collection partner's own reference IDs.

Changed on

Returns a dictionary mapping each partner reference to its corresponding case details.

Use Case: Use this endpoint to look up multiple cases at once using your own internal reference IDs. This is more efficient than making individual calls for each reference.

Parameters:

  • references (required) - Comma-separated list of partner reference strings (max 100)

Matching: Exact string match only. References not found or not assigned to you are omitted from the response (no error).

Response: A dictionary where keys are the partner reference strings and values are the case details. Missing references are silently omitted.

get/cases/by-partner-reference

Request

  • Base URL
    https://collectionpartner-api.debitura.com
  • URL
    https://collectionpartner-api.debitura.com/cases/by-partner-reference
  • Auth
    API key in header XApiKey

Query parameters

referencesstring

Response

Dictionary of reference to case

object required

Changes

    • info

      response property additionalProperties/collectionPartner/surveyCadenceMode deprecated (media type: text/plain)

    • info

      response property additionalProperties/collectionPartner/surveyCadenceMode deprecated (media type: application/json)

    • info

      response property additionalProperties/collectionPartner/surveyCadenceMode deprecated (media type: text/json)