Skip to main content

Collection Partners: Collection Partner API and integration overview

A use-case-level overview of the Collection Partner API: what it is for, when an API integration is the right path, what you can build, how it works at a high level, the stability you can expect, and where to send your developer for technical details.

Collection Partners: Collection Partner API and integration overview

If you want to manage your Debitura cases programmatically rather than working in the Partner Portal, the Collection Partner API is the integration path. This article gives a use-case-level overview so you can decide whether the API is right for your agency, and where to send your developer or service provider when you are ready to build.

What the Collection Partner API is for

The Collection Partner API is a REST interface that lets you manage cases assigned to your agency directly from your own systems. It covers the same actions you can take in the Partner Portal: viewing case details, accepting or declining new assignments, updating case status, recording payments, uploading documents, and looking up cases by your own internal references.

When the API is the right path

Most collection partners do not need the API. The Partner Portal handles the full case workflow for partners that work cases manually or in modest volume. The API is worth considering when:

  • Your agency already has a debt collection or case management system, and you want Debitura cases to flow into it without manual re-entry.

  • You handle enough volume that automation pays back the integration effort.

  • You have an in-house developer or an external IT firm who can build and maintain the integration.

If you are a smaller team or an early-stage partner, the Partner Portal is the simpler starting point. You can move to the API later when volume justifies it.

What you can build with it

At a use-case level, the API supports four common integration patterns:

  • Receive new case assignments. Pull cases that have been assigned to your agency, with full claim, debtor, and creditor details.

  • Accept and update cases. Programmatically accept new assignments and post status updates as your collection workflow progresses.

  • Record payments. Log payments received from debtors so the platform reflects the current case state and revenue is split correctly.

  • Look up cases by your internal reference. Retrieve cases using the partner reference you assigned during activation, so your own system does not need to track Debitura case IDs. See Collection Partners: How to assign and use your own case reference.

How it works at a high level

Authentication is by API key. Debitura provisions one API key per collection partner, and your developer includes it in the request header on every call. There is no token rotation or OAuth flow on your side.

The API exposes Debitura's data model directly. There is no partner-specific schema layer: lifecycle states, close codes, and payment structures are the canonical Debitura ones, and your integration maps them into your internal model.

A test environment is available so your developer can build and validate before going live. We recommend developing against the test environment first, but it is not enforced.

What to expect over time

The Collection Partner API is built to be a long-lived, stable integration target.

  • Additive-only changes. New capabilities are added as new optional fields, new properties on responses, or new endpoints. Existing requests and responses keep working.

  • We do not break live integrations. Breaking changes are a last resort. If a new major version is ever needed, the previous version stays live in parallel for at least six months while partners migrate.

  • Production-ready and live. The API is in production use today.

Alternative: data export from the Partner Portal

If a full API integration is more than your agency needs right now, the Partner Portal includes a built-in data export tool. You can download your cases as a CSV file (and case documents as a ZIP) directly from the portal, with optional filters by lifecycle status and date range. That gives you periodic structured data without the cost of building or maintaining an integration.

The export is capped at 200 cases per request. For higher volume, real-time updates, or two-way data flow (where you also push case updates back to Debitura), the API is the right path.

Where to send your developer

This Help Center article stays at the use-case level. Endpoint paths, request and response schemas, authentication setup, error handling, the test environment, and code examples live in Debitura's developer documentation, which is generated directly from the live API and stays in sync with it.

Developer Docs: Developers: start with the Collection Partners integration track for the architecture overview and end-to-end guides.

Developer Docs: Developers: see the Collection Partner API reference for endpoint details, schemas, and field definitions.

Getting an API key

API keys are provisioned per collection partner by Debitura. If you would like to start an integration, contact your Debitura account contact or email [email protected] and we will set you up.

Did this answer your question?