Skip to main content

Quickstart

Query your assigned cases in 2 minutes.

Prerequisites​

Get your API key from Partner Portal → API Keys. See Authentication for details.

Verify Your API Key​

curl https://collectionpartner-api.debitura.com/me \
  -H "XApiKey: YOUR_API_KEY"

Success Response​

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "companyName": "Your Agency Name",
  "country": "Germany"
}

List Your Assigned Cases​

curl "https://collectionpartner-api.debitura.com/cases?statuses=Active&pageSize=5" \
  -H "XApiKey: YOUR_API_KEY"

Success Response​

{
  "page": {
    "currentPage": 1,
    "pageSize": 5,
    "totalResults": 42,
    "responseCount": 5,
    "totalPages": 9
  },
  "cases": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "reference": "Q8OAXF3W",
      "lifecycle": "Active",
      "grossAmount": 1500.00,
      "currency": "EUR",
      "debtor": {
        "name": "Example Company GmbH",
        "country": "Germany"
      }
    }
  ]
}

You've connected to the API and retrieved your cases.

See Update Case Progress to add notes and log activities, or Record Payments to report collected payments. For cases submitted on behalf of your clients, see Managed Cases. Full endpoint details are in the API Reference.